File: CosNotifyChannelAdmin_ProxyPushConsumer.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 (76 lines) | stat: -rw-r--r-- 1,600 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
.TH CosNotifyChannelAdmin_ProxyPushConsumer 3 "cosNotification  1.1.7" "Ericsson AB" "ERLANG MODULE DEFINITION"
.SH MODULE
CosNotifyChannelAdmin_ProxyPushConsumer \- This module implements the OMG CosNotifyChannelAdmin::ProxyPushConsumer 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_any_push_supplier(ProxyPushConsumer, PushSupplier) -> Reply
.br
.RS
.TP
Types
ProxyPushConsumer = #objref
.br
PushSupplier = #objref
.br
Reply = ok | {\&'EXCEPTION\&', #\&'CosEventChannelAdmin_AlreadyConnected\&'{}}
.br
.RE
.RS
.LP
This operation connects a \fIPushSupplier\fR to the target object\&. If a connection already exists the \fIAlreadyConnected\fR exception is raised\&.
.RE
.LP
.B
push(ProxyPushConsumer, Event) -> Reply
.br
.RS
.TP
Types
ProxyPushConsumer = #objref
.br
Event = #any
.br
Reply = ok | {\&'EXCEPTION\&', #\&'CosEventChannelAdmin_Disconnected\&'{}}
.br
.RE
.RS
.LP
This operation pushes an \fI#any{}\fR event to the target object\&. If no client have been connected the \fIDisconnected\fR exception is raised\&.
.RE
.LP
.B
disconnect_push_consumer(ProxyPushConsumer) -> ok
.br
.RS
.TP
Types
ProxyPushConsumer = #objref
.br
.RE
.RS
.LP
Invoking this operation will cause the target object to close the connection and terminate\&.
.RE