cryptonote::rpc::ZmqServer Class Reference

#include <zmq_server.h>

Public Member Functions
	ZmqServer (RpcHandler &h)
	~ZmqServer ()
void	serve ()
bool	addIPCSocket (boost::string_ref address, boost::string_ref port)
bool	addTCPSocket (boost::string_ref address, boost::string_ref port)
void	run ()
void	stop ()

Static Public Member Functions
static void	init_options (boost::program_options::options_description &desc)

Detailed Description

Definition at line 45 of file zmq_server.h.

Constructor & Destructor Documentation

ZmqServer()

cryptonote::rpc::ZmqServer::ZmqServer

(

RpcHandler &

h

)

Definition at line 48 of file zmq_server.cpp.

                                  :
    handler(h),
    context(zmq_init(num_zmq_threads))
{
  if (!context)
    ELECTRONEUM_ZMQ_THROW("Unable to create ZMQ context");
}

~ZmqServer()

cryptonote::rpc::ZmqServer::~ZmqServer

(

)

Definition at line 56 of file zmq_server.cpp.

{
}

Member Function Documentation

addIPCSocket()

bool cryptonote::rpc::ZmqServer::addIPCSocket	(	boost::string_ref	address,
		boost::string_ref	port )

Definition at line 97 of file zmq_server.cpp.

{
  MERROR("ZmqServer::addIPCSocket not yet implemented!");
  return false;
}

addTCPSocket()

bool cryptonote::rpc::ZmqServer::addTCPSocket	(	boost::string_ref	address,
		boost::string_ref	port )

Definition at line 103 of file zmq_server.cpp.

{
  if (!context)
  {
    MERROR("ZMQ RPC Server already shutdown");
    return false;
  }
 
  rep_socket.reset(zmq_socket(context.get(), ZMQ_REP));
  if (!rep_socket)
  {
    ELECTRONEUM_LOG_ZMQ_ERROR("ZMQ RPC Server socket create failed");
    return false;
  }
 
  if (zmq_setsockopt(rep_socket.get(), ZMQ_MAXMSGSIZE, std::addressof(max_message_size), sizeof(max_message_size)) != 0)
  {
    ELECTRONEUM_LOG_ZMQ_ERROR("Failed to set maximum incoming message size");
    return false;
  }
 
  static constexpr const int linger_value = std::chrono::milliseconds{linger_timeout}.count();
  if (zmq_setsockopt(rep_socket.get(), ZMQ_LINGER, std::addressof(linger_value), sizeof(linger_value)) != 0)
  {
    ELECTRONEUM_LOG_ZMQ_ERROR("Failed to set linger timeout");
    return false;
  }
 
  if (address.empty())
    address = "*";
  if (port.empty())
    port = "*";
 
  std::string bind_address = "tcp://";
  bind_address.append(address.data(), address.size());
  bind_address += ":";
  bind_address.append(port.data(), port.size());
 
  if (zmq_bind(rep_socket.get(), bind_address.c_str()) < 0)
  {
    ELECTRONEUM_LOG_ZMQ_ERROR("ZMQ RPC Server bind failed");
    return false;
  }
  return true;
}

Here is the caller graph for this function:

init_options()

void cryptonote::rpc::ZmqServer::init_options ( boost::program_options::options_description & desc )

static

run()

void cryptonote::rpc::ZmqServer::run

(

)

Definition at line 149 of file zmq_server.cpp.

{
  run_thread = boost::thread(boost::bind(&ZmqServer::serve, this));
}

Here is the call graph for this function:

Here is the caller graph for this function:

serve()

void cryptonote::rpc::ZmqServer::serve

(

)

Definition at line 60 of file zmq_server.cpp.

{
  try
  {
    // socket must close before `zmq_term` will exit.
    const net::zmq::socket socket = std::move(rep_socket);
    if (!socket)
    {
      MERROR("ZMQ RPC server reply socket is null");
      return;
    }
 
    while (1)
    {
      const std::string message = ELECTRONEUM_UNWRAP(net::zmq::receive(socket.get()));
      MDEBUG("Received RPC request: \"" << message << "\"");
      const std::string& response = handler.handle(message);
 
      ELECTRONEUM_UNWRAP(net::zmq::send(epee::strspan<std::uint8_t>(response), socket.get()));
      MDEBUG("Sent RPC reply: \"" << response << "\"");
    }
  }
  catch (const std::system_error& e)
  {
    if (e.code() != net::zmq::make_error_code(ETERM))
      MERROR("ZMQ RPC Server Error: " << e.what());
  }
  catch (const std::exception& e)
  {
    MERROR("ZMQ RPC Server Error: " << e.what());
  }
  catch (...)
  {
    MERROR("Unknown error in ZMQ RPC server");
  }
}

Here is the call graph for this function:

Here is the caller graph for this function:

stop()

void cryptonote::rpc::ZmqServer::stop

(

)

Definition at line 154 of file zmq_server.cpp.

{
  if (!run_thread.joinable())
    return;
 
  context.reset(); // destroying context terminates all calls
  run_thread.join();
}

Here is the caller graph for this function:

---

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

• /home/abuild/rpmbuild/BUILD/electroneum-5.1.3.1-build/electroneum-5.1.3.1/src/rpc/zmq_server.h
• /home/abuild/rpmbuild/BUILD/electroneum-5.1.3.1-build/electroneum-5.1.3.1/src/rpc/zmq_server.cpp