File: CosNotifyChannelAdmin_StructuredProxyPullConsumer.3

package info (click to toggle)
erlang-manpages 1%3A12.b.3-1
  • links: PTS
  • area: main
  • in suites: lenny
  • size: 4,188 kB
  • ctags: 2
  • sloc: makefile: 68; perl: 30; sh: 15
file content (90 lines) | stat: -rw-r--r-- 2,429 bytes parent folder | download
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
.TH CosNotifyChannelAdmin_StructuredProxyPullConsumer 3 "cosNotification  1.1.7" "Ericsson AB" "ERLANG MODULE DEFINITION"
.SH MODULE
CosNotifyChannelAdmin_StructuredProxyPullConsumer \- This module implements the OMG CosNotifyChannelAdmin::StructuredProxyPullConsumer interface\&.
.SH DESCRIPTION
.LP
To get access to the record definitions for the structures use: 
.br
\fI-include_lib("cosNotification/include/*\&.hrl")\&.\fR
.LP
This module also exports the functions described in:
.RS 2
.TP 2
*
CosNotifyComm_NotifyPublish
.TP 2
*
CosNotification_QoSAdmin
.TP 2
*
CosNotifyFilter_FilterAdmin
.TP 2
*
CosNotifyChannelAdmin_ProxyConsumer
.RE

.SH EXPORTS
.LP
.B
connect_structured_pull_supplier(StructuredProxyPullConsumer, PullSupplier) -> Reply
.br
.RS
.TP
Types
StructuredProxyPullConsumer = #objref
.br
PullSupplier = #objref
.br
Reply = ok | {\&'EXCEPTION\&', #\&'CosEventChannelAdmin_AlreadyConnected\&'{}} | {\&'EXCEPTION\&', #\&'CosEventChannelAdmin_TypeError\&'{}}
.br
.RE
.RS
.LP
This operation connects a \fIPullSupplier\fR to the target object\&. If a connection already exists or the given client object does not support the functions \fIpull_structured_event\fR and \fItry_pull_structured_event\fR an exception is raised\&.
.RE
.LP
.B
suspend_connection(StructuredProxyPullConsumer) -> Reply
.br
.RS
.TP
Types
StructuredProxyPullConsumer = #objref
.br
Reply = ok | {\&'EXCEPTION\&', #\&'CosNotifyChannelAdmin_ConnectionAlreadyInactive\&'{}} | {\&'EXCEPTION\&', #\&'CosNotifyChannelAdmin_NotConnected\&'{}}
.br
.RE
.RS
.LP
This operation suspends the connection between the target object and its client\&. If no connection exists or already suspended an exception is raised\&.
.RE
.LP
.B
resume_connection(StructuredProxyPullConsumer) -> Reply
.br
.RS
.TP
Types
StructuredProxyPullConsumer = #objref
.br
Reply = ok | {\&'EXCEPTION\&', #\&'CosNotifyChannelAdmin_ConnectionAlreadyInactive\&'{}} | {\&'EXCEPTION\&', #\&'CosNotifyChannelAdmin_NotConnected\&'{}}
.br
.RE
.RS
.LP
If the connection have been suspended this operation must be used if we want to resume the connection\&. If the connection already are active or no connection have been created an exception is raised\&.
.RE
.LP
.B
disconnect_structured_pull_consumer(StructuredProxyPullConsumer) -> ok
.br
.RS
.TP
Types
StructuredProxyPullConsumer = #objref
.br
.RE
.RS
.LP
This operation cause the target object to close the connection and terminate\&.
.RE