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 const &addr, Port port=0)
	Create an endpoint from the address and optional port.
std::string	to_string () const
	Returns a string representing the endpoint.
Port	port () const
	Returns the port number on the endpoint.
Endpoint	at_port (Port port) const
	Returns a new Endpoint with a different port.
Address const &	address () const
	Returns the address portion of this endpoint.
bool	is_v4 () const
	Convenience accessors for the address part.
bool	is_v6 () const
AddressV4 const	to_v4 () const
AddressV6 const	to_v6 () const

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

Private Attributes
Address	m_addr
Port	m_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)
bool	operator>= (Endpoint const &lhs, Endpoint const &rhs)

Detailed Description

A version-independent IP address and port combination.

Definition at line 37 of file IPEndpoint.h.

Constructor & Destructor Documentation

Endpoint() [1/2]

beast::IP::Endpoint::Endpoint

(

)

Create an unspecified endpoint.

Definition at line 38 of file IPEndpoint.cpp.

Endpoint() [2/2]

beast::IP::Endpoint::Endpoint ( Address const &  addr, Port  port = 0  )

explicit

Create an endpoint from the address and optional port.

Definition at line 42 of file IPEndpoint.cpp.

Member Function Documentation

from_string_checked()

std::optional< Endpoint > beast::IP::Endpoint::from_string_checked ( 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 47 of file IPEndpoint.cpp.

from_string()

Endpoint beast::IP::Endpoint::from_string ( std::string const &  s )

static

Definition at line 61 of file IPEndpoint.cpp.

to_string()

std::string beast::IP::Endpoint::to_string

(

)

const

Returns a string representing the endpoint.

Definition at line 69 of file IPEndpoint.cpp.

port()

Port beast::IP::Endpoint::port

(

)

const

Returns the port number on the endpoint.

Definition at line 61 of file IPEndpoint.h.

at_port()

Endpoint beast::IP::Endpoint::at_port

(

Port

port

)

const

Returns a new Endpoint with a different port.

Definition at line 68 of file IPEndpoint.h.

address()

Address const & beast::IP::Endpoint::address

(

)

const

Returns the address portion of this endpoint.

Definition at line 75 of file IPEndpoint.h.

is_v4()

bool beast::IP::Endpoint::is_v4

(

)

const

Convenience accessors for the address part.

Definition at line 83 of file IPEndpoint.h.

is_v6()

bool beast::IP::Endpoint::is_v6

(

)

const

Definition at line 88 of file IPEndpoint.h.

to_v4()

AddressV4 const beast::IP::Endpoint::to_v4

(

)

const

Definition at line 93 of file IPEndpoint.h.

to_v6()

AddressV6 const beast::IP::Endpoint::to_v6

(

)

const

Definition at line 98 of file IPEndpoint.h.

Friends And Related Symbol Documentation

operator==

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

friend

Arithmetic comparison.

Definition at line 90 of file IPEndpoint.cpp.

operator<

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

friend

Definition at line 95 of file IPEndpoint.cpp.

operator!=

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

friend

Definition at line 112 of file IPEndpoint.h.

operator>

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

friend

Definition at line 117 of file IPEndpoint.h.

operator<=

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

friend

Definition at line 121 of file IPEndpoint.h.

operator>=

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

friend

Definition at line 127 of file IPEndpoint.h.

hash_append

template<class Hasher >

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

friend

Definition at line 135 of file IPEndpoint.h.

Member Data Documentation

m_addr

Address beast::IP::Endpoint::m_addr

private

Definition at line 142 of file IPEndpoint.h.

m_port

Port beast::IP::Endpoint::m_port

private

Definition at line 143 of file IPEndpoint.h.