NAME

       ic_clib - IC C Library Functions

DESCRIPTION

       This manual page lists some of the functions in the IC C runtime library.

ALLOCATION AND DEALLOCATION FUNCTIONS

       The  following  functions  are  used  for  allocating and deallocating a CORBA_Environment
       structure.

EXPORTS

       CORBA_Environment *CORBA_Environment_alloc(int inbufsz, int outbufsz)

              This function is used to allocate and initiate the CORBA_Environment structure.  In
              particular,  it  is  used to dynamically allocate a CORBA_Environment structure and
              set the default values for the structure's fields.

              inbufsize is the initial size of the input buffer.

              outbufsize is the initial size of the output buffer.

              CORBA_Environment is the CORBA 2.0 state structure used by the generated stub.

              This function will set all needed default values and allocate buffers  the  lengths
              of  which  are  equal  to  the  values  passed, but will not allocate space for the
              _to_pid and _from_pid fields.

              To free the space allocated by CORBA_Environment_alloc() do as follows.

                * First call CORBA_free for the input and output buffers.

                * After freeing the buffer  space,  call  CORBA_free  for  the  CORBA_Environment
                  space.

       void CORBA_free(void *p)

              Frees allocated space pointed to by p.

       CORBA_char *CORBA_string_alloc(CORBA_unsigned_long len)

              Allocates a (simple) CORBA character string of length len + 1.

       CORBA_wchar *CORBA_wstring_alloc(CORBA_unsigned_long len)

              Allocates a CORBA wide string of length len + 1.

EXCEPTION FUNCTIONS

       Functions for retrieving exception ids and values, and for setting exceptions.

EXPORTS

       CORBA_char *CORBA_exception_id(CORBA_Environment *env)

              Returns the exception identity if an exception is set, otherwise it returns NULL.

       void *CORBA_exception_value(CORBA_Environment *env)

              Returns the exception value, if an exception is set, otherwise it returns NULL.

       void  CORBA_exc_set(CORBA_Environment  *env,  CORBA_exception_type  Major, CORBA_char *Id,
       CORBA_char *Value)

              Sets the exception type, exception identity, and exception value in the environment
              pointed to by env.

SERVER RECEPTION

       The following function is provided for convenience.

EXPORTS

       int oe_server_receive(CORBA_Environment *env, oe_map_t *map)
       int  oe_server_receive_tmo(CORBA_Environment  *env,  oe_map_t *map,  unsigned int send_ms,
       unsigned int recv_ms)

              Provides a loop that receives one message, executes the operation in question,  and
              in case of a two-way operation sends a reply.

              send_ms  and  recv_ms  specify timeout values in milliseconds for send and receive,
              respectively.

GENERIC EXECUTION SWITCH AND MAP MERGING

       Function for searching for server  operation  function,  and  for  calling  it  if  found.
       Function for merging maps (see the include file ic.h for definitions).

EXPORTS

       int oe_exec_switch(CORBA_Object obj, CORBA_Environment *env, oe_map_t *map)

              Search for server operation and execute it.

       oe_map_t *oe_merge_maps(oe_map_t *maps, int size)

              Merge an array of server maps to one single map.

THE CORBA_ENVIRONMENT STRUCTURE

       Here is the complete definition of the CORBA_Environment structure, defined in file ic.h:

             /* Environment definition */
             typedef struct {

             /*----- CORBA compatibility part ------------------------*/
             /* Exception tag, initially set to CORBA_NO_EXCEPTION ---*/
             CORBA_exception_type   _major;

             /*----- External Implementation part - initiated by the user ---*/
             /* File descriptor                                              */
             int                    _fd;
             /* Size of input buffer                                         */
             int                    _inbufsz;
             /* Pointer to always dynamically allocated buffer for input     */
             char                  *_inbuf;
             /* Size of output buffer                                        */
             int                    _outbufsz;
             /* Pointer to always dynamically allocated buffer for output    */
             char                  *_outbuf;
             /* Size of memory chunks in bytes, used for increasing the output
             buffer, set to >= 32, should be around >= 1024 for performance
             reasons                                                       */
             int                    _memchunk;
             /* Pointer for registered name                                   */
             char                   _regname[256];
             /* Process identity for caller                                   */
             erlang_pid            *_to_pid;
             /* Process identity for callee                                  */
             erlang_pid            *_from_pid;

             /*- Internal Implementation part - used by the server/client ---*/
             /* Index for input buffer                                       */
             int                    _iin;
             /* Index for output buffer                                      */
             int                    _iout;
             /* Pointer for operation name                                   */
             char                   _operation[256];
             /* Used to count parameters                                    */
             int                    _received;
             /* Used to identify the caller                                  */
             erlang_pid             _caller;
             /* Used to identify the call                                     */
             erlang_ref             _unique;
             /* Exception id field                                           */
             CORBA_char            *_exc_id;
             /* Exception value field                                        */
             void                  *_exc_value;

             } CORBA_Environment;

   Note:
       Always  set  the  field  values  _fd,  _regname,  _to_pid and/or *_from_pid to appropriate
       application values. These are not automatically set by the stubs.

   Warning:
       Never assign static buffers to the buffer pointers, and never set the _memchunk field to a
       value less than 32.

SEE ALSO

       ic(3erl), ic_c_protocol(3erl)