1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
|
<?xml version="1.0" encoding="utf-8" ?>
<!DOCTYPE erlref SYSTEM "erlref.dtd">
<erlref>
<header>
<copyright>
<year>2000</year>
<year>2013</year>
<holder>Ericsson AB, All Rights Reserved</holder>
</copyright>
<legalnotice>
The contents of this file are subject to the Erlang Public License,
Version 1.1, (the "License"); you may not use this file except in
compliance with the License. You should have received a copy of the
Erlang Public License along with this software. If not, it can be
retrieved online at http://www.erlang.org/.
Software distributed under the License is distributed on an "AS IS"
basis, WITHOUT WARRANTY OF ANY KIND, either express or implied. See
the License for the specific language governing rights and limitations
under the License.
The Initial Developer of the Original Code is Ericsson AB.
</legalnotice>
<title>CosNotifyChannelAdmin_StructuredProxyPushSupplier</title>
<prepared></prepared>
<responsible></responsible>
<docno></docno>
<approved></approved>
<checked></checked>
<date>2000-02-01</date>
<rev>1.0</rev>
</header>
<module>CosNotifyChannelAdmin_StructuredProxyPushSupplier</module>
<modulesummary>This module implements the OMG CosNotifyChannelAdmin::StructuredProxyPushSupplier interface.</modulesummary>
<description>
<p>To get access to the record definitions for the structures use: <br></br>
<c>-include_lib("cosNotification/include/*.hrl").</c></p>
<p>This module also exports the functions described in:</p>
<list type="bulleted">
<item>
<p><seealso marker="CosNotifyComm_NotifySubscribe">CosNotifyComm_NotifySubscribe</seealso></p>
</item>
<item>
<p><seealso marker="CosNotification_QoSAdmin">CosNotification_QoSAdmin</seealso></p>
</item>
<item>
<p><seealso marker="CosNotifyFilter_FilterAdmin">CosNotifyFilter_FilterAdmin</seealso></p>
</item>
<item>
<p><seealso marker="CosNotifyChannelAdmin_ProxySupplier">CosNotifyChannelAdmin_ProxySupplier</seealso></p>
</item>
</list>
</description>
<funcs>
<func>
<name>connect_structured_push_consumer(StructuredProxyPushSupplier, PushConsumer) -> Reply</name>
<fsummary>Connect a consumer to the proxy</fsummary>
<type>
<v>StructuredProxyPushSupplier = #objref</v>
<v>PushConsumer = #objref</v>
<v>Reply = ok | {'EXCEPTION', #'CosEventChannelAdmin_AlreadyConnected'{}} | {'EXCEPTION', #'CosEventChannelAdmin_TypeError'{}}</v>
</type>
<desc>
<p>This operation connects a <c>PushConsumer</c> to the target object. If
a connection already exists or the function <c>push_structured_event</c>
is not supported by the client object an exception is raised.</p>
</desc>
</func>
<func>
<name>suspend_connection(StructuredProxyPushSupplier) -> Reply</name>
<fsummary>Suspend the connection with the target object</fsummary>
<type>
<v>StructuredProxyPushSupplier = #objref</v>
<v>Reply = ok | {'EXCEPTION', #'CosNotifyChannelAdmin_ConnectionAlreadyInactive'{}} | {'EXCEPTION', #'CosNotifyChannelAdmin_NotConnected'{}}</v>
</type>
<desc>
<p>This operation suspends the connection with the target object. If no connection
exists or the connection already is suspended an exception is raised.</p>
</desc>
</func>
<func>
<name>resume_connection(StructuredProxyPushSupplier) -> Reply</name>
<fsummary>Resume a previously suspended connection</fsummary>
<type>
<v>StructuredProxyPullConsumer = #objref</v>
<v>Reply = ok | {'EXCEPTION', #'CosNotifyChannelAdmin_ConnectionAlreadyInactive'{}} | {'EXCEPTION', #'CosNotifyChannelAdmin_NotConnected'{}}</v>
</type>
<desc>
<p>If the connection with the target object have been suspended this function
must be used to resume the connection. If no client have been connected or
the connection is active an exception is raised.</p>
</desc>
</func>
<func>
<name>disconnect_structured_push_supplier(StructuredProxyPushSupplier) -> ok</name>
<fsummary>Close the connection and terminate the target object</fsummary>
<type>
<v>StructuredProxyPushSupplier = #objref</v>
</type>
<desc>
<p>This operation cause the target object to close the connection and terminate.</p>
</desc>
</func>
</funcs>
</erlref>
|
