nng_ctx_send()

NAME

nng_ctx_send — send message using context asynchronously

SYNOPSIS

#include <nng/nng.h>

void nng_ctx_send(nng_ctx ctx, nng_aio *aio);

DESCRIPTION

The nng_ctx_send() sends a message using the context ctx asynchronously.

The message to send must have previously been set on the aio using the nng_aio_set_msg() function. The function assumes ownership of the message.

If the message was successfully queued for delivery to the socket, then the aio will be completed, and nng_aio_result() will return zero. In this case the socket will dispose of the message when it is finished with it.

note

The operation will be completed, and the callback associated with the aio executed, as soon as the socket accepts the message for sending. This does not indicate that the message was actually delivered, as it may still be buffered in the sending socket, buffered in the receiving socket, or in flight over physical media.

If the operation fails for any reason (including cancellation or timeout), then the aio callback will be executed and nng_aio_result() will return a non-zero error status. In this case, the callback has a responsibility to retrieve the message from the aio with nng_aio_get_msg() and dispose of it appropriately. (This may include retrying the send operation on the same or a different socket, or deallocating the message with nng_msg_free().

tip

The semantics of what sending a message means varies from protocol to protocol, so examination of the protocol documentation is encouraged.

ERRORS

  • NNG_ECANCELED: The operation was aborted.
  • NNG_ECLOSED: The context ctx is not open.
  • NNG_EMSGSIZE: The message is too large.
  • NNG_ENOMEM: Insufficient memory is available.
  • NNG_ENOTSUP: The protocol for context ctx does not support sending.
  • NNG_ESTATE: The context ctx cannot send data in this state.
  • NNG_ETIMEDOUT: The send timeout expired.

SEE ALSO

nng_aio_get_msg(), nng_aio_set_msg(), nng_ctx_sendmsg(), nng_msg_alloc(), nng_msg_alloc(), nng_aio, nng_ctx, nng_msg