|
|
Remote Command Message structure. More...
#include <RcmClient.h>
Data Fields | |
| UInt16 | poolId |
| The worker pool id that will process this message. More... | |
| UInt16 | jobId |
| The job id associated with this message. More... | |
| UInt32 | fxnIdx |
| The index of the remote function to execute. More... | |
| Int32 | result |
| The return value of the remote message function. More... | |
| UInt32 | dataSize |
| The size of the data buffer (in chars). More... | |
| UInt32 | data [1] |
| The data buffer containing the message payload. More... | |
Remote Command Message structure.
An RcmClient needs to fill in this message before sending it to the RcmServer for execution.
| UInt16 RcmClient_Message::poolId |
The worker pool id that will process this message.
The message will be processed by a worker thread from the worker pool specified in this field. The default value is the default pool id.
| UInt16 RcmClient_Message::jobId |
The job id associated with this message.
All messages beloging to a job id must have this field set to that id. Use the value RcmClient_DISCRETEJOBID if the message does not belong to any job.
| UInt32 RcmClient_Message::fxnIdx |
The index of the remote function to execute.
| Int32 RcmClient_Message::result |
The return value of the remote message function.
| UInt32 RcmClient_Message::dataSize |
The size of the data buffer (in chars).
This field should be considered as read-only. It is set by the call to the RcmClient_alloc() function.
| UInt32 RcmClient_Message::data[1] |
The data buffer containing the message payload.
The size of this field is dataSize chars. The space is allocated by the call to the RcmClient_alloc() function.
