FireSync API
 All Classes Files Functions Variables Typedefs Friends Macros Modules Pages
kPipe.h
Go to the documentation of this file.
1 
8 #ifndef K_FIRESYNC_PIPE_H
9 #define K_FIRESYNC_PIPE_H
10 
11 #include <kFireSync/kNodeDef.h>
12 
19 //typedef kObject kPipe; --forward-declared in kFsDef.x.h
20 
31 kFsFx(kSize) kPipe_TypeCount(kPipe pipe);
32 
41 kFsFx(const kChar*) kPipe_TypeNameAt(kPipe pipe, kSize index);
42 
51 kFsFx(const kChar*) kPipe_TypeDescriptionAt(kPipe pipe, kSize index);
52 
60 kFsFx(kStatus) kPipe_Clear(kPipe pipe);
61 
70 kFsFx(kStatus) kPipe_SetEngine(kPipe pipe, kPipeEngine type);
71 
79 kFsFx(kPipeEngine) kPipe_Engine(kPipe pipe);
80 
89 kFsFx(kStatus) kPipe_EngineInfo(kPipe pipe, kInfoBits* info);
90 
101 kFsFx(kStatus) kPipe_SetThreadCount(kPipe pipe, kSize count);
102 
110 kFsFx(kSize) kPipe_ThreadCount(kPipe pipe);
111 
120 kFsFx(kStatus) kPipe_ThreadCountInfo(kPipe pipe, kInfoSize* info);
121 
138 
147 
157 
167 kFsFx(k32s) kPipe_SetThreadPriorityOffset(kPipe pipe, k32s priorityOffset);
168 
177 
187 
203 kFsFx(kStatus) kPipe_SetThreadAffinity(kPipe pipe, kBitArray affinity);
204 
213 kFsFx(kStatus) kPipe_ThreadAffinity(kPipe pipe, kBitArray affinity);
214 
223 kFsFx(kStatus) kPipe_ThreadAffinityInfo(kPipe pipe, kInfo* info);
224 
233 kFsFx(kStatus) kPipe_SetMaxQueueCount(kPipe pipe, kSize count);
234 
242 kFsFx(kSize) kPipe_MaxQueueCount(kPipe pipe);
243 
252 kFsFx(kStatus) kPipe_SetMaxQueueSize(kPipe pipe, kSize size);
253 
261 kFsFx(kSize) kPipe_MaxQueueSize(kPipe pipe);
262 
277 kFsFx(kStatus) kPipe_AddBlock(kPipe pipe, const kChar* typeName, const kChar* name, kBlock* block);
278 
287 kFsFx(kStatus) kPipe_DeleteBlock(kPipe pipe, kBlock block);
288 
296 kFsFx(kSize) kPipe_BlockCount(kPipe pipe);
297 
306 kFsFx(kBlock) kPipe_BlockAt(kPipe pipe, kSize index);
307 
315 kFsFx(kSize) kPipe_UserBlockCount(kPipe pipe);
316 
325 kFsFx(kBlock) kPipe_UserBlockAt(kPipe pipe, kSize index);
326 
336 kFsFx(kStatus) kPipe_SwapUserBlocks(kPipe pipe, kSize index0, kSize index1);
337 
350 kFsFx(kStatus) kPipe_AddRoute(kPipe pipe, k32u sourceBlock, k32u sourcePort, k32u destBlock, k32u destPort, kRoute* route);
351 
362 kFsFx(kStatus) kPipe_AddRoutePoints(kPipe pipe, const kRoutePoint* source, const kRoutePoint* destination, kRoute* route);
363 
376 kFsFx(kStatus) kPipe_AddRouteStr(kPipe pipe, const kChar* sourceBlock, const kChar* sourcePort, const kChar* destBlock, const kChar* destPort, kRoute* route);
377 
388 kFsFx(kStatus) kPipe_ResolveRoutePoint(kPipe pipe, const kChar* blockName, const kChar* portName, kRoutePoint* routePoint);
389 
399 kFsFx(kStatus) kPipe_ResolveBlock(kPipe pipe, const kChar* blockName, kBlock* block);
400 
410 kFsFx(kStatus) kPipe_ResolveBlockById(kPipe pipe, k32u id, kBlock* block);
411 
422 kFsFx(kStatus) kPipe_ResolvePort(kPipe pipe, const kChar* blockName, const kChar* portName, kPort* port);
423 
432 kFsFx(kStatus) kPipe_DeleteRoute(kPipe pipe, kRoute route);
433 
441 kFsFx(kStatus) kPipe_ClearRoutes(kPipe pipe);
442 
450 kFsFx(kSize) kPipe_RouteCount(kPipe pipe);
451 
460 kFsFx(kRoute) kPipe_RouteAt(kPipe pipe, kSize index);
461 
472 kFsFx(kStatus) kPipe_EnableTimer(kPipe pipe, kBool enable);
473 
481 kFsFx(kBool) kPipe_TimerEnabled(kPipe pipe);
482 
491 kFsFx(kStatus) kPipe_TimerEnabledInfo(kPipe pipe, kInfoBool* info);
492 
501 kFsFx(kStatus) kPipe_SetTimerPeriod(kPipe pipe, k64u periodUs);
502 
510 kFsFx(k64u) kPipe_TimerPeriod(kPipe pipe);
511 
520 kFsFx(kStatus) kPipe_TimerPeriodInfo(kPipe pipe, kInfo64u* info);
521 
522 #include <kFireSync/Client/kPipe.x.h>
523 
524 #endif
kStatus kPipe_DeleteBlock(kPipe pipe, kBlock block)
Destroys the specified block and removes it from the pipe's block list.
kStatus kPipe_ResolvePort(kPipe pipe, const kChar *blockName, const kChar *portName, kPort *port)
Finds a port instance by name.
const kChar * kPipe_TypeDescriptionAt(kPipe pipe, kSize index)
Gets a description of the block type at the specified index.
kSize kPipe_UserBlockCount(kPipe pipe)
Gets the number of user-created blocks belonging to the pipe.
kStatus kPipe_EnableTimer(kPipe pipe, kBool enable)
Enables the pipe timer service.
kStatus kPipe_ThreadPriorityClassInfo(kPipe pipe, kInfo32s *info)
Reports constraint and validity information for the ThreadPriorityClass setting.
kStatus kPipe_ResolveBlock(kPipe pipe, const kChar *blockName, kBlock *block)
Finds a block instance by name.
kThreadPriorityClass kPipe_ThreadPriorityClass(kPipe pipe)
Gets the thread priority class for any pipe threads.
kStatus kPipe_AddRoutePoints(kPipe pipe, const kRoutePoint *source, const kRoutePoint *destination, kRoute *route)
Adds a message route to the pipe.
kSize kPipe_RouteCount(kPipe pipe)
Returns the number of routes in the pipe.
kStatus kPipe_SetEngine(kPipe pipe, kPipeEngine type)
Sets the pipe processing engine type.
kBool kPipe_TimerEnabled(kPipe pipe)
Reports whether the pipe timer is currently enabled.
Represents pipe configuration.
kStatus kPipe_AddRouteStr(kPipe pipe, const kChar *sourceBlock, const kChar *sourcePort, const kChar *destBlock, const kChar *destPort, kRoute *route)
Adds a message route to the pipe by resolving end-point names.
kSize kPipe_ThreadCount(kPipe pipe)
Gets the desired number of threads used by the pipe engine.
kStatus kPipe_DeleteRoute(kPipe pipe, kRoute route)
Removes a message route from the pipe.
Represents constraint and validity information for a bit flag setting.
Definition: kInfo.h:544
kStatus kPipe_TimerPeriodInfo(kPipe pipe, kInfo64u *info)
Reports constraint and validity information for the TimerPeriod setting.
kStatus kPipe_ThreadAffinityInfo(kPipe pipe, kInfo *info)
Reports constraint and validity information for the ThreadAffinity setting.
kStatus kPipe_ThreadAffinity(kPipe pipe, kBitArray affinity)
Gets the thread affinity for any pipe threads.
kStatus kPipe_ThreadPriorityOffsetInfo(kPipe pipe, kInfo32s *info)
Reports constraint and validity information for the ThreadPriorityOffset setting. ...
k64u kPipe_TimerPeriod(kPipe pipe)
Reports the current period for the piper timer service.
kStatus kPipe_SetThreadPriorityClass(kPipe pipe, kThreadPriorityClass priorityClass)
Sets the thread priority class for any pipe threads.
kSize kPipe_MaxQueueCount(kPipe pipe)
Gets the maximum count of the pipe's message input queue.
Represents constraint and validity information for a 32-bit signed integer setting.
Definition: kInfo.h:166
kStatus kPipe_SetMaxQueueCount(kPipe pipe, kSize count)
Sets the maximum count for the pipe's message input queue.
Essential declarations related to FireSync nodes.
kBlock kPipe_UserBlockAt(kPipe pipe, kSize index)
Gets the user-created block at the specified index.
kSize kPipe_BlockCount(kPipe pipe)
Gets the total number of blocks belonging to the pipe (including system and user blocks).
kPipeEngine kPipe_Engine(kPipe pipe)
Gets the pipe processing engine type.
kSize kPipe_TypeCount(kPipe pipe)
Gets the number of block types currently available on this node.
kStatus kPipe_SetThreadCount(kPipe pipe, kSize count)
Sets the desired number of threads used by the pipe engine.
kStatus kPipe_ResolveBlockById(kPipe pipe, k32u id, kBlock *block)
Finds a block instance by id.
kStatus kPipe_ResolveRoutePoint(kPipe pipe, const kChar *blockName, const kChar *portName, kRoutePoint *routePoint)
Determines the routing end-point of a port from block/port names.
kStatus kPipe_ClearRoutes(kPipe pipe)
Removes all message routes from the pipe.
kStatus kPipe_AddBlock(kPipe pipe, const kChar *typeName, const kChar *name, kBlock *block)
Creates and adds a new block to the pipe.
Represents port configuration.
kSize kPipe_MaxQueueSize(kPipe pipe)
Gets the maximum total data size of the pipe's message input queue.
kStatus kPipe_SwapUserBlocks(kPipe pipe, kSize index0, kSize index1)
Swaps the order of two user blocks in the pipe's user block list.
kStatus kPipe_EngineInfo(kPipe pipe, kInfoBits *info)
Reports constraint and validity information for the Engine setting.
kStatus kPipe_SetMaxQueueSize(kPipe pipe, kSize size)
Sets the maximum total data size for the pipe's message input queue.
kBlock kPipe_BlockAt(kPipe pipe, kSize index)
Gets the block at the specified index.
kStatus kPipe_TimerEnabledInfo(kPipe pipe, kInfoBool *info)
Reports constraint and validity information for the TimerEnabled setting.
Represents block configuration.
Represents constraint and validity information for a 64-bit unsigned integer setting.
Definition: kInfo.h:234
Represents configuration for a pipe message route.
const kChar * kPipe_TypeNameAt(kPipe pipe, kSize index)
Gets the name of the block type at the specified index.
kRoute kPipe_RouteAt(kPipe pipe, kSize index)
Gets the route at the specified index.
kStatus kPipe_SetThreadAffinity(kPipe pipe, kBitArray affinity)
Sets the thread affinity for any pipe threads.
k32s kPipe_ThreadPriorityOffset(kPipe pipe)
Gets the thread priority offset for any pipe threads.
Represents constraint and validity information for a kSize setting.
Definition: kInfo.h:370
kStatus kPipe_AddRoute(kPipe pipe, k32u sourceBlock, k32u sourcePort, k32u destBlock, k32u destPort, kRoute *route)
Adds a message route to the pipe.
Represents a source or destination endpoint address for a pipe data route.
Definition: kNodeDef.h:1796
kStatus kPipe_ThreadCountInfo(kPipe pipe, kInfoSize *info)
Reports constraint and validity information for the ThreadCount setting.
kStatus kPipe_Clear(kPipe pipe)
Resets pipe mode settings to defaults.
k32s kPipe_SetThreadPriorityOffset(kPipe pipe, k32s priorityOffset)
Sets the thread priority offset for any pipe threads.
Represents constraint and validity information for a general setting.
Definition: kInfo.h:64
kStatus kPipe_SetTimerPeriod(kPipe pipe, k64u periodUs)
Sets the period for the pipe timer service.
Represents the type of data processing engine used in a kPipe instance.
Represents constraint and validity information for a boolean setting.
Definition: kInfo.h:493