1Module_Interface(3) Erlang Module Definition Module_Interface(3)
2
6 Module_Interface - Orber generated stubs/skeletons.
7
9 This module contains the stub/skeleton functions generated by IC.
10 Starting a Orber server can be done in three ways:
12 * Normal - when the server dies Orber forgets all knowledge of the
14 server.
15 * Supervisor child - adding the configuration parameter {sup_child,
17 true} the oe_create_link/2 function returns {ok, Pid, ObjRef} which
18 can be handled by the application supervisor/stdlib-1.7 or later.
19 * Persistent object reference - adding the configuration parameters
21 {persistent, true} and {regname, {global, term()}} Orber will
22 remember the object reference until the server terminates with rea‐
23 son normal or shutdown. Hence, if the server is started as a tran‐
24 sient supervisor child we do not receive a 'OBJECT_NOT_EXIST'
25 exception when it has crashed and is being restarted.
26 The Orber stub can be used to start a pseudo object, which will create
28 a non-server implementation. A pseudo object introduce some limita‐
29 tions:
30 * The functions oe_create_link/2 is equal to oe_create/2, i.e., no
32 link can or will be created.
33 * The BIF:s self() and process_flag(trap_exit,true) behaves incor‐
35 rectly.
36 * The IC option {{impl, "M::I"}, "other_impl"} has no effect. The
38 call-back functions must be implemented in a file called
39 M_I_impl.erl
40 * The IC option from has no effect.
42 * The call-back functions must be implemented as if the IC option
44 {this, "M::I"} was used.
45 * Server State changes have no effect. The user can provide informa‐
47 tion via the Env start parameter and the State returned from init/2
48 will be the State passed in following invocations.
49 * If a call-back function replies with the Timeout parameter set it
51 have no effect.
52 * Operations defined as oneway are blocking until the operation
54 replies.
55 * The option {pseudo, true} overrides all other start options.
57 * Only the functions, besides own definitions, init/2 (called via
59 oe_create*/2) and terminate/2 (called via corba:dispose/1) must be
60 implemented.
61 By adopting the rules for pseudo objects described above we can use
63 oe_create/2 to create server or pseudo objects, by excluding or includ‐
64 ing the option {pseudo, true}, without changing the call-back module.
65 If you start a object without {regname, RegName} it can only be
67 accessed through the returned object key. Started with a {regname, Reg‐
68 Name} the name is registered locally or globally.
69 Warning:
71 To avoid flooding Orber with old object references start erlang using
72 the flag -orber objectkeys_gc_time Time, which will remove all object
73 references related to servers being dead for Time seconds. To avoid
74 extra overhead, i.e., performing garbage collect if no persistent
75 objects are started, the objectkeys_gc_time default value is infinity.
76 For more information, see the orber and corba documentation.
77
80 Module_Interface:typeID() -> TypeId
81 Types:
83 TypeId = string(), e.g., "IDL:Module/Interface:1.0"
85 Returns the Type ID related to this stub/skeleton
87 Module_Interface:oe_create() -> ObjRef
89 Types:
91 ObjRef = #object reference
93 Start a Orber server.
95 Module_Interface:oe_create_link() -> ObjRef
97 Types:
99 ObjRef = #object reference
101 Start a linked Orber server.
103 Module_Interface:oe_create(Env) -> ObjRef
105 Types:
107 Env = term()
109 ObjRef = #object reference
110 Start a Orber server passing Env to init/1.
112 Module_Interface:oe_create_link(Env) -> ObjRef
114 Types:
116 Env = term()
118 ObjRef = #object reference
119 Start a linked Orber server passing Env to init/1.
121 Module_Interface:oe_create(Env, Options) -> ObjRef
123 Types:
125 Env = term()
127 ObjRef = #object reference
128 Options = [{sup_child, false} | {persistent, Bool} | {reg‐
129 name, RegName} | {pseudo, Bool} | {local_typecheck, Bool} |
130 {survive_exit, Bool} | {create_options, [CreateOpts]}]
131 Bool = true | false
132 RegName = {global, term()} | {local, atom()}
133 CreateOpts = {debug, [Dbg]} | {timeout, Time}
134 Dbg = trace | log | statistics | {log_to_file, FileName}
135 Start a Orber server passing Env to init/1.
137 If the option {pseudo, true} is used, all other options are
139 overridden. As default, this option is set to false.
140 This function cannot be used for starting a server as supervisor
142 child. If started as persistent, the options [{persistent,
143 true}, {regname, {global, term()}}] must be used and Orber will
144 only forget the object reference if it terminates with reason
145 normal or shutdown.
146 The option {local_typecheck, boolean()}, which overrides the
148 Local Typechecking environment flag, turns on or off typecheck‐
149 ing. If activated, parameters, replies and raised exceptions
150 will be checked to ensure that the data is correct, when invok‐
151 ing operations on CORBA Objects within the same Orber domain.
152 Due to the extra overhead, this option MAY ONLY be used during
153 testing and development.
154 {survive_exit, boolean()} overrides the EXIT Tolerance environ‐
156 ment flag. If activated, the server will not terminate, even
157 though the call-back module returns EXIT.
158 Time specifies how long time, in milliseconds, the server is
160 allowed to spend initializing. For more information about the
161 Dbg options, see the sys module.
162 Module_Interface:oe_create_link(Env, Options) -> Return
164 Types:
166 Env = term()
168 Return = ObjRef | {ok, Pid, ObjRef}
169 ObjRef = #object reference
170 Options = [{sup_child, Bool} | {persistent, Bool} | {regname,
171 RegName} | {pseudo, Bool} | {local_typecheck, Bool} | {sur‐
172 vive_exit, Bool} | {create_options, [CreateOpts]}]
173 Bool = true | false
174 RegName = {global, term()} | {local, atom()}
175 CreateOpts = {debug, [Dbg]} | {timeout, Time}
176 Dbg = trace | log | statistics | {log_to_file, FileName}
177 Start a linked Orber server passing Env to init/1.
182 If the option {pseudo, true} is used, all other options are
184 overridden and no link will be created. As default, this option
185 is set to false.
186 This function can be used for starting a server as persistent or
188 supervisor child. At the moment [{persistent, true}, {regname,
189 {global, term()}}] must be used to start a server as persistent,
190 i.e., if a server died and is in the process of being restarted
191 a call to the server will not raise 'OBJECT_NOT_EXIST' excep‐
192 tion. Orber will only forget the object reference if it termi‐
193 nates with reason normal or shutdown, hence, the server must be
194 started as transient (for more information see the supervisor
195 documentation).
196 The options {local_typecheck, boolean()} and {survive_exit,
198 boolean()} behaves in the same way as for oe_create/2.
199 Time specifies how long time, in milliseconds, the server is
201 allowed to spend initializing. For more information about the
202 Dbg options, see the sys module.
203 Module_Interface:own_functions(ObjRef, Arg1, ..., ArgN) -> Reply
205 Module_Interface:own_functions(ObjRef, Options, Arg1, ..., ArgN) ->
206 Reply
207 Types:
209 ObjRef = #object reference
211 Options = [Option] | Timeout
212 Option = {timeout, Timeout} | {context, [Context]}
213 Timeout = infinity | integer(milliseconds)
214 Context = #'IOP_ServiceContext'{context_id = CtxId, con‐
215 text_data = CtxData}
216 CtxId = ?ORBER_GENERIC_CTX_ID
217 CtxData = {interface, Interface} | {userspecific, term()} |
218 {configuration, Options}
219 Interface = string()
220 Options = [{Key, Value}]
221 Key = ssl_client_verify | ssl_client_depth | ssl_client_cert‐
222 file | ssl_client_cacertfile | ssl_client_password |
223 ssl_client_keyfile | ssl_client_ciphers |
224 ssl_client_cachetimeout
225 Value = allowed value associated with the given key
226 ArgX = specified in the IDL-code.
227 Reply = specified in the IDL-code.
228 The default value for the Timeout option is infinity. IPv4 or
230 IPv6 addresses are accepted as local Interface.
231 The configuration context is used to override the global SSL
233 client side configuration.
234 To gain access to #'IOP_ServiceContext'{} record and the
236 ?ORBER_GENERIC_CTX_ID macro, you must add
237 -include_lib("orber/include/corba.hrl"). to your module.
238
240 The following functions should be exported from a CORBA callback mod‐
241 ule. Note, a complete template of the call-back module can be generated
242 automatically by compiling the IDL-file with the IC option {be,erl_tem‐
243 plate}. One should also add the same compile options, for example this
244 or from, used when generating the stub/skeleton modules.
245
247 Module_Interface_impl:init(Env) -> CallReply
248 Types:
250 Env = term()
252 CallReply = {ok, State} | {ok, State, Timeout} | ignore |
253 {stop, StopReason}
254 State = term()
255 Timeout = int() >= 0 | infinity
256 StopReason = term()
257 Whenever a new server is started, init/1 is the first function
259 called in the specified call-back module.
260 Module_Interface_impl:terminate(Reason, State) -> ok
262 Types:
264 Reason = term()
266 State = term()
267 This call-back function is called whenever the server is about
269 to terminate.
270 Module_Interface_impl:code_change(OldVsn, State, Extra) -> CallReply
272 Types:
274 OldVsn = undefined | term()
276 State = term()
277 Extra = term()
278 CallReply = {ok, NewState}
279 NewState = term()
280 Update the internal State.
282 Module_Interface_impl:handle_info(Info, State) -> CallReply
284 Types:
286 Info = term()
288 State = term()
289 CallReply = {noreply, State} | {noreply, State, Timeout} |
290 {stop, StopReason, State}
291 Timeout = int() >= 0 | infinity
292 StopReason = normal | shutdown | term()
293 If the configuration parameter {{handle_info, "Module::Inter‐
295 face"}, true} is passed to IC and process_flag(trap_exit,true)
296 is set in the init() call-back this function must be exported.
297 Note:
299 To be able to handle the Timeout option in CallReply in the
300 call-back module the configuration parameter {{handle_info,
301 "Module::Interface"}, true} must be passed to IC.
302 Module_Interface_impl:own_functions(State, Arg1, ..., ArgN) -> CallRe‐
305 ply
306 Module_Interface_impl:own_functions(This, State, Arg1, ..., ArgN) ->
307 CallReply
308 Module_Interface_impl:own_functions(This, From, State, Arg1, ..., ArgN)
309 -> ExtCallReply
310 Module_Interface_impl:own_functions(From, State, Arg1, ..., ArgN) ->
311 ExtCallReply
312 Types:
314 This = the servers #object reference
316 State = term()
317 ArgX = specified in the IDL-code.
318 CallReply = {reply, Reply, State} | {reply, Reply, State,
319 Timeout} | {stop, StopReason, Reply, State} | {stop, StopRea‐
320 son, State} | corba:raise(Exception)
321 ExtCallReply = CallReply | corba:reply(From, Reply), {nore‐
322 ply, State} | corba:reply(From, Reply), {noreply, State,
323 Timeout}
324 Reply = specified in the IDL-code.
325 Timeout = int() >= 0 | infinity
326 StopReason = normal | shutdown | term()
327 All two-way functions must return one of the listed replies or
329 raise any of the exceptions listed in the IDL code (i.e.
330 raises(...)). If the IC compile options this and/or from are
331 used, the implementation must accept the This and/or From param‐
332 eters.
333 Module_Interface_impl:own_functions(State, Arg1, ..., ArgN) -> CastRe‐
335 ply
336 Module_Interface_impl:own_functions(This, State, Arg1, ..., ArgN) ->
337 CastReply
338 Types:
340 This = the servers #object reference
342 State = term()
343 CastReply = {noreply, State} | {noreply, State, Timeout} |
344 {stop, StopReason, State}
345 ArgX = specified in the IDL-code.
346 Reply = specified in the IDL-code.
347 Timeout = int() >= 0 | infinity
348 StopReason = normal | shutdown | term()
349 All one-way functions must return one of the listed replies. If
351 the IC compile option this is used, the implementation must
352 accept the This parameter.
353Ericsson AB orber 3.8.4 Module_Interface(3)