Remote Command Message Client Module. An RcmClient is used for sending messages to an RcmServer for processing.
- See Also
- RcmServer.h
RCM Overview
|
Int | RcmClient_acquireJobId (RcmClient_Handle handle, UInt16 *jobId) |
| Get a job id from the server. More...
|
|
Int | RcmClient_addSymbol (RcmClient_Handle handle, String name, Fxn addr, UInt32 *index) |
| Add a symbol and its address to the server table. More...
|
|
Int | RcmClient_alloc (RcmClient_Handle handle, UInt32 dataSize, RcmClient_Message **message) |
| Allocate a message from the heap configured for this instance. More...
|
|
Int | RcmClient_checkForError (RcmClient_Handle handle, RcmClient_Message **returnMsg) |
| Check if an error message has been returned from the server. More...
|
|
Int | RcmClient_construct (RcmClient_Struct *structPtr, String server, const RcmClient_Params *params) |
| Initialize a new instance object inside the provided structure. More...
|
|
Int | RcmClient_create (String server, const RcmClient_Params *params, RcmClient_Handle *handle) |
| Create an RcmClient instance. More...
|
|
Int | RcmClient_delete (RcmClient_Handle *handlePtr) |
| Delete an RcmClient instance. More...
|
|
Int | RcmClient_destruct (RcmClient_Struct *structPtr) |
| Finalize the instance object inside the provided structure. More...
|
|
Int | RcmClient_exec (RcmClient_Handle handle, RcmClient_Message *cmdMsg, RcmClient_Message **returnMsg) |
| Execute a command message on the server. More...
|
|
Int | RcmClient_execAsync (RcmClient_Handle handle, RcmClient_Message *cmdMsg, RcmClient_CallbackFxn callback, Ptr appData) |
| Execute a command message and use a callback for notification. More...
|
|
Int | RcmClient_execCmd (RcmClient_Handle handle, RcmClient_Message *cmdMsg) |
| Execute a one-way command message on the server. More...
|
|
Int | RcmClient_execDpc (RcmClient_Handle handle, RcmClient_Message *cmdMsg, RcmClient_Message **returnMsg) |
| Execute a deferred procedure call on the server. More...
|
|
Int | RcmClient_execNoWait (RcmClient_Handle handle, RcmClient_Message *cmdMsg, UInt16 *msgId) |
| Submit a command message to the server and return immediately. More...
|
|
Void | RcmClient_exit (Void) |
| Finalize the RcmClient module. More...
|
|
Int | RcmClient_free (RcmClient_Handle handle, RcmClient_Message *msg) |
| Free the given message. More...
|
|
Int | RcmClient_getSymbolIndex (RcmClient_Handle handle, String name, UInt32 *index) |
| Return the function index from the server. More...
|
|
Void | RcmClient_init (Void) |
| Initialize the RcmClient module. More...
|
|
Void | RcmClient_Params_init (RcmClient_Params *params) |
| Initialize the instance create params structure. More...
|
|
Int | RcmClient_releaseJobId (RcmClient_Handle handle, UInt16 jobId) |
| Return a job id to the server and release all resources. More...
|
|
Int | RcmClient_removeSymbol (RcmClient_Handle handle, String name) |
| Remove a symbol and from the server function table. More...
|
|
Int | RcmClient_waitUntilDone (RcmClient_Handle handle, UInt16 msgId, RcmClient_Message **returnMsg) |
| Block until the specified message has been executed. More...
|
|