Class to wrap IConnection objects with template functions. More...

#include <msgpack_rpc/transport/connection_wrapper.h>

Collaboration diagram for msgpack_rpc::transport::ConnectionWrapper:

Public Types
using	ConnectionClosedCallback = IConnection::ConnectionClosedCallback
	Type of callback functions called when a connection is closed.
using	MessageReceivedCallback = IConnection::MessageReceivedCallback
	Type of callback functions called when a message is received.
using	MessageSentCallback = IConnection::MessageSentCallback
	Type of callback functions called when a message is successfully sent.

Public Member Functions
	ConnectionWrapper (std::shared_ptr< IConnection > connection) noexcept
	Constructor.
void	async_close ()
	Asynchronously close this connection.
template<typename... Parameters>
void	async_notify (messages::MethodNameView method_name, const Parameters &... parameters)
	Asynchronously send a notification.
template<typename... Parameters>
void	async_request (messages::MethodNameView method_name, messages::MessageID message_id, const Parameters &... parameters)
	Asynchronously send a request.
template<typename T>
void	async_response_error (messages::MessageID request_id, const T &error)
	Asynchronously send a response with an error.
template<typename T>
void	async_response_success (messages::MessageID request_id, const T &result)
	Asynchronously send a response without an error.
std::shared_ptr< IConnection >	connection () const noexcept
	Get the IConnection object of this wrapper.
const addresses::IAddress &	local_address () const noexcept
	Get the address of the local endpoint.
const addresses::IAddress &	remote_address () const noexcept
	Get the address of the remote endpoint.
void	start (MessageReceivedCallback on_received, MessageSentCallback on_sent, ConnectionClosedCallback on_closed)
	Start process of this connection.

Private Attributes
std::shared_ptr< IConnection >	connection_
	Connection.

Detailed Description

Class to wrap IConnection objects with template functions.

Definition at line 36 of file connection_wrapper.h.

Member Typedef Documentation

◆ ConnectionClosedCallback

using msgpack_rpc::transport::ConnectionWrapper::ConnectionClosedCallback = IConnection::ConnectionClosedCallback

Type of callback functions called when a connection is closed.

Parameters:

Status object specifying the reason.

Definition at line 60 of file connection_wrapper.h.

◆ MessageReceivedCallback

using msgpack_rpc::transport::ConnectionWrapper::MessageReceivedCallback = IConnection::MessageReceivedCallback

Type of callback functions called when a message is received.

Parameters:

Received message.

Definition at line 45 of file connection_wrapper.h.

◆ MessageSentCallback

using msgpack_rpc::transport::ConnectionWrapper::MessageSentCallback = IConnection::MessageSentCallback

Type of callback functions called when a message is successfully sent.

Definition at line 51 of file connection_wrapper.h.

Constructor & Destructor Documentation

◆ ConnectionWrapper()

msgpack_rpc::transport::ConnectionWrapper::ConnectionWrapper ( std::shared_ptr< IConnection > connection )

inlineexplicitnoexcept

Constructor.

Parameters

[in] connection Connection.

Definition at line 67 of file connection_wrapper.h.

Member Function Documentation

◆ async_close()

void msgpack_rpc::transport::ConnectionWrapper::async_close ( )

inline

Asynchronously close this connection.

Definition at line 148 of file connection_wrapper.h.

◆ async_notify()

template<typename... Parameters>

void msgpack_rpc::transport::ConnectionWrapper::async_notify	(	messages::MethodNameView	method_name,
		const Parameters &...	parameters )

inline

Asynchronously send a notification.

Template Parameters

Parameters Types of parameters.

Parameters

[in]	method_name	Method name.
[in]	parameters	Parameters.

Definition at line 138 of file connection_wrapper.h.

◆ async_request()

template<typename... Parameters>

void msgpack_rpc::transport::ConnectionWrapper::async_request	(	messages::MethodNameView	method_name,
		messages::MessageID	message_id,
		const Parameters &...	parameters )

inline

Asynchronously send a request.

Template Parameters

Parameters Types of parameters.

Parameters

[in]	method_name	Method name.
[in]	message_id	Message ID.
[in]	parameters	Parameters.

Definition at line 95 of file connection_wrapper.h.

◆ async_response_error()

template<typename T>

void msgpack_rpc::transport::ConnectionWrapper::async_response_error	(	messages::MessageID	request_id,
		const T &	error )

inline

Asynchronously send a response with an error.

Template Parameters

T	Type of the error.

Parameters

[in]	request_id	Message ID of the request.
[in]	error	Error.

Definition at line 124 of file connection_wrapper.h.

◆ async_response_success()

template<typename T>

void msgpack_rpc::transport::ConnectionWrapper::async_response_success	(	messages::MessageID	request_id,
		const T &	result )

inline

Asynchronously send a response without an error.

Template Parameters

T	Type of the result.

Parameters

[in]	request_id	Message ID of the request.
[in]	result	Result.

Definition at line 109 of file connection_wrapper.h.

◆ connection()

std::shared_ptr< IConnection > msgpack_rpc::transport::ConnectionWrapper::connection ( ) const

inlinenodiscardnoexcept

Get the IConnection object of this wrapper.

Returns: Pointer of the IConnection object.

Definition at line 173 of file connection_wrapper.h.

◆ local_address()

const addresses::IAddress & msgpack_rpc::transport::ConnectionWrapper::local_address ( ) const

inlinenodiscardnoexcept

Get the address of the local endpoint.

Returns: Address.

Definition at line 155 of file connection_wrapper.h.

◆ remote_address()

const addresses::IAddress & msgpack_rpc::transport::ConnectionWrapper::remote_address ( ) const

inlinenodiscardnoexcept

Get the address of the remote endpoint.

Returns: Address.

Definition at line 164 of file connection_wrapper.h.

◆ start()

void msgpack_rpc::transport::ConnectionWrapper::start	(	MessageReceivedCallback	on_received,
		MessageSentCallback	on_sent,
		ConnectionClosedCallback	on_closed )

inline

Start process of this connection.

Parameters

[in]	on_received	Callback function called when a message is received.
[in]	on_sent	Callback function called when a message is sent.
[in]	on_closed	Callback function called when this connection is closed.

Definition at line 80 of file connection_wrapper.h.

Member Data Documentation

◆ connection_

std::shared_ptr<IConnection> msgpack_rpc::transport::ConnectionWrapper::connection_

private

Connection.

Definition at line 179 of file connection_wrapper.h.

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

include/msgpack_rpc/transport/connection_wrapper.h

Public Types

Public Member Functions

Private Attributes

Detailed Description

Member Typedef Documentation

◆ ConnectionClosedCallback

◆ MessageReceivedCallback

◆ MessageSentCallback

Constructor & Destructor Documentation

◆ ConnectionWrapper()

Member Function Documentation

◆ async_close()

◆ async_notify()

◆ async_request()

◆ async_response_error()

◆ async_response_success()

◆ connection()

◆ local_address()

◆ remote_address()

◆ start()

Member Data Documentation

◆ connection_