TT_MESSAGE_STATE(3)

πŸ“¦
version 2.5.3 Β· 2 versions
, in nixos 26.05

🌸 NAME 🌸

tt_message_state β€” retrieve the state attribute from a message

okay bestie, this is the library call page for tt_message_state, and it's literally here to pull the state attribute out of 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. That's the whole vibe. 🫢

The m argument is the opaque handle for the message involved in this operation. Opaque handle means you don't peek inside it β€” you just pass it along, no cap.


πŸ‘‘ RETURN VALUE πŸ‘‘

Upon successful completion, the tt_message_state function returns a value that indicates the current delivery state of the message. It returns one of these Tt_status values:

  • 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.

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 correct type for this operation.

🌈 SEE ALSO 🌈


πŸ’– and that's the whole library call page for tt_message_state, bestie β€” no date shown in this copy, so this is the sparkly sign-off. πŸŽ€βœ¨

πŸ“¦ where this page comes from