OpenClovis Logo

Classes | Macros | Typedefs | Functions
clRmdApi.h File Reference

Header file of RMD Interface. More...

#include <clBufferApi.h>
#include <clIocApi.h>
#include <clRmdErrors.h>

Go to the source code of this file.

Classes

struct  ClRmdAsyncOptions
 This structure ClRmdAsyncOptionsT contains additional asynchronous call parameters. More...
struct  ClRmdOptions
 This is a structure to pass optional parameters. More...

Macros

#define CL_RMD_CALL_ASYNC   (1<<0)
 0x0001 If you want to make a synchronous call, set this bit to 0.
#define CL_RMD_CALL_ATMOST_ONCE   (1<<2)
 0x0004 If you want to perform Atmost Once Semantics, you are required to set this bit to 1.
#define CL_RMD_CALL_DO_NOT_OPTIMIZE   (1<<3)
 0x0008 If you want to make a non-optimized RMD call, you are required to set this bit to 1.
#define CL_RMD_CALL_IN_SESSION   (1<<5)
 0x0020 If you want to use the services of the same EO instance as in previous call, you are required to set this bit.
#define CL_RMD_CALL_NEED_REPLY   (1<<1)
 0x0002 If you do not require to check the reply, set this bit to 0.
#define CL_RMD_CALL_NON_PERSISTENT   (1<<4)
 0x0010 If you want RMD to use and free its input message, you are required to set this bit to 1.
#define CL_RMD_DEFAULT_OPTIONS
 Default values for the options.
#define CL_RMD_DEFAULT_PRIORITY   CL_IOC_DEFAULT_PRIORITY
 Default priority of the RMD call.
#define CL_RMD_DEFAULT_RETRIES   5
 Default retries for the RMD call.
#define CL_RMD_DEFAULT_TIMEOUT   10000
 Default timeout for the RMD call - 10 seconds QNX has a traffic shaper leaky bucket.
#define CL_RMD_DEFAULT_TRANSPORT_HANDLE   0
 Default transport handle for the RMD call.
#define CL_RMD_TIMEOUT_FOREVER   -1
 When this is used, RMD waits forever for the call to complete and does not issue timeouts.

Typedefs

typedef void(* ClRmdAsyncCallbackT )(ClRcT retCode, ClPtrT pCookie, ClBufferHandleT inMsgHdl, ClBufferHandleT outMsgHdl)
 Callback function pointer for the async RMD call.
typedef struct ClRmdAsyncOptions ClRmdAsyncOptionsT
 This structure ClRmdAsyncOptionsT contains additional asynchronous call parameters.
typedef struct ClRmdOptions ClRmdOptionsT
 This is a structure to pass optional parameters.

Functions

ClRcT clRmdWithMsg (CL_IN ClIocAddressT remoteObjAddr, CL_IN ClUint32T funcId, CL_IN ClBufferHandleT inMsgHdl, CL_OUT ClBufferHandleT outMsgHdl, CL_IN ClUint32T flags, CL_IN ClRmdOptionsT *pOptions, CL_IN ClRmdAsyncOptionsT *pAsyncOptions)
 Invokes a Remote Function Call when the parameters are passed as messages.

Detailed Description

Header file of RMD Interface.


Generated on Tue Jan 10 10:29:15 PST 2012 for OpenClovis SDK using Doxygen