msgpack_rpc::clients::ClientBuilder Class Reference

Class of builders of clients. More...

#include <msgpack_rpc/clients/client_builder.h>

Collaboration diagram for msgpack_rpc::clients::ClientBuilder:

Public Member Functions
	ClientBuilder ()
	Constructor.
	ClientBuilder (config::ClientConfig client_config, const std::shared_ptr< logging::Logger > &logger=logging::Logger::create())
	Constructor.
	ClientBuilder (const std::shared_ptr< logging::Logger > &logger)
	Constructor.
Client	build ()
	Build a client.
ClientBuilder &	connect_to (addresses::URI uri)
	Add a URI to connect to.
ClientBuilder &	connect_to (std::string_view uri)
	Add a URI to connect to.
ClientBuilder &	connect_to_tcp (std::string_view host, std::uint16_t port_number)
	Add a TCP address to connect to.

Private Attributes
std::unique_ptr< impl::IClientBuilderImpl >	impl_
	Object of the internal implementation.

Detailed Description

Class of builders of clients.

Examples

more_client.cpp, and simple_client.cpp.

Definition at line 40 of file client_builder.h.

Constructor & Destructor Documentation

ClientBuilder() [1/3]

msgpack_rpc::clients::ClientBuilder::ClientBuilder ( )

inline

Constructor.

This overload will use the default configurations for clients and loggers.

Definition at line 48 of file client_builder.h.

ClientBuilder() [2/3]

msgpack_rpc::clients::ClientBuilder::ClientBuilder ( const std::shared_ptr< logging::Logger > & logger )

inlineexplicit

Constructor.

Parameters

[in]

logger

Logger.

This overload will use the default configurations for clients.

Definition at line 57 of file client_builder.h.

ClientBuilder() [3/3]

msgpack_rpc::clients::ClientBuilder::ClientBuilder ( config::ClientConfig client_config, const std::shared_ptr< logging::Logger > & logger = logging::Logger::create() )

inlineexplicit

Constructor.

Parameters

[in]	client_config	Configuration of the client.
[in]	logger	Logger.

Definition at line 66 of file client_builder.h.

Member Function Documentation

build()

Client msgpack_rpc::clients::ClientBuilder::build ( )

inlinenodiscard

Build a client.

Returns

Client.

Examples

more_client.cpp, and simple_client.cpp.

Definition at line 111 of file client_builder.h.

connect_to() [1/2]

ClientBuilder & msgpack_rpc::clients::ClientBuilder::connect_to ( addresses::URI uri )

inline

Add a URI to connect to.

Parameters

[in]

uri

URI.

Returns

This.

Examples

more_client.cpp, and simple_client.cpp.

Definition at line 78 of file client_builder.h.

connect_to() [2/2]

ClientBuilder & msgpack_rpc::clients::ClientBuilder::connect_to ( std::string_view uri )

inline

Add a URI to connect to.

Parameters

[in]

uri

URI.

Returns

This.

Definition at line 89 of file client_builder.h.

connect_to_tcp()

ClientBuilder & msgpack_rpc::clients::ClientBuilder::connect_to_tcp ( std::string_view host, std::uint16_t port_number )

inline

Add a TCP address to connect to.

Parameters

[in]	host	Host name.
[in]	port_number	Port number.

Returns

This.

Examples

more_client.cpp.

Definition at line 100 of file client_builder.h.

Member Data Documentation

impl_

std::unique_ptr<impl::IClientBuilderImpl> msgpack_rpc::clients::ClientBuilder::impl_

private

Object of the internal implementation.

Definition at line 115 of file client_builder.h.

---

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

• include/msgpack_rpc/clients/client_builder.h