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 
13 kBeginHeader()
14 
15 
21 //typedef kObject kPipe; --forward-declared in kFsDef.x.h
22 
23 
33 kFsFx(kSize) kPipe_TypeCount(kPipe pipe);
34 
43 kFsFx(const kChar*) kPipe_TypeNameAt(kPipe pipe, kSize index);
44 
53 kFsFx(const kChar*) kPipe_TypeDescriptionAt(kPipe pipe, kSize index);
54 
62 kFsFx(kStatus) kPipe_Clear(kPipe pipe);
63 
72 kFsFx(kStatus) kPipe_SetEngine(kPipe pipe, kPipeEngine type);
73 
81 kFsFx(kPipeEngine) kPipe_Engine(kPipe pipe);
82 
91 kFsFx(kStatus) kPipe_EngineInfo(kPipe pipe, kInfoBits* info);
92 
103 kFsFx(kStatus) kPipe_SetThreadCount(kPipe pipe, kSize count);
104 
112 kFsFx(kSize) kPipe_ThreadCount(kPipe pipe);
113 
122 kFsFx(kStatus) kPipe_ThreadCountInfo(kPipe pipe, kInfoSize* info);
123 
132 kFsFx(kStatus) kPipe_SetMaxQueueCount(kPipe pipe, kSize count);
133 
141 kFsFx(kSize) kPipe_MaxQueueCount(kPipe pipe);
142 
151 kFsFx(kStatus) kPipe_SetMaxQueueSize(kPipe pipe, kSize size);
152 
160 kFsFx(kSize) kPipe_MaxQueueSize(kPipe pipe);
161 
176 kFsFx(kStatus) kPipe_AddBlock(kPipe pipe, const kChar* typeName, const kChar* name, kBlock* block);
177 
186 kFsFx(kStatus) kPipe_DeleteBlock(kPipe pipe, kBlock block);
187 
195 kFsFx(kSize) kPipe_BlockCount(kPipe pipe);
196 
205 kFsFx(kBlock) kPipe_BlockAt(kPipe pipe, kSize index);
206 
214 kFsFx(kSize) kPipe_UserBlockCount(kPipe pipe);
215 
224 kFsFx(kBlock) kPipe_UserBlockAt(kPipe pipe, kSize index);
225 
235 kFsFx(kStatus) kPipe_SwapUserBlocks(kPipe pipe, kSize index0, kSize index1);
236 
249 kFsFx(kStatus) kPipe_AddRoute(kPipe pipe, k32u sourceBlock, k32u sourcePort, k32u destBlock, k32u destPort, kRoute* route);
250 
261 kFsFx(kStatus) kPipe_AddRoutePoints(kPipe pipe, const kRoutePoint* source, const kRoutePoint* destination, kRoute* route);
262 
275 kFsFx(kStatus) kPipe_AddRouteStr(kPipe pipe, const kChar* sourceBlock, const kChar* sourcePort, const kChar* destBlock, const kChar* destPort, kRoute* route);
276 
287 kFsFx(kStatus) kPipe_ResolveRoutePoint(kPipe pipe, const kChar* blockName, const kChar* portName, kRoutePoint* routePoint);
288 
298 kFsFx(kStatus) kPipe_ResolveBlock(kPipe pipe, const kChar* blockName, kBlock* block);
299 
309 kFsFx(kStatus) kPipe_ResolveBlockById(kPipe pipe, k32u id, kBlock* block);
310 
321 kFsFx(kStatus) kPipe_ResolvePort(kPipe pipe, const kChar* blockName, const kChar* portName, kPort* port);
322 
331 kFsFx(kStatus) kPipe_DeleteRoute(kPipe pipe, kRoute route);
332 
340 kFsFx(kStatus) kPipe_ClearRoutes(kPipe pipe);
341 
349 kFsFx(kSize) kPipe_RouteCount(kPipe pipe);
350 
359 kFsFx(kRoute) kPipe_RouteAt(kPipe pipe, kSize index);
360 
361 kEndHeader()
362 
363 #include <kFireSync/Client/kPipe.x.h>
364 
365 #endif
kPipe::kPipe_DeleteBlock
kStatus kPipe_DeleteBlock(kPipe pipe, kBlock block)
Destroys the specified block and removes it from the pipe's block list.
kPipe::kPipe_ResolvePort
kStatus kPipe_ResolvePort(kPipe pipe, const kChar *blockName, const kChar *portName, kPort *port)
Finds a port instance by name.
kPipe::kPipe_TypeDescriptionAt
const kChar * kPipe_TypeDescriptionAt(kPipe pipe, kSize index)
Gets a description of the block type at the specified index.
kPipe::kPipe_UserBlockCount
kSize kPipe_UserBlockCount(kPipe pipe)
Gets the number of user-created blocks belonging to the pipe.
kPipe::kPipe_ResolveBlock
kStatus kPipe_ResolveBlock(kPipe pipe, const kChar *blockName, kBlock *block)
Finds a block instance by name.
kPipe::kPipe_AddRoutePoints
kStatus kPipe_AddRoutePoints(kPipe pipe, const kRoutePoint *source, const kRoutePoint *destination, kRoute *route)
Adds a message route to the pipe.
kPipe::kPipe_RouteCount
kSize kPipe_RouteCount(kPipe pipe)
Returns the number of routes in the pipe.
kPipe::kPipe_SetEngine
kStatus kPipe_SetEngine(kPipe pipe, kPipeEngine type)
Sets the pipe processing engine type.
kPipe
Represents pipe configuration.
kPipe::kPipe_AddRouteStr
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.
kPipe::kPipe_ThreadCount
kSize kPipe_ThreadCount(kPipe pipe)
Gets the desired number of threads used by the pipe engine.
kPipe::kPipe_DeleteRoute
kStatus kPipe_DeleteRoute(kPipe pipe, kRoute route)
Removes a message route from the pipe.
kInfoBits
Represents constraint and validity information for a bit flag setting.
Definition: kInfo.h:454
kPipe::kPipe_MaxQueueCount
kSize kPipe_MaxQueueCount(kPipe pipe)
Gets the maximum count of the pipe's message input queue.
kPipe::kPipe_SetMaxQueueCount
kStatus kPipe_SetMaxQueueCount(kPipe pipe, kSize count)
Sets the maximum count for the pipe's message input queue.
kNodeDef.h
Essential declarations related to FireSync nodes.
kPipe::kPipe_UserBlockAt
kBlock kPipe_UserBlockAt(kPipe pipe, kSize index)
Gets the user-created block at the specified index.
kPipe::kPipe_BlockCount
kSize kPipe_BlockCount(kPipe pipe)
Gets the total number of blocks belonging to the pipe (including system and user blocks).
kPipe::kPipe_Engine
kPipeEngine kPipe_Engine(kPipe pipe)
Gets the pipe processing engine type.
kPipe::kPipe_TypeCount
kSize kPipe_TypeCount(kPipe pipe)
Gets the number of block types currently available on this node.
kPipe::kPipe_SetThreadCount
kStatus kPipe_SetThreadCount(kPipe pipe, kSize count)
Sets the desired number of threads used by the pipe engine.
kPipe::kPipe_ResolveBlockById
kStatus kPipe_ResolveBlockById(kPipe pipe, k32u id, kBlock *block)
Finds a block instance by id.
kPipe::kPipe_ResolveRoutePoint
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.
kPipe::kPipe_ClearRoutes
kStatus kPipe_ClearRoutes(kPipe pipe)
Removes all message routes from the pipe.
kPipe::kPipe_AddBlock
kStatus kPipe_AddBlock(kPipe pipe, const kChar *typeName, const kChar *name, kBlock *block)
Creates and adds a new block to the pipe.
kPort
Represents port configuration.
kPipe::kPipe_MaxQueueSize
kSize kPipe_MaxQueueSize(kPipe pipe)
Gets the maximum total data size of the pipe's message input queue.
kPipe::kPipe_SwapUserBlocks
kStatus kPipe_SwapUserBlocks(kPipe pipe, kSize index0, kSize index1)
Swaps the order of two user blocks in the pipe's user block list.
kPipe::kPipe_EngineInfo
kStatus kPipe_EngineInfo(kPipe pipe, kInfoBits *info)
Reports constraint and validity information for the Engine setting.
kPipe::kPipe_SetMaxQueueSize
kStatus kPipe_SetMaxQueueSize(kPipe pipe, kSize size)
Sets the maximum total data size for the pipe's message input queue.
kPipe::kPipe_BlockAt
kBlock kPipe_BlockAt(kPipe pipe, kSize index)
Gets the block at the specified index.
kBlock
Represents block configuration.
kRoute
Represents configuration for a pipe message route.
kPipe::kPipe_TypeNameAt
const kChar * kPipe_TypeNameAt(kPipe pipe, kSize index)
Gets the name of the block type at the specified index.
kPipe::kPipe_RouteAt
kRoute kPipe_RouteAt(kPipe pipe, kSize index)
Gets the route at the specified index.
kInfoSize
Represents constraint and validity information for a kSize setting.
Definition: kInfo.h:295
kPipe::kPipe_AddRoute
kStatus kPipe_AddRoute(kPipe pipe, k32u sourceBlock, k32u sourcePort, k32u destBlock, k32u destPort, kRoute *route)
Adds a message route to the pipe.
kRoutePoint
Represents a source or destination endpoint address for a pipe data route.
Definition: kNodeDef.h:1516
kPipe::kPipe_ThreadCountInfo
kStatus kPipe_ThreadCountInfo(kPipe pipe, kInfoSize *info)
Reports constraint and validity information for the ThreadCount setting.
kPipe::kPipe_Clear
kStatus kPipe_Clear(kPipe pipe)
Resets pipe mode settings to defaults.
kPipeEngine
Represents the type of data processing engine used in a kPipe instance.