1CosNotification_QoSAdmin(3)Erlang Module DefinitionCosNotification_QoSAdmin(3)
2
3
4

NAME

6       CosNotification_QoSAdmin - This module implements the OMG  CosNotifica‐
7       tion::QoSAdmin interface.
8

DESCRIPTION

10       To get access to the record definitions for the structures use:
11       -include_lib("cosNotification/include/*.hrl").
12
13       All objects, which inherit this interface, export  functions  described
14       in this module.
15

EXPORTS

17       get_qos(Object) -> Reply
18
19              Types:
20
21                 Object = #objref
22                 Reply = [QoSProperty]
23                 QoSProperty = #'CosNotification_Property'{name, value}
24                 name = string()
25                 value = #any
26
27              This operation returns a list of name-value pairs which encapsu‐
28              lates the current QoS settings for the target object.
29
30       set_qos(Object, QoS) -> Reply
31
32              Types:
33
34                 Object = #objref
35                 QoS = [QoSProperty]
36                 QoSProperty = #'CosNotification_Property'{name, value}
37                 name = string()
38                 value = #any
39                 Reply  =  ok  |  {'EXCEPTION',   #'CosNotification_Unsupport‐
40                 edQoS'{qos_err}}
41                 qos_err = PropertyErrorSeq
42                 PropertyErrorSeq = [PropertyError]
43                 PropertyError  = #'CosNotification_PropertyError'{code, name,
44                 available_range}
45                 code = 'UNSUPPORTED_PROPERTY' | 'UNAVAILABLE_PROPERTY' | 'UN‐
46                 SUPPORTED_VALUE'  |  'UNAVAILABLE_VALUE'  |  'BAD_PROPERTY' |
47                 'BAD_TYPE' | 'BAD_VALUE'
48                 name = string()
49                 available_range = PropertyRange
50                 PropertyRange    =    #CosNotification_PropertyRange{low_val,
51                 high_val}
52                 low_val = high_val = #any
53
54              To  alter  the  current  QoS settings for the target object this
55              function must be used. If it is not  possible  to  set  the  re‐
56              quested  QoS  the  UnsupportedQoS exception is raised, which in‐
57              cludes a sequence of PropertyError's describing which QoS,  pos‐
58              sible range and why is not allowed.
59
60       validate_qos(Object, QoS) -> Reply
61
62              Types:
63
64                 Object = #objref
65                 QoS = [QoSProperty]
66                 QoSProperty = #'Property'{name, value}
67                 name = string()
68                 value = #any
69                 Reply  = {ok, NamedPropertyRangeSeq} | {'EXCEPTION', CosNoti‐
70                 fication_UnsupportedQoS{}}
71                 NamedPropertyRangeSeq = [NamedPropertyRange]
72                 NamedPropertyRange      =       #CosNotification_NamedProper‐
73                 tyRange{name, range}
74                 name = string()
75                 range = #CosNotification_PropertyRange{low_val, high_val}
76                 low_val = #any
77                 high_val = #any
78
79              The  purpose  of this operations is to check if a QoS setting is
80              supported by the target object and if so, the operation  returns
81              additional properties which could be optionally added as well.
82
83
84
85Ericsson AB                  cosNotification 5.0.1 CosNotification_QoSAdmin(3)