|
FireSync API
|
Represents pipe configuration.
Public Member Functions | |
| kStatus | kPipe_AddBlock (kPipe pipe, const kChar *typeName, const kChar *name, kBlock *block) |
| Creates and adds a new block to the pipe. More... | |
| kStatus | kPipe_AddRoute (kPipe pipe, k32u sourceBlock, k32u sourcePort, k32u destBlock, k32u destPort, kRoute *route) |
| Adds a message route to the pipe. More... | |
| kStatus | kPipe_AddRoutePoints (kPipe pipe, const kRoutePoint *source, const kRoutePoint *destination, kRoute *route) |
| Adds a message route to the pipe. More... | |
| 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. More... | |
| kBlock | kPipe_BlockAt (kPipe pipe, kSize index) |
| Gets the block at the specified index. More... | |
| kSize | kPipe_BlockCount (kPipe pipe) |
| Gets the total number of blocks belonging to the pipe (including system and user blocks). More... | |
| kStatus | kPipe_Clear (kPipe pipe) |
| Resets pipe mode settings to defaults. More... | |
| kStatus | kPipe_ClearRoutes (kPipe pipe) |
| Removes all message routes from the pipe. More... | |
| kStatus | kPipe_DeleteBlock (kPipe pipe, kBlock block) |
| Destroys the specified block and removes it from the pipe's block list. More... | |
| kStatus | kPipe_DeleteRoute (kPipe pipe, kRoute route) |
| Removes a message route from the pipe. More... | |
| kStatus | kPipe_EnableTimer (kPipe pipe, kBool enable) |
| Enables the pipe timer service. More... | |
| kPipeEngine | kPipe_Engine (kPipe pipe) |
| Gets the pipe processing engine type. More... | |
| kStatus | kPipe_EngineInfo (kPipe pipe, kInfoBits *info) |
| Reports constraint and validity information for the Engine setting. More... | |
| kSize | kPipe_MaxQueueCount (kPipe pipe) |
| Gets the maximum count of the pipe's message input queue. More... | |
| kSize | kPipe_MaxQueueSize (kPipe pipe) |
| Gets the maximum total data size of the pipe's message input queue. More... | |
| kStatus | kPipe_ResolveBlock (kPipe pipe, const kChar *blockName, kBlock *block) |
| Finds a block instance by name. More... | |
| kStatus | kPipe_ResolveBlockById (kPipe pipe, k32u id, kBlock *block) |
| Finds a block instance by id. More... | |
| kStatus | kPipe_ResolvePort (kPipe pipe, const kChar *blockName, const kChar *portName, kPort *port) |
| Finds a port instance by name. More... | |
| 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. More... | |
| kRoute | kPipe_RouteAt (kPipe pipe, kSize index) |
| Gets the route at the specified index. More... | |
| kSize | kPipe_RouteCount (kPipe pipe) |
| Returns the number of routes in the pipe. More... | |
| kStatus | kPipe_SetEngine (kPipe pipe, kPipeEngine type) |
| Sets the pipe processing engine type. More... | |
| kStatus | kPipe_SetMaxQueueCount (kPipe pipe, kSize count) |
| Sets the maximum count for the pipe's message input queue. More... | |
| kStatus | kPipe_SetMaxQueueSize (kPipe pipe, kSize size) |
| Sets the maximum total data size for the pipe's message input queue. More... | |
| kStatus | kPipe_SetThreadAffinity (kPipe pipe, kBitArray affinity) |
| Sets the thread affinity for any pipe threads. More... | |
| kStatus | kPipe_SetThreadCount (kPipe pipe, kSize count) |
| Sets the desired number of threads used by the pipe engine. More... | |
| kStatus | kPipe_SetThreadPriorityClass (kPipe pipe, kThreadPriorityClass priorityClass) |
| Sets the thread priority class for any pipe threads. More... | |
| k32s | kPipe_SetThreadPriorityOffset (kPipe pipe, k32s priorityOffset) |
| Sets the thread priority offset for any pipe threads. More... | |
| kStatus | kPipe_SetTimerPeriod (kPipe pipe, k64u periodUs) |
| Sets the period for the pipe timer service. More... | |
| kStatus | kPipe_SwapUserBlocks (kPipe pipe, kSize index0, kSize index1) |
| Swaps the order of two user blocks in the pipe's user block list. More... | |
| kStatus | kPipe_ThreadAffinity (kPipe pipe, kBitArray affinity) |
| Gets the thread affinity for any pipe threads. More... | |
| kStatus | kPipe_ThreadAffinityInfo (kPipe pipe, kInfo *info) |
| Reports constraint and validity information for the ThreadAffinity setting. More... | |
| kSize | kPipe_ThreadCount (kPipe pipe) |
| Gets the desired number of threads used by the pipe engine. More... | |
| kStatus | kPipe_ThreadCountInfo (kPipe pipe, kInfoSize *info) |
| Reports constraint and validity information for the ThreadCount setting. More... | |
| kThreadPriorityClass | kPipe_ThreadPriorityClass (kPipe pipe) |
| Gets the thread priority class for any pipe threads. More... | |
| kStatus | kPipe_ThreadPriorityClassInfo (kPipe pipe, kInfo32s *info) |
| Reports constraint and validity information for the ThreadPriorityClass setting. More... | |
| k32s | kPipe_ThreadPriorityOffset (kPipe pipe) |
| Gets the thread priority offset for any pipe threads. More... | |
| kStatus | kPipe_ThreadPriorityOffsetInfo (kPipe pipe, kInfo32s *info) |
| Reports constraint and validity information for the ThreadPriorityOffset setting. More... | |
| kBool | kPipe_TimerEnabled (kPipe pipe) |
| Reports whether the pipe timer is currently enabled. More... | |
| kStatus | kPipe_TimerEnabledInfo (kPipe pipe, kInfoBool *info) |
| Reports constraint and validity information for the TimerEnabled setting. More... | |
| k64u | kPipe_TimerPeriod (kPipe pipe) |
| Reports the current period for the piper timer service. More... | |
| kStatus | kPipe_TimerPeriodInfo (kPipe pipe, kInfo64u *info) |
| Reports constraint and validity information for the TimerPeriod setting. More... | |
| kSize | kPipe_TypeCount (kPipe pipe) |
| Gets the number of block types currently available on this node. More... | |
| const kChar * | kPipe_TypeDescriptionAt (kPipe pipe, kSize index) |
| Gets a description of the block type at the specified index. More... | |
| const kChar * | kPipe_TypeNameAt (kPipe pipe, kSize index) |
| Gets the name of the block type at the specified index. More... | |
| kBlock | kPipe_UserBlockAt (kPipe pipe, kSize index) |
| Gets the user-created block at the specified index. More... | |
| kSize | kPipe_UserBlockCount (kPipe pipe) |
| Gets the number of user-created blocks belonging to the pipe. More... | |
