tt_message_state - retrieve the state attribute from a message
#include <Tt/tt_c.h> Tt_state tt_message_state(Tt_message m);
tt_message_state(3) ToolTalk Functions tt_message_state(3) NAME tt_message_state - retrieve the state attribute from a message SYNOPSIS #include <Tt/tt_c.h> Tt_state tt_message_state(Tt_message m); DESCRIPTION The tt_message_state() function retrieves the state attribute from the specified message. The m argument is the opaque handle for the message involved in this operation. RETURN VALUE Upon successful completion, the tt_message_state() function returns a value that indicates the current delivery state of the message. The tt_message_state() function returns one of the following Tt_status val- ues: TT_CREATED The message has been created, but not yet sent. TT_SENT The message has been sent, but not yet handled. TT_HANDLED The message has been handled; return values are valid. TT_FAILED The message could not be delivered to a handler. TT_QUEUED The message has been queued for delivery. TT_STARTED The ToolTalk service is attempting to start a process to handle the message. TT_REJECTED The message has been rejected by a possible handler. TT_RETURNED all observers (and the handler, if there is one) have accepted, rejected, or destroyed the TT_OFFER. The original sender sees this state, and it can be observed. This comes back to the original sender like the reply for a request. In particular, any message callbacks for the offer are run, and user data attached to the message before send- ing are available. TT_ACCEPTED Offers (only) enter this state when tt_message_accept is done on them by a receiver. The state is seen only by the receiver. TT_REJECTED This state already exists; a receiver can tt_message_reject a request that matched a handle pattern, which puts the mes- sage into state TT_REJECTED for it. This will be extended to offers -- a receiver that gets an offer will see this message in the TT_REJECTED state. TT_ABSTAINED Offers (only) enter this state when a receiving procid does the next tt_message_receive without accepting or rejecting the offer. One can think of TT_ABSTAINED also being entered when a procid destroys an offer without accepting or reject- ing it, but since the message is destroyed at that time the procid will never see the state. This state is seen only by the receiver. The application can use tt_int_error(3) to extract one of the following Tt_status values from the Tt_state integer return value: TT_OK The operation completed successfully. TT_ERR_NOMP The ttsession(1) process is not running and the ToolTalk service cannot restart it. TT_ERR_POINTER The pointer passed does not point to an object of the cor- rect type for this operation. ATTRIBUTES See attributes(7) for descriptions of the following attributes: +---------------+------------------+ |ATTRIBUTE TYPE | ATTRIBUTE VALUE | +---------------+------------------+ |Availability | library/tooltalk | +---------------+------------------+ |Stability | Committed | +---------------+------------------+ SEE ALSO tt_c(5), tt_int_error(3). ToolTalk 1.3 1 March 1996 tt_message_state(3)