Table of Contents

Name

imme_enqueue - Enqueues a message

Synopsis

#include <imta.h>

int imme_enqueue( imme_t me);

Description

The final step in the process of enqueuing a message handled by the enqueue context me is to call imme_enqueue(). This call enqueues the message to the destination channel(s) determined by the configured routing from the recipient address(es) specified with imme_add_recipient().

If an error occurs, the message is not submitted. A new message may be created with a new call to imme_start_envelope().

Return Values

imme_enqueue() returns IMRC_OK when successful. Otherwise the message is not enqueued and one of the following error code otherwise.

IMRC_BAD_CONTEXT
The enqueue context me has not been initialized or has been corrupted. Make sure imme_init() has been previously called.
IMRC_NO_ENVELOPE
The message envelope has not been created. Call imme_start_envelope() to create it.
IMRC_INSUFFICIENT_PRIVILEGES
The caller has insufficient privileges to write to the queue directories, or the system ran out of disk space. The message is not enqueued, but the enqueue context for this message is still valid. It can be removed by calling imme_abort().
IMRC_NO_RECIPIENT
No envelope recipient has been specified. The message is discarded.

A textual explanation of the failure can be obtained by calling imta_error() immediately afterwards.

Attributes

_______________________________________
Attribute Type
Attribute Value _______________________________________
Architecture
sparc, x86 _______________________________________
Availability
SUNWimsdk _______________________________________
MT-Level
MT-Safe _______________________________________
Interface Stability
Stable _______________________________________ |
|
|

See Also

imme_init(3) , imme_add_recipient(3) , imta_error(3) , imme_abort(3)

Table of Contents