FireSync API
 All Classes Files Functions Variables Typedefs Friends Macros Modules Pages
kStatus kPxBlock_EnableQueuedInputs ( kPxBlock  block,
kBool  enabled 
)

Enables the use of queued input ports.

By default, input messages are passed directly to the kPxBlock_OnReceive handler. Alternatively, the kPxBlock_EnableQueuedInputs function can be used to enable message queues on each input port. In this case, the 'msg' argument passed to the kPxBlock_OnReceive will be null. Queued inputs can be traversed using the kPxPort_MessageCount, kPxPort_MessageAt, and kPxPort_MessageSourceAt functions. Queued inputs can be accepted using the kPxPort_RemoveMessage function.

When queued inputs are enabled, it is the block's responsibility to eventually process queued inputs – there are no automatic limits to constrain the amount of enqueued data. However, any unprocessed messages will be destroyed if the block is paused or stopped.

This method can be called only from within a block's OnSetup method.

Parameters
blockBlock object.
enabledkTRUE to enabled queued ports; kFALSE otherwise.
Returns
Operation status.