RcmServer.h File Reference

---

Detailed Description

Remote Command Message Server Module. An RcmServer processes inbound messages received from an RcmClient.

The RcmServer processes inbound messages received from an RcmClient. After processing a message, the server will return the message to the client.

See also:

RcmClient.h
RCM Overview

#include <xdc/runtime/knl/GateThread.h>
#include <xdc/runtime/knl/Thread.h>

Include dependency graph for RcmServer.h:

Go to the source code of this file.

Functions
Int	RcmServer_addSymbol (RcmServer_Handle handle, String name, RcmServer_MsgFxn addr, UInt32 *index)
	Add a symbol to the server's function table.
Int	RcmServer_construct (RcmServer_Struct *structPtr, String name, const RcmServer_Params *params)
	Initialize a new instance object inside the provided structure.
Int	RcmServer_create (String name, RcmServer_Params *params, RcmServer_Handle *handle)
	Create an RcmServer instance.
Int	RcmServer_delete (RcmServer_Handle *handlePtr)
	Delete an RcmServer instance.
Int	RcmServer_destruct (RcmServer_Struct *structPtr)
	Finalize the instance object inside the provided structure.
Void	RcmServer_exit (Void)
	Finalize the RcmServer module.
Void	RcmServer_init (Void)
	Initialize the RcmServer module.
Void	RcmServer_Params_init (RcmServer_Params *params)
	Initialize the instance create params structure.
Int	RcmServer_removeSymbol (RcmServer_Handle handle, String name)
	Remove a symbol and from the server's function table.
Int	RcmServer_start (RcmServer_Handle handle)
	Start the server.
Defines
#define	RcmServer_S_SUCCESS   (0)
	Success return code.
#define	RcmServer_E_FAIL   (-1)
	General failure return code.
#define	RcmServer_E_NOMEMORY   (-2)
	The was insufficient memory left on the heap.
#define	RcmServer_E_SYMBOLNOTFOUND   (-3)
	The given symbol was not found in the server's symbol table.
#define	RcmServer_E_SYMBOLSTATIC   (-4)
	The given symbols is in the static table, it cannot be removed.
#define	RcmServer_E_SYMBOLTABLEFULL   (-5)
	The server's symbol table is full.
Data Structures
struct	RcmServer_FxnDesc
	Function descriptor. More...
struct	RcmServer_FxnDescAry
	Function descriptor array. More...
struct	RcmServer_ThreadPoolDesc
	Worker pool descriptor. More...
struct	RcmServer_ThreadPoolDescAry
	Worker pool descriptor array. More...
struct	RcmServer_Params
	RcmServer Instance create parameters. More...
struct	RcmServer_Struct
	Opaque client structure large enough to hold an instance object. More...
Typedefs
typedef Int32(*	RcmServer_MsgFxn )(UInt32, UInt32 *)
	Remote function type.
typedef struct RcmServer_Object_tag *	RcmServer_Handle
	RcmServer instance object handle.