← Back to branch summary

~ubuntu-branches/ubuntu/karmic/erlang/karmic-security

« back to all changes in this revision

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

  • Committer: Bazaar Package Importer
  • Author(s): Sergei Golovan
  • Date: 2009-02-15 16:42:52 UTC
  • mfrom: (3.1.2 squeeze)
  • Revision ID: james.westby@ubuntu.com-20090215164252-q5x4rcf8a5pbesb1
Tags: 1:12.b.5-dfsg-2
Upload to unstable after lenny is released.

Show diffs side-by-side

added added

removed removed

Lines of Context:
lib/cosNotification/doc/src/CosNotifyChannelAdmin_ProxySupplier.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;ProxySupplier</title>
 
27
    <shorttitle>..._ProxySupplier</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_ProxySupplier</module>
 
37
  <modulesummary>This module implements the OMG  CosNotifyChannelAdmin::ProxySupplier 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="CosNotification_QoSAdmin">CosNotification_QoSAdmin</seealso></p>
 
45
      </item>
 
46
      <item>
 
47
        <p><seealso marker="CosNotifyFilter_FilterAdmin">CosNotifyFilter_FilterAdmin</seealso></p>
 
48
      </item>
 
49
    </list>
 
50
  </description>
 
51
  <funcs>
 
52
    <func>
 
53
      <name>_get_MyType(ProxySupplier) -> ProxyType</name>
 
54
      <fsummary>Return the proxy type</fsummary>
 
55
      <type>
 
56
        <v>ProxySupplier = #objref</v>
 
57
        <v>ProxyType = 'PUSH_ANY' | 'PULL_ANY' | 'PUSH_STRUCTURED' |  'PULL_STRUCTURED' | 'PUSH_SEQUENCE' | 'PULL_SEQUENCE'</v>
 
58
      </type>
 
59
      <desc>
 
60
        <p>This readonly attribute maintains the enumerant describing the which type the target object 
 
61
          is.</p>
 
62
      </desc>
 
63
    </func>
 
64
    <func>
 
65
      <name>_get_MyAdmin(ProxySupplier) -> AdminObject</name>
 
66
      <fsummary>Return the target object's associated <c>Admin</c>object</fsummary>
 
67
      <type>
 
68
        <v>ProxySupplier = #objref</v>
 
69
        <v>AdminObject = #objref</v>
 
70
      </type>
 
71
      <desc>
 
72
        <p>This readonly attribute maintains the admin's reference which created the target object.</p>
 
73
      </desc>
 
74
    </func>
 
75
    <func>
 
76
      <name>_get_priority_filter(ProxySupplier) -> MappingFilter</name>
 
77
      <fsummary>Return the target object's associated priority <c>MappingFilter</c></fsummary>
 
78
      <type>
 
79
        <v>ProxySupplier = #objref</v>
 
80
        <v>MappingFilter = #objref</v>
 
81
      </type>
 
82
      <desc>
 
83
        <p>This operation returns the associated priority MappingFilter. 
 
84
          If no such object exist a <c>NIL</c> reference is returned.</p>
 
85
      </desc>
 
86
    </func>
 
87
    <func>
 
88
      <name>_set_priority_filter(ProxySupplier, MappingFilter) -> ok</name>
 
89
      <fsummary>Set the target object's associated priority <c>MappingFilter</c></fsummary>
 
90
      <type>
 
91
        <v>ProxySupplier = #objref</v>
 
92
        <v>MappingFilter = #objref</v>
 
93
      </type>
 
94
      <desc>
 
95
        <p>This operation associate a new priority MappingFilter with the target object.</p>
 
96
      </desc>
 
97
    </func>
 
98
    <func>
 
99
      <name>_get_lifetime_filter(ProxySupplier) -> MappingFilter</name>
 
100
      <fsummary>Return the target object's associated lifetime <c>MappingFilter</c></fsummary>
 
101
      <type>
 
102
        <v>ProxySupplier = #objref</v>
 
103
        <v>MappingFilter = #objref</v>
 
104
      </type>
 
105
      <desc>
 
106
        <p>This operation returns the associated lifetime MappingFilter. 
 
107
          If no such object exist a <c>NIL</c> reference is returned.</p>
 
108
      </desc>
 
109
    </func>
 
110
    <func>
 
111
      <name>_set_lifetime_filter(ProxySupplier, MappingFilter) -> ok</name>
 
