pars::net::socket Class Reference

Represents an nng_socket. More...

#include <socket.h>

Public Member Functions
	socket (ev::enqueuer &r, nngxx::socket &&s)
	Construct a socket.
	~socket ()
	operator tool_view ()
void	set_options (const socket_opt opts)
socket_opt	options () const
void	dial (const char *addr)
void	listen (const char *addr)
void	connect (const char *addr, const cmode mode)
nngxx::ctx	make_ctx ()
void	send_aio (nngxx::aio_view &a)
void	recv_aio (nngxx::aio_view &a)
template<ev::event_c event_t>
void	send (event_t ev, pipe p={})
void	recv ()
void	stop ()
int	id () const
int	socket_id () const
const char *	proto_name () const
auto	format_to (std::format_context &ctx) const -> decltype(ctx.out())

Detailed Description

Represents an nng_socket.

Definition at line 70 of file socket.h.

Constructor & Destructor Documentation

socket()

pars::net::socket::socket ( ev::enqueuer & r, nngxx::socket && s )

inline

Construct a socket.

Definition at line 74 of file socket.h.

    : router_m{r}
    , socket_m{std::move(s)}
  {
    register_pipe_notify();
  }

~socket()

pars::net::socket::~socket ( )

inline

Definition at line 81 of file socket.h.

{ stop(); }

References stop().

Here is the call graph for this function:

Member Function Documentation

connect()

void pars::net::socket::connect ( const char * addr, const cmode mode )

inline

Definition at line 114 of file socket.h.

  {
    switch (mode)
    {
    case cmode::dial:
      dial(addr);
 
      break;
    case cmode::listen:
      listen(addr);
 
      break;
    }
  }

References pars::net::dial, and pars::net::listen.

dial()

void pars::net::socket::dial ( const char * addr )

inline

Definition at line 110 of file socket.h.

{ emplace_dialer(addr).start().or_abort(); }

format_to()

auto pars::net::socket::format_to ( std::format_context & ctx ) const -> decltype(ctx.out())

inline

Definition at line 154 of file socket.h.

  {
    return std::format_to(ctx.out(), "Socket #{}-{}", id(), proto_name());
  }

References proto_name().

Here is the call graph for this function:

id()

int pars::net::socket::id ( ) const

inline

Definition at line 145 of file socket.h.

{ return socket_m.id(); }

Referenced by socket_id().

Here is the caller graph for this function:

listen()

void pars::net::socket::listen ( const char * addr )

inline

Definition at line 112 of file socket.h.

{ emplace_listener(addr).start().or_abort(); }

make_ctx()

nngxx::ctx pars::net::socket::make_ctx ( )

inline

Definition at line 129 of file socket.h.

{ return nngxx::make_ctx(socket_m).value_or_abort(); }

operator tool_view()

pars::net::socket::operator tool_view ( )

inline

Definition at line 83 of file socket.h.

{ return tool_view{socket_m}; }

options()

socket_opt pars::net::socket::options ( ) const

inline

Definition at line 100 of file socket.h.

  {
    return {
      .recv_timeout = socket_m.get_recv_timeout().value_or_abort(),
      .send_timeout = socket_m.get_send_timeout().value_or_abort(),
      .req_resend_time = socket_m.get_req_resend_time().value_or_abort(),
      .req_resend_tick = socket_m.get_req_resend_tick().value_or_abort(),
    };
  }

proto_name()

const char * pars::net::socket::proto_name ( ) const

inline

Definition at line 149 of file socket.h.

  {
    return socket_m.proto_name().value_or("<not-found>");
  }

Referenced by format_to().

Here is the caller graph for this function:

recv()

void pars::net::socket::recv ( )

inline

Definition at line 141 of file socket.h.

{ op_m.recv(router_m, *this); }

recv_aio()

void pars::net::socket::recv_aio ( nngxx::aio_view & a )

inline

Definition at line 133 of file socket.h.

{ socket_m.recv(a); }

send()

template<ev::event_c event_t>

void pars::net::socket::send ( event_t ev, pipe p = {} )

inline

Definition at line 136 of file socket.h.

                                 {})
  {
    op_m.send(router_m, *this, p, ev);
  }

send_aio()

void pars::net::socket::send_aio ( nngxx::aio_view & a )

inline

Definition at line 131 of file socket.h.

{ socket_m.send(a); }

set_options()

void pars::net::socket::set_options ( const socket_opt opts )

inline

Definition at line 85 of file socket.h.

  {
    if (opts.recv_timeout)
      socket_m.set_recv_timeout(*opts.recv_timeout).or_abort();
 
    if (opts.send_timeout)
      socket_m.set_send_timeout(*opts.send_timeout).or_abort();
 
    if (opts.req_resend_time)
      socket_m.set_req_resend_time(*opts.req_resend_time).or_abort();
 
    if (opts.req_resend_tick)
      socket_m.set_req_resend_tick(*opts.req_resend_tick).or_abort();
  }

References pars::net::socket_opt::recv_timeout, pars::net::socket_opt::req_resend_tick, pars::net::socket_opt::req_resend_time, and pars::net::socket_opt::send_timeout.

socket_id()

int pars::net::socket::socket_id ( ) const

inline

Definition at line 147 of file socket.h.

{ return id(); }

References id().

Here is the call graph for this function:

stop()

void pars::net::socket::stop ( )

inline

Definition at line 143 of file socket.h.

{ op_m.stop(); }

Referenced by ~socket().

Here is the caller graph for this function:

---

The documentation for this class was generated from the following file:

• /home/runner/work/pars-cxx/pars-cxx/lib/include/pars/net/socket.h