FireSync API
 All Classes Files Functions Variables Typedefs Friends Macros Modules Pages
kPxPipe.h
Go to the documentation of this file.
1 
8 #ifndef K_FIRESYNC_PX_PIPE_H
9 #define K_FIRESYNC_PX_PIPE_H
10 
11 #include <kFireSync/kNodeDef.h>
12 
13 kBeginHeader()
14 
15 
21 //typedef kObject kPxPipe; --forward-declared in kFsDef.x.h
22 
23 
31 kFsFx(kStatus) kPxPipe_SetMaxQueueSize(kPxPipe pipe, kSize size);
32 
41 kFsFx(kStatus) kPxPipe_SetMaxQueueCount(kPxPipe pipe, kSize count);
42 
53 kFsFx(kStatus) kPxPipe_SetThreadCount(kPxPipe pipe, kSize count);
54 
62 kFsFx(kStatus) kPxPipe_Clear(kPxPipe pipe);
63 
76 kFsFx(kStatus) kPxPipe_AddBlocks(kPxPipe pipe, const kPxBlock* blocks, kSize count);
77 
87 kFsFx(kStatus) kPxPipe_AddRoutes(kPxPipe pipe, const kRouteEntry* routes, kSize count);
88 
98 kFsFx(kStatus) kPxPipe_Start(kPxPipe pipe);
99 
109 kFsFx(kStatus) kPxPipe_Stop(kPxPipe pipe);
110 
120 kFsFx(kStatus) kPxPipe_Pause(kPxPipe pipe);
121 
131 kFsFx(kStatus) kPxPipe_Resume(kPxPipe pipe);
132 
141 kFsFx(kStatus) kPxPipe_Replay(kPxPipe pipe, kMsgInfo msgInfo);
142 
155 kFsFx(kStatus) kPxPipe_UpdateStats(kPxPipe pipe);
156 
164 kFsFx(kPxEnviron) kPxPipe_Environ(kPxPipe pipe);
165 
166 kEndHeader()
167 
168 #include <kFireSync/Pipe/kPxPipe.x.h>
169 
170 #endif
kPxPipe::kPxPipe_Start
kStatus kPxPipe_Start(kPxPipe pipe)
Starts the pipe execution environment.
kPxPipe
Abstract base class for a pipe execution engine.
kPxEnviron
Represents an object that provides external services to a pipe execution engine.
kPxPipe::kPxPipe_UpdateStats
kStatus kPxPipe_UpdateStats(kPxPipe pipe)
Updates any periodic pipe statistics.
kPxPipe::kPxPipe_Stop
kStatus kPxPipe_Stop(kPxPipe pipe)
Stops the pipe execution environment.
kNodeDef.h
Essential declarations related to FireSync nodes.
kPxBlock
Abstract base class for pipe block implementations.
kPxPipe::kPxPipe_Clear
kStatus kPxPipe_Clear(kPxPipe pipe)
Clears existing pipe configuration (blocks, routes).
kRouteEntry
Represents a pair of source/destination endpoints describing a pipe data route.
Definition: kNodeDef.h:1528
kPxPipe::kPxPipe_Pause
kStatus kPxPipe_Pause(kPxPipe pipe)
Pauses the pipe execution environment.
kPxPipe::kPxPipe_Environ
kPxEnviron kPxPipe_Environ(kPxPipe pipe)
Gets a reference to the (optional) pipe environ provider.
kPxPipe::kPxPipe_SetThreadCount
kStatus kPxPipe_SetThreadCount(kPxPipe pipe, kSize count)
Sets the desired number of threads used by the pipe for data processing.
kPxPipe::kPxPipe_AddBlocks
kStatus kPxPipe_AddBlocks(kPxPipe pipe, const kPxBlock *blocks, kSize count)
Adds block instances to the pipe.
kPxPipe::kPxPipe_AddRoutes
kStatus kPxPipe_AddRoutes(kPxPipe pipe, const kRouteEntry *routes, kSize count)
Adds message routes to the pipe.
kPxPipe::kPxPipe_Replay
kStatus kPxPipe_Replay(kPxPipe pipe, kMsgInfo msgInfo)
Inserts a message into the pipe for re-processing.
kPxPipe::kPxPipe_SetMaxQueueCount
kStatus kPxPipe_SetMaxQueueCount(kPxPipe pipe, kSize count)
Sets the maximum input queue item count.
kMsgInfo
Represents message source information and an attached message.
kPxPipe::kPxPipe_Resume
kStatus kPxPipe_Resume(kPxPipe pipe)
Resumes the pipe execution environment.
kPxPipe::kPxPipe_SetMaxQueueSize
kStatus kPxPipe_SetMaxQueueSize(kPxPipe pipe, kSize size)
Sets the maximum input queue data size, in bytes.