GoWebScanPipeTask Class Reference
Description
Represents a processing task for the GoWebScanPipe class. Each GoWebScanPipeTask maintains a FIFO queue of messages to process (jobs), and submits jobs to the GoWebScanPipe for execution. Each GoWebScanPipeTask has at most one pending job submitted to the Pipe for execution at any given time. Multiple jobs associated with a single task cannot be run in parallel (tasks are assumed to have non-thread-safe state). Each GoWebScanPipeTask is associated with a particular stage (processing priority); multiple tasks can belong to the same stage. Messages are processed through an execution handler provided to the GoWebScanPipeTask.
Inheritance diagram for GoWebScanPipeTask:
Public Member Functions | |
| kSize | GoWebScanPipeTask_MsgCapacity (GoWebScanPipeTask task) |
| Gets the maximum capacity of the message queue. More... | |
| kStatus | GoWebScanPipeTask_Send (GoWebScanPipeTask task, GoWebScanPipeMsg message) |
| Adds a message to the processing queue. More... | |
| kStatus | GoWebScanPipeTask_SetExecuteHandler (GoWebScanPipeTask task, GoWebScanPipeTaskExecuteFx function, kPointer receiver) |
| Sets the callback function that is used to execute processing jobs. More... | |
| kStatus | GoWebScanPipeTask_SetMsgCapacity (GoWebScanPipeTask task, kSize capacity) |
| Sets the maximum capacity of the message queue. More... | |
| kStatus | GoWebScanPipeTask_SetStage (GoWebScanPipeTask task, k32u stage) |
| Sets the stage (processing priority) of a task. More... | |
| k32u | GoWebScanPipeTask_Stage (GoWebScanPipeTask task) |
| Gets the stage (processing priority) of a task. More... | |
The documentation for this class was generated from the following file: