← Back to branch summary

~rdoering/ubuntu/karmic/erlang/fix-535090

« back to all changes in this revision

Viewing changes to lib/cosNotification/doc/src/CosNotifyChannelAdmin_SequenceProxyPullSupplier.xml

  • Committer: Bazaar Package Importer
  • Author(s): Sergei Golovan
  • Date: 2009-02-15 16:42:52 UTC
  • mfrom: (1.1.13 upstream)
  • mto: (3.3.1 squeeze)
  • mto: This revision was merged to the branch mainline in revision 17.
  • Revision ID: james.westby@ubuntu.com-20090215164252-dxpjjuq108nz4noa
Upload to unstable after lenny is released.

Show diffs side-by-side

added added

removed removed

Lines of Context:
lib/cosNotification/doc/src/CosNotifyChannelAdmin_SequenceProxyPullSupplier.xml
 
1
<?xml version="1.0" encoding="latin1" ?>
 
2
<!DOCTYPE erlref SYSTEM "erlref.dtd">
 
3
 
 
4
<erlref>
 
5
  <header>
 
6
    <copyright>
 
7
      <year>2000</year>
 
8
      <year>2007</year>
 
9
      <holder>Ericsson AB, All Rights Reserved</holder>
 
10
    </copyright>
 
11
    <legalnotice>
 
12
  The contents of this file are subject to the Erlang Public License,
 
13
  Version 1.1, (the "License"); you may not use this file except in
 
14
  compliance with the License. You should have received a copy of the
 
15
  Erlang Public License along with this software. If not, it can be
 
16
  retrieved online at http://www.erlang.org/.
 
17
 
 
18
  Software distributed under the License is distributed on an "AS IS"
 
19
  basis, WITHOUT WARRANTY OF ANY KIND, either express or implied. See
 
20
  the License for the specific language governing rights and limitations
 
21
  under the License.
 
22
 
 
23
  The Initial Developer of the Original Code is Ericsson AB.
 
24
    </legalnotice>
 
25
 
 
26
    <title>CosNotifyChannelAdmin_&shy;SequenceProxyPullSupplier</title>
 
27
    <shorttitle>..._SequenceProxyPullSupplier</shorttitle>
 
28
    <prepared>Niclas Eklund</prepared>
 
29
    <responsible>Niclas Eklund</responsible>
 
30
    <docno></docno>
 
31
    <approved>Niclas Eklund</approved>
 
32
    <checked></checked>
 
33
    <date>2000-02-01</date>
 
34
    <rev>1.0</rev>
 
35
  </header>
 
36
  <module>CosNotifyChannelAdmin_SequenceProxyPullSupplier</module>
 
37
  <modulesummary>This module implements the OMG  CosNotifyChannelAdmin::SequenceProxyPullSupplier interface.</modulesummary>
 
38
  <description>
 
39
    <p>To get access to the record definitions for the structures use:      <br></br>
 
40
<c>-include_lib("cosNotification/include/*.hrl").</c></p>
 
41
    <p>This module also exports the functions described in:</p>
 
42
    <list type="bulleted">
 
43
      <item>
 
44
        <p><seealso marker="CosNotifyComm_NotifySubscribe">CosNotifyComm_NotifySubscribe</seealso></p>
 
45
      </item>
 
46
      <item>
 
47
        <p><seealso marker="CosNotification_QoSAdmin">CosNotification_QoSAdmin</seealso></p>
 
48
      </item>
 
49
      <item>
 
50
        <p><seealso marker="CosNotifyFilter_FilterAdmin">CosNotifyFilter_FilterAdmin</seealso></p>
 
51
      </item>
 
52
      <item>
 
53
        <p><seealso marker="CosNotifyChannelAdmin_ProxySupplier">CosNotifyChannelAdmin_ProxySupplier</seealso></p>
 
54
      </item>
 
55
    </list>
 
56
  </description>
 
57
  <funcs>
 
58
    <func>
 
59
      <name>connect_sequence_pull_consumer(SequenceProxyPullSupplier, PullConsumer) -> Reply</name>
 
60
      <fsummary>Connect a consumer to the proxy</fsummary>
 
61
      <type>
 
62
        <v>SequenceProxyPullSupplier = #objref</v>
 
63
        <v>PullConsumer = #objref</v>
 
64
        <v>Reply = ok | {'EXCEPTION', #'CosEventChannelAdmin_AlreadyConnected'{}}</v>
 
65
      </type>
 
66
      <desc>
 
67
        <p>This operation connects a <c>PullConsumer</c> to the target object. If a connection
 
68
          already exists an exception is raised.</p>
 
69
      </desc>
 
70
    </func>
 
71
    <func>
 
72
      <name>pull_structured_events(SequenceProxyPullSupplier, MaxEvents) -> Reply</name>
 
73
      <fsummary>Pull structured events from the proxy</fsummary>
 
74
      <type>
 
75
        <v>SequenceProxyPullSupplier = #objref</v>
 
76
        <v>MaxEvents = long()</v>
 
77
        <v>Reply = EventBatch | {'EXCEPTION', #'CosEventChannelAdmin_Disconnected'{}}</v>
 
78
        <v>EventBatch = [StructuredEvent]</v>
 
79
        <v>StructuredEvent = #'CosNotification_StructuredEvent'{header, filterable_data, remainder_of_body}</v>
 
80
        <v>header = EventHeader</v>
 
81
        <v>filterable_data = [#'CosNotification_Property'{name, value}]</v>
 
82
        <v>name = string()</v>
 
83
        <v>value = #any</v>
 
84
        <v>remainder_of_body = #any</v>
 
85
        <v>EventHeader = #'CosNotification_EventHeader'{fixed_header, variable_header}</v>
 
86
        <v>fixed_header = FixedEventHeader</v>
 
87
        <v>variable_header = OptionalHeaderFields</v>
 
88
        <v>FixedEventHeader = #'CosNotification_FixedEventHeader'{event_type, event_name}</v>
 
89
        <v>event_type = EventType</v>
 
90
        <v>event_name = string()</v>
 
91
        <v>EventType = #'CosNotification_EventType'{domain_name, type_name}</v>
 
92
        <v>domain_name = type_name = string()</v>
 
93
        <v>OptionalHeaderFields = [#'CosNotification_Property'{name, value}]</v>
 
94
      </type>
 
95
      <desc>
 
96
        <p>A client use this operation to pull next event sequence of maximum length 
 
97
          <c>MaxEvents</c>. This operation is blocking and will not reply until the
 
98
          requested amount of events can be delivered or the QoS property <c>PacingInterval</c>
 
99
          is reached. For more information see the <c>User's Guide</c>.</p>
 
100
      </desc>
 
101
    </func>
 
102
    <func>
 
103
      <name>try_pull_structured_events(SequenceProxyPullSupplier, MaxEvents) -> Reply</name>
 
104
      <fsummary>Try to pull structured events from the proxy</fsummary>
 
105
      <type>
 
106
        <v>SequenceProxyPullSupplier = #objref</v>
 
107
        <v>MaxEvents = long()</v>
 
108
        <v>Reply = {EventBatch, HasEvent} | {'EXCEPTION', #'CosEventChannelAdmin_Disconnected'{}}</v>
 
109
        <v>HasEvent = boolean()</v>
 
110
        <v>EventBatch = [StructuredEvent]</v>
 
111
        <v>StructuredEvent = #'CosNotification_StructuredEvent'{header, filterable_data, remainder_of_body}</v>
 
112
        <v>header = EventHeader</v>
 
113
        <v>filterable_data = [#'CosNotification_Property'{name, value}]</v>
 
114
        <v>name = string()</v>
 
115
        <v>value = #any</v>
 
116
        <v>remainder_of_body = #any</v>
 
117
        <v>EventHeader = #'CosNotification_EventHeader'{fixed_header, variable_header}</v>
 
118
        <v>fixed_header = FixedEventHeader</v>
 
119
        <v>variable_header = OptionalHeaderFields</v>
 
120
        <v>FixedEventHeader = #'CosNotification_FixedEventHeader'{event_type, event_name}</v>
 
121
        <v>event_type = EventType</v>
 
122
        <v>event_name = string()</v>
 
123
        <v>EventType = #'CosNotification_EventType'{domain_name, type_name}</v>
 
124
        <v>domain_name = type_name = string()</v>
 
125
        <v>OptionalHeaderFields = [#'CosNotification_Property'{name, value}]</v>
 
126
      </type>
 
127
      <desc>
 
128
        <p>This operation pulls an event sequence of the maximum length <c>MaxEvents</c>, 
 
129
          but do not block if the target object have no events to forward. The outparameter,
 
130
          <c>HasEvent</c> is true if the sequence contain any events.</p>
 
131
      </desc>
 
132
    </func>
 
133
    <func>
 
134
      <name>disconnect_sequence_pull_supplier(SequenceProxyPullSupplier) -> ok</name>
 
135
      <fsummary>Close the connection and terminate the proxy</fsummary>
 
136
      <type>
 
137
        <v>SequenceProxyPullSupplier = #objref</v>
 
138
      </type>
 
139
      <desc>
 
140
        <p>This operation cause the target object to close the connection and terminate.</p>
 
141
      </desc>
 
142
    </func>
 
143
  </funcs>
 
144
  
 
145
</erlref>
 
146