net::zmq Namespace Reference

Classes
class	terminate
	Calls zmq_term. More...
struct	close
	Calls zmq_close. More...

Typedefs
using	context = std::unique_ptr<void, terminate>
	Unique ZMQ context handle, calls zmq_term on destruction.
using	socket = std::unique_ptr<void, close>
	Unique ZMQ socket handle, calls zmq_close on destruction.

Functions
const std::error_category &	error_category () noexcept
expect< std::string >	receive (void *const socket, const int flags)
expect< void >	send (const epee::span< const std::uint8_t > payload, void *const socket, const int flags) noexcept
std::error_code	make_error_code (int code) noexcept
std::error_code	get_error_code () noexcept

Typedef Documentation

context

using net::zmq::context = std::unique_ptr<void, terminate>

Unique ZMQ context handle, calls zmq_term on destruction.

Definition at line 98 of file zmq.h.

socket

using net::zmq::socket = std::unique_ptr<void, close>

Unique ZMQ socket handle, calls zmq_close on destruction.

Definition at line 101 of file zmq.h.

Function Documentation

error_category()

const std::error_category & net::zmq::error_category ( )

noexcept

Returns

Category for ZMQ errors.

Definition at line 40 of file zmq.cpp.

        {
          struct category final : std::error_category
          {
              virtual const char* name() const noexcept override final
              {
                return "error::error_category()";
              }
 
              virtual std::string message(int value) const override final
              {
                char const* const msg = zmq_strerror(value);
                if (msg)
                  return msg;
                return "zmq_strerror failure";
              }
 
              virtual std::error_condition default_error_condition(int value) const noexcept override final
              {
                // maps specific errors to generic `std::errc` cases.
                switch (value)
                {
                  case EFSM:
                  case ETERM:
                    break;
                  default:
                    /* zmq is using cerrno errors. C++ spec indicates that
                       `std::errc` values must be identical to the cerrno value.
                       So just map every zmq specific error to the generic errc
                       equivalent. zmq extensions must be in the switch or they
                       map to a non-existent errc enum value. */
                    return std::errc(value);
                }
                return std::error_condition{value, *this};
              }
 
          };
          static const category instance{};
          return instance;
        }

Here is the call graph for this function:

Here is the caller graph for this function:

get_error_code()

std::error_code net::zmq::get_error_code ( )

inlinenoexcept

Returns

Error from zmq_errno() using net::zmq::error_category().

Definition at line 70 of file zmq.h.

        {
          return make_error_code(zmq_errno());
        }

Here is the call graph for this function:

make_error_code()

std::error_code net::zmq::make_error_code ( int code )

inlinenoexcept

Returns

code (usally from zmq_errno()) using net::zmq::error_category()`.

Definition at line 64 of file zmq.h.

        {
          return std::error_code{code, error_category()};
        }

Here is the call graph for this function:

Here is the caller graph for this function:

receive()

expect< std::string > net::zmq::receive	(	void *	socket,
		int	flags = 0 )

Read all parts of the next message on socket. Blocks until the entire next message (all parts) are read, or until zmq_term is called on the zmq_context associated with socket. If the context is terminated, make_error_code(ETERM) is returned.

Note

This will automatically retry on EINTR, so exiting on interrupts requires context termination.

If non-blocking behavior is requested on socket or by flags, then net::zmq::make_error_code(EAGAIN) will be returned if this would block.

Parameters

socket	Handle created with zmq_socket.
flags	See zmq_msg_read for possible flags.

Returns

Message payload read from socket or ZMQ error.

Definition at line 175 of file zmq.cpp.

        {
          std::string payload{};
          ELECTRONEUM_CHECK(retry_op(do_receive{}, payload, socket, flags));
          return {std::move(payload)};
        }

Here is the caller graph for this function:

send()

expect< void > net::zmq::send ( epee::span< const std::uint8_t > payload, void * socket, int flags = 0 )

noexcept

Sends payload on socket. Blocks until the entire message is queued for sending, or until zmq_term is called on the zmq_context associated with socket. If the context is terminated, make_error_code(ETERM) is returned.

Note

This will automatically retry on EINTR, so exiting on interrupts requires context termination.

If non-blocking behavior is requested on socket or by flags, then net::zmq::make_error_code(EAGAIN) will be returned if this would block.

Parameters

payload	sent as one message on socket.
socket	Handle created with zmq_socket.
flags	See zmq_send for possible flags.

Returns

success() if sent, otherwise ZMQ error.

Definition at line 182 of file zmq.cpp.

        {
          return retry_op(zmq_send, socket, payload.data(), payload.size(), flags);
        }

Here is the caller graph for this function: