237 #ifndef ti_grcm_RcmClient__include
238 #define ti_grcm_RcmClient__include
240 #include <xdc/runtime/knl/GateThread.h>
246 #if defined (__cplusplus)
256 #define RcmClient_S_SUCCESS (0)
261 #define RcmClient_E_FAIL (-1)
270 #define RcmClient_E_EXECASYNCNOTENABLED (-2)
277 #define RcmClient_E_EXECFAILED (-3)
286 #define RcmClient_E_INVALIDHEAPID (-4)
295 #define RcmClient_E_INVALIDFXNIDX (-5)
304 #define RcmClient_E_MSGFXNERROR (-6)
311 #define RcmClient_E_IPCERROR (-7)
316 #define RcmClient_E_LISTCREATEFAILED (-8)
324 #define RcmClient_E_LOSTMSG (-9)
333 #define RcmClient_E_MSGALLOCFAILED (-10)
343 #define RcmClient_E_MSGQCREATEFAILED (-11)
352 #define RcmClient_E_MSGQOPENFAILED (-12)
360 #define RcmClient_E_SERVERERROR (-13)
371 #define RcmClient_E_SERVERNOTFOUND (-14)
379 #define RcmClient_E_SYMBOLNOTFOUND (-15)
384 #define RcmClient_E_NOMEMORY (-16)
393 #define RcmClient_E_JOBIDNOTFOUND (-17)
401 #define RcmClient_INVALIDFXNIDX ((UInt32)(0xFFFFFFFF))
406 #define RcmClient_INVALIDHEAPID ((UInt16)(0xFFFF))
411 #define RcmClient_INVALIDMSGID (0)
420 #define RcmClient_DEFAULTPOOLID ((UInt16)(0x8000))
428 #define RcmClient_DISCRETEJOBID (0)
536 xdc_runtime_knl_GateThread_Struct
_f1;
564 RcmClient_Handle handle,
596 RcmClient_Handle handle,
633 RcmClient_Handle handle,
635 RcmClient_Message ** message
695 RcmClient_Handle handle,
696 RcmClient_Message ** returnMsg
750 RcmClient_Handle * handle
762 RcmClient_Handle * handlePtr
809 RcmClient_Handle handle,
810 RcmClient_Message * cmdMsg,
811 RcmClient_Message ** returnMsg
847 RcmClient_Handle handle,
848 RcmClient_Message * cmdMsg,
880 RcmClient_Handle handle,
881 RcmClient_Message * cmdMsg
900 RcmClient_Handle handle,
901 RcmClient_Message * cmdMsg,
902 RcmClient_Message ** returnMsg
931 RcmClient_Handle handle,
932 RcmClient_Message * cmdMsg,
961 RcmClient_Handle handle,
962 RcmClient_Message * msg
981 RcmClient_Handle handle,
1020 RcmClient_Handle handle,
1037 RcmClient_Handle handle,
1060 RcmClient_Handle handle,
1062 RcmClient_Message ** returnMsg
1066 #if defined (__cplusplus)
UInt16 jobId
The job id associated with this message.
Definition: RcmClient.h:458
Ptr _f5
Definition: RcmClient.h:540
Int RcmClient_execAsync(RcmClient_Handle handle, RcmClient_Message *cmdMsg, RcmClient_CallbackFxn callback, Ptr appData)
Execute a command message and use a callback for notification.
Bool callbackNotification
Asynchronous callback notification support.
Definition: RcmClient.h:524
Int RcmClient_execNoWait(RcmClient_Handle handle, RcmClient_Message *cmdMsg, UInt16 *msgId)
Submit a command message to the server and return immediately.
Int RcmClient_construct(RcmClient_Struct *structPtr, String server, const RcmClient_Params *params)
Initialize a new instance object inside the provided structure.
Int RcmClient_execCmd(RcmClient_Handle handle, RcmClient_Message *cmdMsg)
Execute a one-way command message on the server.
Int RcmClient_releaseJobId(RcmClient_Handle handle, UInt16 jobId)
Return a job id to the server and release all resources.
Int RcmClient_exec(RcmClient_Handle handle, RcmClient_Message *cmdMsg, RcmClient_Message **returnMsg)
Execute a command message on the server.
UInt32 dataSize
The size of the data buffer (in chars).
Definition: RcmClient.h:476
Ptr _f3
Definition: RcmClient.h:538
Ptr _f12
Definition: RcmClient.h:547
struct RcmClient_Object_tag * RcmClient_Handle
RcmClient instance object handle.
Definition: RcmClient.h:433
Void RcmClient_init(Void)
Initialize the RcmClient module.
Void(* RcmClient_CallbackFxn)(RcmClient_Message *, Ptr)
Callback function type.
Definition: RcmClient.h:496
Int RcmClient_checkForError(RcmClient_Handle handle, RcmClient_Message **returnMsg)
Check if an error message has been returned from the server.
Int RcmClient_create(String server, const RcmClient_Params *params, RcmClient_Handle *handle)
Create an RcmClient instance.
UInt32 _f6
Definition: RcmClient.h:541
Int RcmClient_delete(RcmClient_Handle *handlePtr)
Delete an RcmClient instance.
Instance create parameters.
Definition: RcmClient.h:501
Ptr _f10
Definition: RcmClient.h:545
UInt16 _f8
Definition: RcmClient.h:543
Ptr _f11
Definition: RcmClient.h:546
Void RcmClient_Params_init(RcmClient_Params *params)
Initialize the instance create params structure.
Int RcmClient_waitUntilDone(RcmClient_Handle handle, UInt16 msgId, RcmClient_Message **returnMsg)
Block until the specified message has been executed.
Remote Command Message structure.
Definition: RcmClient.h:441
Opaque client structure large enough to hold an instance object.
Definition: RcmClient.h:535
Int RcmClient_free(RcmClient_Handle handle, RcmClient_Message *msg)
Free the given message.
Int RcmClient_acquireJobId(RcmClient_Handle handle, UInt16 *jobId)
Get a job id from the server.
Int RcmClient_alloc(RcmClient_Handle handle, UInt32 dataSize, RcmClient_Message **message)
Allocate a message from the heap configured for this instance.
UInt16 poolId
The worker pool id that will process this message.
Definition: RcmClient.h:449
Int RcmClient_addSymbol(RcmClient_Handle handle, String name, Fxn addr, UInt32 *index)
Add a symbol and its address to the server table.
UInt16 _f4
Definition: RcmClient.h:539
Ptr _f2
Definition: RcmClient.h:537
UInt16 heapId
The heapId used by this instance for allocating messages.
Definition: RcmClient.h:509
Int RcmClient_getSymbolIndex(RcmClient_Handle handle, String name, UInt32 *index)
Return the function index from the server.
Ptr _f9
Definition: RcmClient.h:544
Int32 result
The return value of the remote message function.
Definition: RcmClient.h:468
Int RcmClient_removeSymbol(RcmClient_Handle handle, String name)
Remove a symbol and from the server function table.
Int RcmClient_destruct(RcmClient_Struct *structPtr)
Finalize the instance object inside the provided structure.
Void RcmClient_exit(Void)
Finalize the RcmClient module.
xdc_runtime_knl_GateThread_Struct _f1
Definition: RcmClient.h:536
UInt32 fxnIdx
The index of the remote function to execute.
Definition: RcmClient.h:463
Bool _f7
Definition: RcmClient.h:542
Int RcmClient_execDpc(RcmClient_Handle handle, RcmClient_Message *cmdMsg, RcmClient_Message **returnMsg)
Execute a deferred procedure call on the server.