GoWebScanPipeMsg Class Reference
Description
Base class for a msg that can be processed with a GoWebScanPipeTask and submitted to the GoWebScanPipe for scheduling. GoWebScanPipeMsg objects have a thread-safe reference count. GoWebScanPipeMsg objects are always allocated from GoWebScanPipeMsgPool objects with a default reference count of 1. When the reference count reaches zero, the message is recycled to the pool free list. This allows for efficient reuse of message memory.
Inheritance diagram for GoWebScanPipeMsg:
Public Member Functions | |
| kStatus | GoWebScanPipeMsg_Acquire (GoWebScanPipeMsg msg) |
| Increments the msg's reference count. More... | |
| GoWebScanMsgStamp * | GoWebScanPipeMsg_GetStamp (GoWebScanPipeMsg msg) |
| Gets the stamp associated with the message. More... | |
| kStatus | GoWebScanPipeMsg_Relinquish (GoWebScanPipeMsg msg) |
| Decrements the msg's reference count. More... | |
| kStatus | GoWebScanPipeMsg_SetStamp (GoWebScanPipeMsg msg, const GoWebScanMsgStamp *stamp) |
| Sets the stamp associated with the message. More... | |
| kSize | GoWebScanPipeMsg_Size (GoWebScanPipeMsg msg) |
| Gets the size, in bytes, of the message's data buffer. More... | |
| GoWebScanMsgType | GoWebScanPipeMsg_TypeId (GoWebScanPipeMsg msg) |
| Gets the message type. More... | |
The documentation for this class was generated from the following file: