File: CosNotifyFilter_FilterAdmin.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 (98 lines) | stat: -rw-r--r-- 2,074 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
91
92
93
94
95
96
97
98
.TH CosNotifyFilter_FilterAdmin 3 "cosNotification  1.1.7" "Ericsson AB" "ERLANG MODULE DEFINITION"
.SH MODULE
CosNotifyFilter_FilterAdmin \- This module implements the OMG CosNotifyFilter::FilterAdmin interface\&.
.SH DESCRIPTION
.LP
To get access to the record definitions for the structures use: 
.br
\fI-include_lib("cosNotification/include/*\&.hrl")\&.\fR
.LP
All objects, which inherit this interface, export functions described in this module\&.

.SH EXPORTS
.LP
.B
add_filter(Object, Filter) -> FilterID
.br
.RS
.TP
Types
Object = #objref
.br
Filter = #objref
.br
FilterID = long()
.br
.RE
.RS
.LP
This operation connects a new \fIFilter\fR to the target object\&. This \fIFilter\fR will, together with other associated \fIFilters\fR, be used to select events to forward\&. A unique Id is returned and should be used if we no longer want to consult the given \fIFilter\fR\&.
.RE
.LP
.B
remove_filter(Object, FilterID) -> ok
.br
.RS
.TP
Types
Object = #objref
.br
FilterID = long()
.br
.RE
.RS
.LP
If a certain \fIFilter\fR no longer should be associated with the target object this operation must be used\&. Events will no longer be tested against the \fIFilter\fR associated with the given Id\&.
.RE
.LP
.B
get_filter(Object, FilterID) -> Reply
.br
.RS
.TP
Types
Object = #objref
.br
FilterID = long()
.br
Reply = Filter | {\&'EXCEPTION\&', #\&'CosNotifyFilter_FilterNotFound\&'{}}
.br
Filter = #objref
.br
.RE
.RS
.LP
If the target object is associated with a \fIFilter\fR matching the given Id the reference will be returned\&. If no such \fIFilter\fR is known by the target object an exception is raised\&.
.RE
.LP
.B
get_all_filters(Object) -> FilterIDSeq
.br
.RS
.TP
Types
Object = #objref
.br
FilterIDSeq = [FilterID]
.br
FilterID = long()
.br
.RE
.RS
.LP
Id\&'s for all \fIFilter\fR objects associated with the target object is returned by this operation\&.
.RE
.LP
.B
remove_all_filters(Object) -> ok
.br
.RS
.TP
Types
Object = #objref
.br
.RE
.RS
.LP
If we want to remove all \fIFilters\fR associated with the target object we can use this function\&.
.RE