corba

MODULE

corba

MODULE SUMMARY

The functions on CORBA module level

DESCRIPTION

This module contains functions that are specified on the CORBA module level. It also contains some functions for creating and disposing objects.

EXPORTS

create(Module, TypeID) -> Object
create(Module, TypeID, Env) -> Object
create(Module, TypeID, Env, ServerName) -> Object
create_link(Module, TypeID) -> Object
create_link(Module, TypeID, Env) -> Object
create_link(Module, TypeID, Env, ServerName) -> Object

Types:
Module = atom()
TypeID = string()
Env = term()
ServerName = {local, atom()} | {global, atom()}
Object = #objref

These functions starts a new server object. If you start it without ServerName it can only be accessed through the returned object key. If started with a ServerName the name is registered locally or globally.

TypeID is is the repository ID of the server object type and could for example look like "IDL:StackModule/Stack:1.0".

Module is the name of the interface API module.

Env is the arguments passed which will be passed to the implementations init callback function.

A server started with create/2, create/3 or create/4 does not care about the parent, which means that the parent is not handled explicitly in the generic process part.

A server started with create_link2, create_link/3 or create_link/4 is initially linked to the caller, the parent, and it will terminate whenever the parent process terminates, and with the same reason as the parent. If the server traps exits, the terminate/2 callback function is called in order to clean up before the termination. These functions should be used if the server is a worker in a supervision tree.

     Example: 

          corba:create('StackModule_Stack', "IDL:StackModule/Stack:1.0",
                       {10, test})
        

dispose(Object) -> ok

Types:
Object = #objref

This function is used for terminating the execution of a server object.

dispose(Object) -> ok

Types:
Object = #objref

This function is used for terminating the execution of a server object.

create_subobject_key(Object, Key) -> Result

Types:
Object = #objref
Key = term()
Result = #objref

This function is used to create a subobject in a server object. It can for example be useful when one want's unique access to separate rows in an mnesia or ETS table. The Result is an object reference which will be seen as a unique reference to the outside world but will access the same server object where one can use the get_subobject_key/1 function to get the private key value.

Key is stored in the object reference Object. If it's a binary it will be stored as is and otherwise it's converted to a binary before storage.

get_subobject_key(Object) -> Result

Types:
Object = #objref
Result = #binary

This function is used to fetch a subobject key from the object reference Object. The result is a always a binary, if it was an erlang term that was stored with create_subobject_key/2 one can to do binary_to_term/1 to get the real value.

get_pid(Object) -> Result

Types:
Object = #objref
Result = #pid

This function is to get the process id from an object which is a must when Corba objects is started/handled in a supervisor tree. The function will throws exceptions if the key is not found or some other error occurs.

raise(Exception)

Types:
Exception = record()

This function is used for raising corba exceptions as a an erlang user generated exit signal. It will throw the tuple {'EXCEPTION', Exception}.

resolve_initial_references(ObjectId) -> Object

Types:
ObjectId = string()
Object = #objref

This function returns the object reference for the object id asked for (just now only the "NameService").

list_initial_references() -> [ObjectId]

Types:
ObjectId = string()

This function returns a list of allowed object id's (just now only the "NameService").

resolve_initial_references_remote(ObjectId, Address) -> Object

Types:
Address = [RemoteModifier]
RemoteModifier = string()
ObjectId = string()
Object = #objref

This function returns the object reference for the object id asked for (depends on the orb, for orber it's just the "NameService"). The remote modifier string has the following format: "iiop://host:port".

list_initial_references_remote(Address) -> [ObjectId]

Types:
Address = [RemoteModifier]
RemoteModifier = string()
ObjectId = string()

This function returns a list of allowed object id's (depends on the orb, for orber it's just the "NameService"). The remote modifier string has the following format: "iiop://host:port".

object_to_string(Object) -> IOR_string

Types:
Object = #objref
IOR_string = string()

This function returns the object reference as the external string representation of an IOR.

string_to_object(IOR_string) -> Object

Types:
IOR_string = string()
Object = #objref

This function takes an IOR on the external string representation and returns the object reference.

AUTHORS

Lars Thorsén -