tibemsMsgConsumer_ReceiveNoWait

Function

Purpose

Receive a message (synchronous, non-blocking).

C Declaration

tibems_status tibemsMsgConsumer_ReceiveNoWait(
    tibemsMsgConsumer msgConsumer,
    tibemsMsg* message);

COBOL Call

CALL "tibemsMsgConsumer_ReceiveNoWait"
     USING BY VALUE msgConsumer,
           BY REFERENCE message,
           RETURNING tibems-status
END-CALL.
Note: msgConsumer and message have usage pointer.

Parameters

Parameter Description
msgConsumer Receive a message through this consumer.
msg The function stores a pointer to the inbound message in this location.

Remarks

When the destination has at least one message ready, this function immediately returns the next message.

When the destination does not have any messages ready, this function immediately returns TIBEMS_NOT_FOUND.

When calling receive within a transaction, the consumer retains the message until transaction commits.

Note that this function should not be used if the destination property prefetch=none.