1corba_object(3)            Erlang Module Definition            corba_object(3)
2
3
4

NAME

6       corba_object - The CORBA Object interface functions
7

DESCRIPTION

9       This  module  contains the CORBA Object interface functions that can be
10       called for all objects.
11

EXPORTS

13       get_interface(Object) -> InterfaceDef
14
15              Types:
16
17                 Object = #objref
18                 InterfaceDef = term()
19
20              This function returns the full interface description for an  ob‐
21              ject.
22
23       is_nil(Object) -> boolean()
24
25              Types:
26
27                 Object = #objref
28
29              This  function  checks  if the object reference has a nil object
30              value, which denotes no object. It  is  the  reference  that  is
31              tested and no object implementation is involved in the test.
32
33       is_a(Object, Logical_type_id) -> Return
34       is_a(Object, Logical_type_id, Contexts) -> Return
35
36              Types:
37
38                 Object = #objref
39                 Logical_type_id = string()
40                 Contexts = [Context]
41                 Context  =  #'IOP_ServiceContext'{context_id  =  CtxId,  con‐
42                 text_data = CtxData}
43                 CtxId = ?ORBER_GENERIC_CTX_ID
44                 CtxData = {interface, Interface} | {userspecific,  term()}  |
45                 {configuration, Options}
46                 Interface = string()
47                 Options = [{Key, Value}]
48                 Key = ssl_client_options
49                 Value = allowed value associated with the given key
50                 Return = boolean() | {'EXCEPTION', E}
51
52              The  Logical_type_id is a string that is a share type identifier
53              (repository id). The function returns true if the object  is  an
54              instance  of that type or an ancestor of the "most derived" type
55              of that object.
56
57              The configuration context is used to  override  the  global  SSL
58              client side configuration.
59
60              Note:  Other  ORB  suppliers  may not support this function com‐
61              pletely according to the OMG specification. Thus,  a  is_a  call
62              may raise an exception or respond unpredictable if the Object is
63              located on a remote node.
64
65       is_remote(Object) -> boolean()
66
67              Types:
68
69                 Object = #objref
70
71              This function returns true if an object reference is remote oth‐
72              erwise false.
73
74       non_existent(Object) -> Return
75       non_existent(Object, Contexts) -> Return
76
77              Types:
78
79                 Object = #objref
80                 Contexts = [Context]
81                 Context  =  #'IOP_ServiceContext'{context_id  =  CtxId,  con‐
82                 text_data = CtxData}
83                 CtxId = ?ORBER_GENERIC_CTX_ID
84                 CtxData = {interface, Interface} | {userspecific,  term()}  |
85                 {configuration, Options}
86                 Interface = string()
87                 Options = [{Key, Value}]
88                 Key = ssl_client_options
89                 Value = allowed value associated with the given key
90                 Return = boolean() | {'EXCEPTION', E}
91
92              This  function  can  be  used to test if the object has been de‐
93              stroyed. It does this without  invoking  any  application  level
94              code.  The  ORB  returns true if it knows that the object is de‐
95              stroyed otherwise false.
96
97              The configuration context is used to  override  the  global  SSL
98              client side configuration.
99
100              Note: The OMG have specified two different operators, _not_exis‐
101              tent (CORBA version 2.0 and 2.2) and _non_existent  (CORBA  ver‐
102              sion  2.3), to be used for this function. It is not mandatory to
103              support both versions. Thus, a non_existent call  may  raise  an
104              exception or respond unpredictable if the Object is located on a
105              remote node. Depending on which version,  ORB:s  you  intend  to
106              communicate  with  supports, you can either use this function or
107              not_existent/1.
108
109       not_existent(Object) -> Return
110       not_existent(Object, Contexts) -> Return
111
112              Types:
113
114                 Object = #objref
115                 Contexts = [Context]
116                 Context  =  #'IOP_ServiceContext'{context_id  =  CtxId,  con‐
117                 text_data = CtxData}
118                 CtxId = ?ORBER_GENERIC_CTX_ID
119                 CtxData  =  {interface, Interface} | {userspecific, term()} |
120                 {configuration, Options}
121                 Interface = string()
122                 Options = [{Key, Value}]
123                 Key = ssl_client_options
124                 Value = allowed value associated with the given key
125                 Return = boolean() | {'EXCEPTION', E}
126
127              This function is implemented due to Interoperable purposes.  Be‐
128              haves  as non_existent except the operator _not_existent is used
129              when communicating with other ORB:s.
130
131              The configuration context is used to  override  the  global  SSL
132              client side configuration.
133
134       is_equivalent(Object, OtherObject) -> boolean()
135
136              Types:
137
138                 Object = #objref
139                 OtherObject = #objref
140
141              This  function is used to determine if two object references are
142              equivalent so far the ORB easily can determine. It returns  true
143              if the target object reference is equal to the other object ref‐
144              erence and false otherwise.
145
146       hash(Object, Maximum) -> int()
147
148              Types:
149
150                 Object = #objref
151                 Maximum = int()
152
153              This function returns a hash value based on the object reference
154              that not will change during the lifetime of the object. The Max‐
155              imum parameter denotes the upper bound of the value.
156
157
158
159Ericsson AB                       orber 5.0.1                  corba_object(3)