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
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
|
.TH corba_object 3 "orber 3.6.9" "Ericsson AB" "ERLANG MODULE DEFINITION"
.SH MODULE
corba_object \- The CORBA Object interface functions
.SH DESCRIPTION
.LP
This module contains the CORBA Object interface functions that can be called for all objects\&.
.SH EXPORTS
.LP
.B
get_interface(Object) -> InterfaceDef
.br
.RS
.TP
Types
Object = #objref
.br
InterfaceDef = term()
.br
.RE
.RS
.LP
This function returns the full interface description for an object\&.
.RE
.LP
.B
is_nil(Object) -> boolean()
.br
.RS
.TP
Types
Object = #objref
.br
.RE
.RS
.LP
This function checks if the object reference has a nil object value, which denotes no object\&. It is the reference that is tested and no object implementation is involved in the test\&.
.RE
.LP
.B
is_a(Object, Logical_type_id) -> Return
.br
.B
is_a(Object, Logical_type_id, Contexts) -> Return
.br
.RS
.TP
Types
Object = #objref
.br
Logical_type_id = string()
.br
Contexts = [Context]
.br
Context = #\&'IOP_ServiceContext\&'{context_id = CtxId, context_data = CtxData}
.br
CtxId = ?ORBER_GENERIC_CTX_ID
.br
CtxData = {interface, Interface} | {userspecific, term()} | {configuration, Options}
.br
Interface = string()
.br
Options = [{Key, Value}]
.br
Key = ssl_client_verify | ssl_client_depth | ssl_client_certfile | ssl_client_cacertfile | ssl_client_password | ssl_client_keyfile | ssl_client_ciphers | ssl_client_cachetimeout
.br
Value = allowed value associated with the given key
.br
Return = boolean() | {\&'EXCEPTION\&', E}
.br
.RE
.RS
.LP
The \fILogical_type_id\fR is a string that is a share type identifier (repository id)\&. The function returns true if the object is an instance of that type or an ancestor of the "most derived" type of that object\&.
.LP
The \fIconfiguration\fR context is used to override the global SSL client side configuration\&.
.LP
Note: Other ORB suppliers may not support this function completely according to the OMG specification\&. Thus, a \fIis_a\fR call may raise an exception or respond unpredictable if the Object is located on a remote node\&.
.RE
.LP
.B
is_remote(Object) -> boolean()
.br
.RS
.TP
Types
Object = #objref
.br
.RE
.RS
.LP
This function returns true if an object reference is remote otherwise false\&.
.RE
.LP
.B
non_existent(Object) -> Return
.br
.B
non_existent(Object, Contexts) -> Return
.br
.RS
.TP
Types
Object = #objref
.br
Contexts = [Context]
.br
Context = #\&'IOP_ServiceContext\&'{context_id = CtxId, context_data = CtxData}
.br
CtxId = ?ORBER_GENERIC_CTX_ID
.br
CtxData = {interface, Interface} | {userspecific, term()} | {configuration, Options}
.br
Interface = string()
.br
Options = [{Key, Value}]
.br
Key = ssl_client_verify | ssl_client_depth | ssl_client_certfile | ssl_client_cacertfile | ssl_client_password | ssl_client_keyfile | ssl_client_ciphers | ssl_client_cachetimeout
.br
Value = allowed value associated with the given key
.br
Return = boolean() | {\&'EXCEPTION\&', E}
.br
.RE
.RS
.LP
This function can be used to test if the object has been destroyed\&. It does this without invoking any application level code\&. The ORB returns true if it knows that the object is destroyed otherwise false\&.
.LP
The \fIconfiguration\fR context is used to override the global SSL client side configuration\&.
.LP
Note: The OMG have specified two different operators, \fI_not_existent\fR (CORBA version 2\&.0 and 2\&.2) and \fI_non_existent\fR (CORBA version 2\&.3), to be used for this function\&. It is not mandatory to support both versions\&. Thus, a \fInon_existent\fR call may raise an exception or respond unpredictable if the Object is located on a remote node\&. Depending on which version, ORB:s you intend to communicate with supports, you can either use this function or \fInot_existent/1\fR\&.
.RE
.LP
.B
not_existent(Object) -> Return
.br
.B
not_existent(Object, Contexts) -> Return
.br
.RS
.TP
Types
Object = #objref
.br
Contexts = [Context]
.br
Context = #\&'IOP_ServiceContext\&'{context_id = CtxId, context_data = CtxData}
.br
CtxId = ?ORBER_GENERIC_CTX_ID
.br
CtxData = {interface, Interface} | {userspecific, term()} | {configuration, Options}
.br
Interface = string()
.br
Options = [{Key, Value}]
.br
Key = ssl_client_verify | ssl_client_depth | ssl_client_certfile | ssl_client_cacertfile | ssl_client_password | ssl_client_keyfile | ssl_client_ciphers | ssl_client_cachetimeout
.br
Value = allowed value associated with the given key
.br
Return = boolean() | {\&'EXCEPTION\&', E}
.br
.RE
.RS
.LP
This function is implemented due to Interoperable purposes\&. Behaves as \fInon_existent\fR except the operator \fI_not_existent\fR is used when communicating with other ORB:s\&.
.LP
The \fIconfiguration\fR context is used to override the global SSL client side configuration\&.
.RE
.LP
.B
is_equivalent(Object, OtherObject) -> boolean()
.br
.RS
.TP
Types
Object = #objref
.br
OtherObject = #objref
.br
.RE
.RS
.LP
This function is used to determine if two object references are equivalent so far the ORB easily can determine\&. It returns \fItrue\fR if the target object reference is equal to the other object reference and \fIfalse\fR otherwise\&.
.RE
.LP
.B
hash(Object, Maximum) -> int()
.br
.RS
.TP
Types
Object = #objref
.br
Maximum = int()
.br
.RE
.RS
.LP
This function returns a hash value based on the object reference that not will change during the lifetime of the object\&. The \fIMaximum\fR parameter denotes the upper bound of the value\&.
.RE
|
