beast::ip::Endpoint Class Reference

A version-independent IP address and port combination. More...

#include <IPEndpoint.h>

Collaboration diagram for beast::ip::Endpoint:

Public Member Functions
	Endpoint ()
	Create an unspecified endpoint.
	Endpoint (Address addr, Port port=0)
	Create an endpoint from the address and optional port.
std::string	toString () const
	Returns a string representing the endpoint.
Port	port () const
	Returns the port number on the endpoint.
Endpoint	atPort (Port port) const
	Returns a new Endpoint with a different port.
Address const &	address () const
	Returns the address portion of this endpoint.
bool	isV4 () const
	Convenience accessors for the address part.
bool	isV6 () const
AddressV4	toV4 () const
AddressV6	toV6 () const

Static Public Member Functions
static std::optional< Endpoint >	fromStringChecked (std::string const &s)
	Create an Endpoint from a string.
static Endpoint	fromString (std::string const &s)

Private Attributes
Address	addr_
Port	port_

Friends
template<class Hasher>
void	hash_append (Hasher &h, Endpoint const &endpoint)
bool	operator== (Endpoint const &lhs, Endpoint const &rhs)
	Arithmetic comparison.
bool	operator< (Endpoint const &lhs, Endpoint const &rhs)
bool	operator> (Endpoint const &lhs, Endpoint const &rhs)
bool	operator<= (Endpoint const &lhs, Endpoint const &rhs)
bool	operator>= (Endpoint const &lhs, Endpoint const &rhs)

Detailed Description

A version-independent IP address and port combination.

Definition at line 23 of file IPEndpoint.h.

Constructor & Destructor Documentation

Endpoint() [1/2]

beast::ip::Endpoint::Endpoint

(

)

Create an unspecified endpoint.

Definition at line 19 of file IPEndpoint.cpp.

Endpoint() [2/2]

beast::ip::Endpoint::Endpoint ( Address addr, Port port = 0 )

explicit

Create an endpoint from the address and optional port.

Definition at line 23 of file IPEndpoint.cpp.

Member Function Documentation

fromStringChecked()

std::optional< Endpoint > beast::ip::Endpoint::fromStringChecked ( std::string const & s )

static

Create an Endpoint from a string.

If the port is omitted, the endpoint will have a zero port.

Returns

An optional endpoint; will be std::nullopt on failure

Definition at line 28 of file IPEndpoint.cpp.

fromString()

Endpoint beast::ip::Endpoint::fromString ( std::string const & s )

static

Definition at line 42 of file IPEndpoint.cpp.

toString()

std::string beast::ip::Endpoint::toString ( ) const

nodiscard

Returns a string representing the endpoint.

Definition at line 50 of file IPEndpoint.cpp.

port()

Port beast::ip::Endpoint::port ( ) const

nodiscard

Returns the port number on the endpoint.

Definition at line 56 of file IPEndpoint.h.

atPort()

Endpoint beast::ip::Endpoint::atPort ( Port port ) const

nodiscard

Returns a new Endpoint with a different port.

Definition at line 65 of file IPEndpoint.h.

address()

Address const & beast::ip::Endpoint::address ( ) const

nodiscard

Returns the address portion of this endpoint.

Definition at line 74 of file IPEndpoint.h.

isV4()

bool beast::ip::Endpoint::isV4 ( ) const

nodiscard

Convenience accessors for the address part.

Definition at line 84 of file IPEndpoint.h.

isV6()

bool beast::ip::Endpoint::isV6 ( ) const

nodiscard

Definition at line 89 of file IPEndpoint.h.

toV4()

AddressV4 beast::ip::Endpoint::toV4 ( ) const

nodiscard

Definition at line 94 of file IPEndpoint.h.

toV6()

AddressV6 beast::ip::Endpoint::toV6 ( ) const

nodiscard

Definition at line 99 of file IPEndpoint.h.

Friends And Related Symbol Documentation

operator==

bool operator== ( Endpoint const & lhs, Endpoint const & rhs )

friend

Arithmetic comparison.

Definition at line 71 of file IPEndpoint.cpp.

operator<

bool operator< ( Endpoint const & lhs, Endpoint const & rhs )

friend

Definition at line 76 of file IPEndpoint.cpp.

operator>

bool operator> ( Endpoint const & lhs, Endpoint const & rhs )

friend

Definition at line 114 of file IPEndpoint.h.

operator<=

bool operator<= ( Endpoint const & lhs, Endpoint const & rhs )

friend

Definition at line 118 of file IPEndpoint.h.

operator>=

bool operator>= ( Endpoint const & lhs, Endpoint const & rhs )

friend

Definition at line 124 of file IPEndpoint.h.

hash_append

template<class Hasher>

void hash_append ( Hasher & h, Endpoint const & endpoint )

friend

Definition at line 132 of file IPEndpoint.h.

Member Data Documentation

addr_

Address beast::ip::Endpoint::addr_

private

Definition at line 139 of file IPEndpoint.h.

port_

Port beast::ip::Endpoint::port_

private

Definition at line 140 of file IPEndpoint.h.