FireSync API
 All Classes Files Functions Variables Typedefs Friends Macros Modules Pages
kPxSerialPipe Class Reference

Description

Pipe execution engine that completely processes an input message before processing the next input message.

Inheritance diagram for kPxSerialPipe:
Inheritance graph

Public Member Functions

kStatus kPxSerialPipe_Construct (kPxSerialPipe *pipe, k32u nodeId, kPxEnviron pipeEnviron, kAlloc allocator)
 Constructs a kPxSerialPipe instance. More...
 
- Public Member Functions inherited from kPxPipe
kStatus kPxPipe_AddBlocks (kPxPipe pipe, const kPxBlock *blocks, kSize count)
 Adds block instances to the pipe. More...
 
kStatus kPxPipe_AddRoutes (kPxPipe pipe, const kRouteEntry *routes, kSize count)
 Adds message routes to the pipe. More...
 
kStatus kPxPipe_Clear (kPxPipe pipe)
 Clears existing pipe configuration (blocks, routes). More...
 
kStatus kPxPipe_Engage (kPxPipe pipe)
 Engages the pipe execution environment. More...
 
kPxEnviron kPxPipe_Environ (kPxPipe pipe)
 Gets a reference to the (optional) pipe environ provider. More...
 
kStatus kPxPipe_Pause (kPxPipe pipe)
 Pauses the pipe execution environment. More...
 
kStatus kPxPipe_Replay (kPxPipe pipe, kMsgInfo msgInfo)
 Inserts a message into the pipe for re-processing. More...
 
kStatus kPxPipe_Resume (kPxPipe pipe)
 Resumes the pipe execution environment. More...
 
kStatus kPxPipe_SetMaxQueueCount (kPxPipe pipe, kSize count)
 Sets the maximum input queue item count. More...
 
kStatus kPxPipe_SetMaxQueueSize (kPxPipe pipe, kSize size)
 Sets the maximum input queue data size, in bytes. More...
 
kStatus kPxPipe_SetThreadCount (kPxPipe pipe, kSize count)
 Sets the desired number of threads used by the pipe for data processing. More...
 
kStatus kPxPipe_Start (kPxPipe pipe)
 Starts the pipe execution environment. More...
 
kStatus kPxPipe_Stop (kPxPipe pipe)
 Stops the pipe execution environment. More...
 
kStatus kPxPipe_UpdateStats (kPxPipe pipe)
 Updates any periodic pipe statistics. More...
 

The documentation for this class was generated from the following file: