API Reference

Here's the reference documentation for the nanomsgxx API, it contains detailed description of each type and symbols provided by the library, as well as some code examples... enjoy!

• nnxx

  Contains most of the symbols and types

• nnxx::this_thread

  Contains symbols that have thread-local behaviors

• message

  Message abstraction for zero-copy

• message_control

  Protocol dependant control data

• message_istream

  Parse messages using standard input streams

• message_ostream

  Format messages using standard input streams

• message_streambuf

  Stream buffer for message input and output streams

• poll_entry

  Objects used to poll events on sockets

• poll_vector

  Vector of poll_entry objects

• ready_iterator

  Iterate over poll events marked as ready for reading or writing

• ready_sequence

  Proxy object generating a begin and end ready_iterator

• signal_error

  Exception thrown when an operation is interrupted by a signal

• socket

  Abstraction of nanomsg sockets

• symbol_properties

  Representation of a nanomsg symbol

• term_error

  Exception thrown when the nanomsg library is terminating

• timeout_error

  Exception thrown when an operation times out

• with_linger

  Scope-based linger timeout setter

• with_recv_timeout

  Scope-based receive timeout setter

• with_send_timeout

  Scope-based send timeout setter

• c_str

  Convert types to c-string representations

• device

  Sets up a proxy routing messages from a socket to another

• get_linger

  Gets the linger timeout on a socket

• get_recv_timeout

  Gets the receive timeout on a socket

• get_resend_interval

  Gets the resend timeout on a socket

• get_send_timeout

  Gets the send timeout on a socket

• get_surveyor_deadline

  Gets the surveyor timeout on a socket

• poll

  Polls for events available on sockets

• recv_ready

  Helper function creating a sequence of poll_entry marked as ready for receive operations

• send_ready

  Helper function creating a sequence of poll_entry marked as ready for send operations

• set_linger

  Sets the linger timeout on a socket

• set_recv_timeout

  Sets the receive timeout on a socket

• set_resend_interval

  Sets the resend timeout on a socket

• set_send_timeout

  Sets the send timeout on a socket

• set_surveyor_deadline

  Sets the surveyor timeout on a socket

• strerror

  Returns a human-readable representation of an error code

• subscribe

  Subscribe a SUB socket to a topic

• symbol

  Returns informations on a nanomsg symbol

• term

  Force all ongoing and future nanomsg operations to abort and throw a term_error

• unsubscribe

  Unsubscribes a SUB socket from a topic

• this_thread::get_errno

  Gets the current error status on the calling thread

• this_thread::get_errc

  Gets the current error status on the calling thread