jsonrpc::transport::FramedPipeTransport Class Reference

#include <framed_pipe_transport.hpp>

Inheritance diagram for jsonrpc::transport::FramedPipeTransport:

Collaboration diagram for jsonrpc::transport::FramedPipeTransport:

Public Member Functions
	FramedPipeTransport (asio::any_io_executor executor, const std::string &socket_path, bool is_server, std::shared_ptr< spdlog::logger > logger=nullptr)
auto	SendMessage (std::string message) -> asio::awaitable< std::expected< void, error::RpcError > > override
auto	ReceiveMessage () -> asio::awaitable< std::expected< std::string, error::RpcError > > override
Public Member Functions inherited from jsonrpc::transport::PipeTransport
	PipeTransport (asio::any_io_executor executor, std::string socket_path, bool is_server=false, std::shared_ptr< spdlog::logger > logger=nullptr)
	~PipeTransport () override
	PipeTransport (const PipeTransport &)=delete
auto	operator= (const PipeTransport &) -> PipeTransport &=delete
	PipeTransport (PipeTransport &&)=delete
auto	operator= (PipeTransport &&) -> PipeTransport &=delete
auto	Start () -> asio::awaitable< std::expected< void, error::RpcError > > override
auto	Close () -> asio::awaitable< std::expected< void, error::RpcError > > override
void	CloseNow () override
auto	SendMessage (std::string message) -> asio::awaitable< std::expected< void, error::RpcError > > override
auto	Flush () -> asio::awaitable< std::expected< void, error::RpcError > >
auto	ReceiveMessage () -> asio::awaitable< std::expected< std::string, error::RpcError > > override
Public Member Functions inherited from jsonrpc::transport::Transport
	Transport (asio::any_io_executor executor, std::shared_ptr< spdlog::logger > logger=nullptr)
	Transport (const Transport &)=delete
	Transport (Transport &&)=delete
auto	operator= (const Transport &) -> Transport &=delete
auto	operator= (Transport &&) -> Transport &=delete
virtual	~Transport ()=default
auto	GetExecutor () const -> asio::any_io_executor
auto	GetStrand () -> asio::strand< asio::any_io_executor > &

Additional Inherited Members
Protected Member Functions inherited from jsonrpc::transport::PipeTransport
auto	GetSocket () -> asio::local::stream_protocol::socket &
auto	RemoveExistingSocketFile () -> std::expected< void, error::RpcError >
auto	Connect () -> asio::awaitable< std::expected< void, error::RpcError > >
auto	BindAndListen () -> asio::awaitable< std::expected< void, error::RpcError > >
Protected Member Functions inherited from jsonrpc::transport::Transport
auto	Logger () -> std::shared_ptr< spdlog::logger >

Detailed Description

Definition at line 12 of file framed_pipe_transport.hpp.

Constructor & Destructor Documentation

FramedPipeTransport()

jsonrpc::transport::FramedPipeTransport::FramedPipeTransport	(	asio::any_io_executor	executor,
		const std::string &	socket_path,
		bool	is_server,
		std::shared_ptr< spdlog::logger >	logger = nullptr )

Definition at line 10 of file framed_pipe_transport.cpp.

    : PipeTransport(std::move(executor), socket_path, is_server, logger) {
}

Member Function Documentation

ReceiveMessage()

auto jsonrpc::transport::FramedPipeTransport::ReceiveMessage ( ) -> asio::awaitable<std::expected<std::string, error::RpcError>>

overridevirtual

Implements jsonrpc::transport::Transport.

Definition at line 22 of file framed_pipe_transport.cpp.

                                                            {
  while (true) {
    // Try to deframe from existing buffer
    auto result = framer_.TryDeframe(read_buffer_);
    if (result.complete) {
      read_buffer_.erase(0, result.consumed_bytes);
      co_return result.message;
    }
 
    if (!result.error.empty()) {
      Logger()->error("Framing error: {}", result.error);
      co_return RpcError::UnexpectedFromCode(
          RpcErrorCode::kTransportError, "Framing error: " + result.error);
    }
 
    // Get more data using base class receive
    auto chunk_result = co_await PipeTransport::ReceiveMessage();
    if (!chunk_result) {
      co_return chunk_result;
    }
 
    read_buffer_ += *chunk_result;  // append new data
  }
}

References jsonrpc::transport::PipeTransport::ReceiveMessage(), and jsonrpc::error::RpcError::UnexpectedFromCode().

Here is the call graph for this function:

SendMessage()

auto jsonrpc::transport::FramedPipeTransport::SendMessage ( std::string message ) -> asio::awaitable<std::expected<void, error::RpcError>>

overridevirtual

Implements jsonrpc::transport::Transport.

Definition at line 16 of file framed_pipe_transport.cpp.

                                                       {
  auto framed_message = MessageFramer::Frame(message);
  co_return co_await PipeTransport::SendMessage(std::move(framed_message));
}

References jsonrpc::transport::MessageFramer::Frame(), and jsonrpc::transport::PipeTransport::SendMessage().

Here is the call graph for this function:

---

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

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