jsonrpc::transport::PipeTransport Class Reference

Transport implementation using Unix domain sockets. More...

#include <pipe_transport.hpp>

Inheritance diagram for jsonrpc::transport::PipeTransport:

Collaboration diagram for jsonrpc::transport::PipeTransport:

Public Member Functions
	PipeTransport (const std::string &socket_path, bool is_server)
	Constructs a PipeTransport.
	~PipeTransport () override
	PipeTransport (const PipeTransport &)=delete
auto	operator= (const PipeTransport &) -> PipeTransport &=delete
	PipeTransport (PipeTransport &&)=delete
auto	operator= (PipeTransport &&) -> PipeTransport &=delete
void	SendMessage (const std::string &message) override
	Sends a message in string to the transport layer.
auto	ReceiveMessage () -> std::string override
	Receives a message from the transport layer.
Public Member Functions inherited from jsonrpc::transport::Transport
	Transport ()=default
virtual	~Transport ()=default
	Transport (const Transport &)=default
auto	operator= (const Transport &) -> Transport &=default
	Transport (Transport &&)=delete
auto	operator= (Transport &&) -> Transport &=delete

Protected Member Functions
auto	GetSocket () -> asio::local::stream_protocol::socket &

Detailed Description

Transport implementation using Unix domain sockets.

This class provides transport functionality over Unix domain sockets, supporting both client and server modes for inter-process communication on the same machine.

Definition at line 17 of file pipe_transport.hpp.

Constructor & Destructor Documentation

PipeTransport() [1/3]

jsonrpc::transport::PipeTransport::PipeTransport	(	const std::string &	socket_path,
		bool	is_server )

Constructs a PipeTransport.

Parameters

socketPath	Path to the Unix domain socket.
isServer	True if the transport acts as a server; false if it acts as a client.

Definition at line 10 of file pipe_transport.cpp.

    : socket_(io_context_), socket_path_(socket_path), is_server_(is_server) {
  spdlog::info(
      "Initializing PipeTransport with socket path: {}. IsServer: {}",
      socket_path, is_server);
 
  if (is_server_) {
    RemoveExistingSocketFile();
    BindAndListen();
  } else {
    Connect();
  }
}

~PipeTransport()

jsonrpc::transport::PipeTransport::~PipeTransport ( )

override

Definition at line 28 of file pipe_transport.cpp.

                              {
  spdlog::info("Closing socket and shutting down PipeTransport.");
  socket_.close();
  io_context_.stop();
}

PipeTransport() [2/3]

jsonrpc::transport::PipeTransport::PipeTransport ( const PipeTransport & )

delete

PipeTransport() [3/3]

jsonrpc::transport::PipeTransport::PipeTransport ( PipeTransport && )

delete

Member Function Documentation

GetSocket()

auto jsonrpc::transport::PipeTransport::GetSocket ( ) -> asio::local::stream_protocol::socket &

protected

Definition at line 24 of file pipe_transport.cpp.

                                                                  {
  return socket_;
}

Referenced by jsonrpc::transport::FramedPipeTransport::SendMessage().

Here is the caller graph for this function:

operator=() [1/2]

auto jsonrpc::transport::PipeTransport::operator= ( const PipeTransport & ) -> PipeTransport &=delete

delete

operator=() [2/2]

auto jsonrpc::transport::PipeTransport::operator= ( PipeTransport && ) -> PipeTransport &=delete

delete

ReceiveMessage()

auto jsonrpc::transport::PipeTransport::ReceiveMessage ( ) -> std::string

overridevirtual

Receives a message from the transport layer.

Returns

The JSON-RPC response as a string.

Implements jsonrpc::transport::Transport.

Definition at line 81 of file pipe_transport.cpp.

                                                {
  try {
    asio::streambuf buffer;
    asio::read_until(socket_, buffer, '\n');
    std::istream is(&buffer);
    std::string message;
    std::getline(is, message);
    spdlog::debug("Received message: {}", message);
    return message;
  } catch (const std::exception &e) {
    spdlog::error("Error receiving message: {}", e.what());
    socket_.close();
    throw std::runtime_error("Error receiving message");
  }
}

SendMessage()

void jsonrpc::transport::PipeTransport::SendMessage ( const std::string & message )

overridevirtual

Sends a message in string to the transport layer.

Parameters

request

The JSON-RPC request as a string.

Implements jsonrpc::transport::Transport.

Definition at line 70 of file pipe_transport.cpp.

                                                        {
  try {
    std::string full_message = message + "\n";
    asio::write(socket_, asio::buffer(full_message));
    spdlog::debug("Sent message: {}", message);
  } catch (const std::exception &e) {
    spdlog::error("Error sending message: {}", e.what());
    throw std::runtime_error("Error sending message");
  }
}

---

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

• include/jsonrpc/transport/pipe_transport.hpp
• src/transport/pipe_transport.cpp