cniRun

This function declares the node as an input node. It is not used by message processing or output nodes, and you do not need to call cniEvaluate. WebSphere Business Integration Message Broker allocates a thread and invokes this function on that thread.

Defined In Type Member
CNI_VFT Conditional iFpRun

This function is called by the broker as part of a loop. The meaning of the return value is as shown below.

Return values

CCI_TIMEOUT
The input node did not receive its input data and it requires that control be returned to WebSphere Business Integration Message Broker in case message flow reconfiguration is being requested. A user-defined input node should return reasonably frequently to give control back to WebSphere Business Integration Message Broker.
CCI_SUCCESS_CONTINUE
A message was successfully processed. Default transaction commit processing is performed by WebSphere Business Integration Message Broker. The input node's cniRun implementation function is called immediately so that the node can continue processing.
CCI_SUCCESS_RETURN
A message has been successfully processed. Default transaction commit processing is performed by WebSphere Business Integration Message Broker. The input node has determined that the thread is not required and it is returned to the message flow thread pool. If this is performed on the only thread, or the last active thread, WebSphere Business Integration Message Broker prevents this last thread being returned to the pool, otherwise there would be no other active threads that can dispatch another thread. In this situation, WebSphere Business Integration Message Broker invokes the cniRun implementation function immediately, as if CCI_SUCCESS_CONTINUE was returned.
CCI_FAILURE_CONTINUE
An error was detected in the processing of a message and the node is requesting that transaction rollback processing is performed. The input node's cniRun implementation function is called immediately.
CCI_FAILURE_RETURN
An error was detected in the processing of a message, and the node is requesting that transaction rollback processing is performed. However, the input node has determined that the thread is not required and it can be returned to the message flow thread pool. If this is performed on the last active thread, WebSphere Business Integration Message Broker prevents this last thread being returned to the pool, otherwise there would be no other active threads that can dispatch another thread. In this situation WebSphere Business Integration Message Broker invokes the cniRun implementation function immediately, as if CCI_FAILURE_CONTINUE was returned.
Related concepts
User-defined Input nodes