cpp-msgpack-rpc 0.2.0
An RPC library implementing MessagePack RPC.
Loading...
Searching...
No Matches
msgpack_rpc::addresses::TCPAddress Class Referencefinal

Class of addresses of TCP. More...

#include <msgpack_rpc/addresses/tcp_address.h>

Inheritance diagram for msgpack_rpc::addresses::TCPAddress:
Collaboration diagram for msgpack_rpc::addresses::TCPAddress:

Public Member Functions

 TCPAddress (AsioTCPAddress address)
 Constructor.
 TCPAddress (std::string_view ip_address, std::uint16_t port_number)
 Constructor.
const AsioTCPAddressasio_address () const
 Get the address in asio library.
std::string ip_address () const
 Get the IP address.
bool operator!= (const TCPAddress &right) const
 Compare with an address.
bool operator== (const TCPAddress &right) const
 Compare with an address.
std::uint16_t port_number () const
 Get the port number.
std::string to_string () const override
 Convert to a string specifying URI.
URI to_uri () const override
 Convert to a URI.
Public Member Functions inherited from msgpack_rpc::addresses::IAddress
 IAddress (const IAddress &)=delete
 IAddress (IAddress &&)=delete
virtual ~IAddress () noexcept=default
 Destructor.
IAddressoperator= (const IAddress &)=delete
IAddressoperator= (IAddress &&)=delete

Private Attributes

AsioTCPAddress address_
 Address in asio library.

Additional Inherited Members

Protected Member Functions inherited from msgpack_rpc::addresses::IAddress
 IAddress () noexcept=default
 Constructor.

Detailed Description

Class of addresses of TCP.

Definition at line 44 of file tcp_address.h.

Constructor & Destructor Documentation

◆ TCPAddress() [1/2]

msgpack_rpc::addresses::TCPAddress::TCPAddress ( std::string_view ip_address,
std::uint16_t port_number )

Constructor.

Parameters
[in]ip_addressIP address.
[in]port_numberPort number.

Definition at line 35 of file tcp_address.cpp.

◆ TCPAddress() [2/2]

msgpack_rpc::addresses::TCPAddress::TCPAddress ( AsioTCPAddress address)
explicit

Constructor.

Parameters
[in]addressAddress in asio library.

Definition at line 39 of file tcp_address.cpp.

Member Function Documentation

◆ asio_address()

const AsioTCPAddress & msgpack_rpc::addresses::TCPAddress::asio_address ( ) const
nodiscard

Get the address in asio library.

Returns
Address in asio library.

Definition at line 53 of file tcp_address.cpp.

◆ ip_address()

std::string msgpack_rpc::addresses::TCPAddress::ip_address ( ) const
nodiscard

Get the IP address.

Returns
IP address.

Definition at line 41 of file tcp_address.cpp.

◆ operator!=()

bool msgpack_rpc::addresses::TCPAddress::operator!= ( const TCPAddress & right) const

Compare with an address.

Parameters
[in]rightRight-hand-side address.
Return values
trueTwo addresses are different.
falseTwo addresses are same.

Definition at line 59 of file tcp_address.cpp.

◆ operator==()

bool msgpack_rpc::addresses::TCPAddress::operator== ( const TCPAddress & right) const

Compare with an address.

Parameters
[in]rightRight-hand-side address.
Return values
trueTwo addresses are same.
falseTwo addresses are different.

Definition at line 55 of file tcp_address.cpp.

◆ port_number()

std::uint16_t msgpack_rpc::addresses::TCPAddress::port_number ( ) const
nodiscard

Get the port number.

Returns
Port number.

Definition at line 45 of file tcp_address.cpp.

◆ to_string()

std::string msgpack_rpc::addresses::TCPAddress::to_string ( ) const
nodiscardoverridevirtual

Convert to a string specifying URI.

Returns
String.

Implements msgpack_rpc::addresses::IAddress.

Definition at line 51 of file tcp_address.cpp.

◆ to_uri()

URI msgpack_rpc::addresses::TCPAddress::to_uri ( ) const
nodiscardoverridevirtual

Convert to a URI.

Returns
URI.

Implements msgpack_rpc::addresses::IAddress.

Definition at line 47 of file tcp_address.cpp.

Member Data Documentation

◆ address_

AsioTCPAddress msgpack_rpc::addresses::TCPAddress::address_
private

Address in asio library.

Definition at line 108 of file tcp_address.h.


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