FireSync API
 All Classes Files Functions Variables Typedefs Friends Macros Modules Pages
kStatus kPxPort_EnableAsynchronousData ( kPxPort  port,
kBool  enable 
)

Enables an output port to emit messages asynchronously.

By default, the EmitAsynchronousData property is set to kFALSE, meaning that messages can only be emitted synchronously. In this state, attempting to send a message outside the scope of a block's OnReceive handler will result in undefined behaviour. When the EmitAsynchronousData property is set to kTRUE, messages are delivered to the pipe asynchronously, enabling messages to be sent either inside or outside of a block's OnReceive handler. Refer to the kPxBlock_Send API documentation for a more complete discussion of the rules surrounding asynchronous messaging.

Blocks that emit messages synchronously should leave this setting at its default (disabled), as synchronous processing is generally more efficient than asynchronous processing.

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

Parameters
portPort object.
enablekTRUE to enable messages to be emitted asynchronously.
Returns
Operation status.
See also
kPxBlock_Send, kPxBlock_OnEngage