112
      <fsummary>Set the target object's associated lifetime <c>MappingFilter</c></fsummary>
 
113
      <type>
 
114
        <v>ProxySupplier = #objref</v>
 
115
        <v>MappingFilter = #objref</v>
 
116
      </type>
 
117
      <desc>
 
118
        <p>This operation associate a new lifetime MappingFilter with the target object.</p>
 
119
      </desc>
 
120
    </func>
 
121
    <func>
 
122
      <name>obtain_offered_types(ProxySupplier, ObtainInfoMode) -> EventTypeSeq</name>
 
123
      <fsummary>Administer the type of events the proxy supplies</fsummary>
 
124
      <type>
 
125
        <v>ProxySupplier = #objref</v>
 
126
        <v>ObtainInfoMode = 'ALL_NOW_UPDATES_OFF' | 'ALL_NOW_UPDATES_ON' |  'NONE_NOW_UPDATES_OFF' | 'NONE_NOW_UPDATES_ON'</v>
 
127
        <v>EventTypeSeq = [EventType]</v>
 
128
        <v>EventType = #'CosNotification_EventType'{domain_name, type_name}</v>
 
129
        <v>domain_name = type_name = string()</v>
 
130
      </type>
 
131
      <desc>
 
132
        <p>Depending on the input parameter <c>ObtainInfoMode</c>, this operation may return a 
 
133
          sequence of the <c>EventTypes</c> the target object is interested in receiving.
 
134
          If <c>'ALL_NOW_UPDATES_OFF'</c> or <c>'ALL_NOW_UPDATES_ON'</c> is given a sequence will
 
135
          be returned, otherwise not. If <c>'ALL_NOW_UPDATES_OFF'</c> or <c>'NONE_NOW_UPDATES_OFF'</c>
 
136
          are issued the target object will not inform the associated <c>NotifySubscribe</c> object
 
137
          when an update occurs. <c>'ALL_NOW_UPDATES_ON'</c> or <c>'NONE_NOW_UPDATES_ON'</c> will 
 
138
          result in that update information will be sent.</p>
 
139
      </desc>
 
140
    </func>
 
141
    <func>
 
142
      <name>validate_event_qos(ProxySupplier, QoSProperties) -> Reply</name>
 
143
      <fsummary>Check if the QoS properties can be set</fsummary>
 
144
      <type>
 
145
        <v>ProxySupplier = #objref</v>
 
146
        <v>QoSProperties = [QoSProperty]</v>
 
147
        <v>QoSProperty = #'CosNotification_Property'{name, value}</v>
 
148
        <v>name = string()</v>
 
149
        <v>value = #any</v>
 
150
        <v>Reply = {ok, NamedPropertyRangeSeq} | {'EXCEPTION', CosNotification_UnsupportedQoS{qos_err}}</v>
 
151
        <v>NamedPropertyRangeSeq = [NamedPropertyRange]</v>
 
152
        <v>NamedPropertyRange = #CosNotification_NamedPropertyRange{name, range}</v>
 
153
        <v>name = string()</v>
 
154
        <v>range = #CosNotification_PropertyRange{low_val, high_val}</v>
 
155
        <v>low_val = #any</v>
 
156
        <v>high_val = #any</v>
 
157
        <v>qos_err = PropertyErrorSeq</v>
 
158
        <v>PropertyErrorSeq = [PropertyError]</v>
 
159
        <v>PropertyError = #'CosNotification_PropertyError'{code, name, available_range}</v>
 
160
        <v>code = 'UNSUPPORTED_PROPERTY' | 'UNAVAILABLE_PROPERTY' | 'UNSUPPORTED_VALUE' |  'UNAVAILABLE_VALUE' | 'BAD_PROPERTY' | 'BAD_TYPE' | 'BAD_VALUE'</v>
 
161
        <v>name = string()</v>
 
162
        <v>available_range = PropertyRange</v>
 
163
        <v>PropertyRange = #CosNotification_PropertyRange{low_val, high_val}</v>
 
164
        <v>low_val = high_val = #any</v>
 
165
      </type>
 
166
      <desc>
 
167
        <p>To check if certain Quality of Service properties can be added to events in
 
168
          the current context of the target object this operation should be used. If we
 
169
          cannot support the required settings an exception describing why will be raised.</p>
 
170
      </desc>
 
171
    </func>
 
172
  </funcs>
 
173
  
 
174
</erlref>
 
175