8 #ifndef K_FIRESYNC_PX_BLOCK_H
9 #define K_FIRESYNC_PX_BLOCK_H
501 #include <kFireSync/Pipe/kPxBlock.x.h>
kXml kPxBlock_Settings(kPxBlock block)
Returns the block's internal settings.
Represents a kPxBlock port.
kStatus kPxBlock_OnSetup(kPxBlock block)
Virtual method that can be overridden to perform custom block setup.
kStatus kPxBlock_SetSendHandler(kPxBlock block, kCallbackFx function, kPointer receiver)
Sets a callback to receive messages sent by this block.
kStatus kPxBlock_Setup(kPxBlock block)
Executes a block's OnSetup method.
Represents information about the source of a pipe message.
Definition: kNodeDef.h:2160
kStatus kPxBlock_DefineInput(kPxBlock block, const kChar *name, k32u id, kPxPort *port)
Defines an input port for a block.
kPxPort kPxBlock_PortAt(kPxBlock block, kSize index)
Gets the port at the specified index.
kStatus kPxBlock_Send(kPxBlock block, kPxPort port, kMsgSet msg)
Sends a message on a specific port.
kStatus kPxBlock_Printf(kPxBlock block, const kChar *format,...)
Prints a diagnostic message.
kStatus kPxBlock_Process(kPxBlock block, kPxPort port, kMsgInfo msgInfo)
Executes a block's OnReceive method.
k32u kPxBlock_Id(kPxBlock block)
Gets the unique numeric identifier for this block instance.
Represents an object that provides external services to a pipe execution engine.
kSize kPxBlock_PortCount(kPxBlock block)
Gets the number of ports belonging to the block.
kMsgSource kPxBlock_Sender(kPxBlock block)
Returns information about the source of the message currently being processed.
kStatus kPxBlock_OnReceive(kPxBlock block, kPxPort port, kMsgSet msg)
Virtual method that can be overridden to perform custom actions when a messages is received...
kStatus kPxBlock_Resume(kPxBlock block)
Executes a block's OnResume method.
const kChar * kPxBlock_Name(kPxBlock block)
Gets a descriptive name for the block instance.
kStatus kPxBlock_SetDropHandler(kPxBlock block, kCallbackFx function, kPointer receiver)
Sets a callback to provide notifications when this block drops a message.
kStatus kPxBlock_Start(kPxBlock block)
Executes a block's OnStart method.
Essential declarations related to FireSync nodes.
Abstract base class for pipe block implementations.
kStatus kPxBlock_Stop(kPxBlock block)
Executes a block's OnStop method.
kHealth kPxBlock_Health(kPxBlock block)
Gets a health service provider that can be used when constructing health or profiling probes...
kStatus kPxBlock_NotifyDrop(kPxBlock block)
Notifies the processing environment that this block has dropped data.
k32u kPxBlock_GroupId(kPxBlock block)
Gets the processing group id associated with this block.
Base class for a health statistics collection service.
kStatus kPxBlock_Construct(kPxBlock *block, kType type, const kChar *name, k32u nodeId, k32u blockId, kPxEnviron pipeEnviron, kAlloc allocator)
Factory constructor for block objects.
kStatus kPxBlock_OnPause(kPxBlock block)
Virtual method that can be overridden to perform custom actions when a block is paused.
kStatus kPxBlock_FindPort(kPxBlock block, k32u id, kPxPort *port)
Finds the port object corresponding to the given id.
kStatus kPxBlock_FilePath(kPxBlock block, const kChar *fileName, kChar *filePath, kSize capacity)
Gets the full path for a given file name used by this block.
kAlloc kPxBlock_MessageAlloc(kPxBlock block)
Gets an allocator that should be used to construct output messages.
kBool kPxBlock_HasAllInputs(kPxBlock block)
For blocks with queued inputs, reports whether each input has at least one message avaiable...
k64u kPxBlock_Timestamp(kPxBlock block)
Within an embedded node environment, this method can be used to access the current FireSync synchnron...
kStatus kPxBlock_Pause(kPxBlock block)
Executes a block's OnPause method.
kStatus kPxBlock_OnResume(kPxBlock block)
Virtual method that can be overridden to perform custom actions when a block is resumed.
const kChar * kPxBlock_Description(kType type)
Given a kPxBlock subclass type, gets a description of the class.
Abstract base class for FireSync data messages.
kBool kPxBlock_IsGrouped(kPxBlock block)
Reports whether this block is assigned to a processing group.
kStatus kPxBlock_OnStart(kPxBlock block)
Virtual method that can be overridden to perform custom actions when a block is started.
kStatus kPxBlock_FindVariable(kPxBlock block, const kChar *name, kObject *object)
Gets a reference to a named object.
kStatus kPxBlock_EnableQueuedInputs(kPxBlock block, kBool enabled)
Enables the use of queued input ports.
kStatus kPxBlock_OnStop(kPxBlock block)
Virtual method that can be overridden to perform custom actions when a block is stopped.
Represents message source information and an attached message.
kStatus kPxBlock_AssignGroup(kPxBlock block, k32u groupId)
Assigns this block to a processing group.
kStatus kPxBlock_DefineOutput(kPxBlock block, const kChar *name, k32u id, kPxPort *port)
Defines an output port for a block.
