Describes an endpoint for a version-independent IP socket. More...

#include <basic_endpoint.hpp>

Public Types
typedef InternetProtocol	protocol_type
	The protocol type associated with the endpoint. More...

typedef boost::asio::detail::socket_addr_type	data_type
	The type of the endpoint structure. More...

Public Member Functions
	basic_endpoint ()
	Default constructor. More...

	basic_endpoint (const InternetProtocol &internet_protocol, unsigned short port_num)
	Construct an endpoint using a port number, specified in the host's byte order. More...

	basic_endpoint (const boost::asio::ip::address &addr, unsigned short port_num)
	Construct an endpoint using a port number and an IP address. More...

	basic_endpoint (const basic_endpoint &other)
	Copy constructor. More...

basic_endpoint &	operator= (const basic_endpoint &other)
	Assign from another endpoint. More...

protocol_type	protocol () const
	The protocol associated with the endpoint. More...

data_type *	data ()
	Get the underlying endpoint in the native type. More...

const data_type *	data () const
	Get the underlying endpoint in the native type. More...

std::size_t	size () const
	Get the underlying size of the endpoint in the native type. More...

void	resize (std::size_t new_size)
	Set the underlying size of the endpoint in the native type. More...

std::size_t	capacity () const
	Get the capacity of the endpoint in the native type. More...

unsigned short	port () const
	Get the port associated with the endpoint. More...

void	port (unsigned short port_num)
	Set the port associated with the endpoint. More...

boost::asio::ip::address	address () const
	Get the IP address associated with the endpoint. More...

void	address (const boost::asio::ip::address &addr)
	Set the IP address associated with the endpoint. More...

Friends
bool	operator== (const basic_endpoint< InternetProtocol > &e1, const basic_endpoint< InternetProtocol > &e2)
	Compare two endpoints for equality. More...

bool	operator!= (const basic_endpoint< InternetProtocol > &e1, const basic_endpoint< InternetProtocol > &e2)
	Compare two endpoints for inequality. More...

bool	operator< (const basic_endpoint< InternetProtocol > &e1, const basic_endpoint< InternetProtocol > &e2)
	Compare endpoints for ordering. More...

bool	operator> (const basic_endpoint< InternetProtocol > &e1, const basic_endpoint< InternetProtocol > &e2)
	Compare endpoints for ordering. More...

bool	operator<= (const basic_endpoint< InternetProtocol > &e1, const basic_endpoint< InternetProtocol > &e2)
	Compare endpoints for ordering. More...

bool	operator>= (const basic_endpoint< InternetProtocol > &e1, const basic_endpoint< InternetProtocol > &e2)
	Compare endpoints for ordering. More...

Related Functions
(Note that these are not member functions.)
template<typename Elem , typename Traits , typename InternetProtocol >
std::basic_ostream< Elem, Traits > &	operator<< (std::basic_ostream< Elem, Traits > &os, const basic_endpoint< InternetProtocol > &endpoint)
	Output an endpoint as a string. More...

Detailed Description

template<typename InternetProtocol>
class boost::asio::ip::basic_endpoint< InternetProtocol >

Describes an endpoint for a version-independent IP socket.

The boost::asio::ip::basic_endpoint class template describes an endpoint that may be associated with a particular socket.

Thread Safety: Distinct objects: Safe.
Shared objects: Unsafe.

Concepts:: Endpoint.

Member Typedef Documentation

template<typename InternetProtocol>

typedef boost::asio::detail::socket_addr_type boost::asio::ip::basic_endpoint< InternetProtocol >::data_type

The type of the endpoint structure.

This type is dependent on the underlying implementation of the socket layer.

template<typename InternetProtocol>

typedef InternetProtocol boost::asio::ip::basic_endpoint< InternetProtocol >::protocol_type

The protocol type associated with the endpoint.

Constructor & Destructor Documentation

template<typename InternetProtocol>

boost::asio::ip::basic_endpoint< InternetProtocol >::basic_endpoint ( )

inline

Default constructor.

template<typename InternetProtocol>

boost::asio::ip::basic_endpoint< InternetProtocol >::basic_endpoint	(	const InternetProtocol &	internet_protocol,
		unsigned short	port_num
	)

inline

Construct an endpoint using a port number, specified in the host's byte order.

The IP address will be the any address (i.e. INADDR_ANY or in6addr_any). This constructor would typically be used for accepting new connections.

Examples: To initialise an IPv4 TCP endpoint for port 1234, use:
boost::asio::ip::tcp::endpoint ep(boost::asio::ip::tcp::v4(), 1234);

To specify an IPv6 UDP endpoint for port 9876, use:

boost::asio::ip::udp::endpoint ep(boost::asio::ip::udp::v6(), 9876);

template<typename InternetProtocol>

boost::asio::ip::basic_endpoint< InternetProtocol >::basic_endpoint	(	const boost::asio::ip::address &	addr,
		unsigned short	port_num
	)

inline

Construct an endpoint using a port number and an IP address.

This constructor may be used for accepting connections on a specific interface or for making a connection to a remote endpoint.

template<typename InternetProtocol>

boost::asio::ip::basic_endpoint< InternetProtocol >::basic_endpoint ( const basic_endpoint< InternetProtocol > & other )

inline

Copy constructor.

Member Function Documentation

template<typename InternetProtocol>

boost::asio::ip::address boost::asio::ip::basic_endpoint< InternetProtocol >::address ( ) const

inline

Get the IP address associated with the endpoint.

template<typename InternetProtocol>

void boost::asio::ip::basic_endpoint< InternetProtocol >::address ( const boost::asio::ip::address & addr )

inline

Set the IP address associated with the endpoint.

template<typename InternetProtocol>

std::size_t boost::asio::ip::basic_endpoint< InternetProtocol >::capacity ( ) const

inline

Get the capacity of the endpoint in the native type.

template<typename InternetProtocol>

data_type* boost::asio::ip::basic_endpoint< InternetProtocol >::data ( )

inline

Get the underlying endpoint in the native type.

template<typename InternetProtocol>

const data_type* boost::asio::ip::basic_endpoint< InternetProtocol >::data ( ) const

inline

Get the underlying endpoint in the native type.

template<typename InternetProtocol>

basic_endpoint& boost::asio::ip::basic_endpoint< InternetProtocol >::operator= ( const basic_endpoint< InternetProtocol > & other )

inline

Assign from another endpoint.

template<typename InternetProtocol>

unsigned short boost::asio::ip::basic_endpoint< InternetProtocol >::port ( ) const

inline

Get the port associated with the endpoint.

The port number is always in the host's byte order.

template<typename InternetProtocol>

void boost::asio::ip::basic_endpoint< InternetProtocol >::port ( unsigned short port_num )

inline

Set the port associated with the endpoint.

The port number is always in the host's byte order.

template<typename InternetProtocol>

protocol_type boost::asio::ip::basic_endpoint< InternetProtocol >::protocol ( ) const

inline

The protocol associated with the endpoint.

References boost::sinks::v4, and boost::sinks::v6.

template<typename InternetProtocol>

void boost::asio::ip::basic_endpoint< InternetProtocol >::resize ( std::size_t new_size )

inline

Set the underlying size of the endpoint in the native type.

template<typename InternetProtocol>

std::size_t boost::asio::ip::basic_endpoint< InternetProtocol >::size ( ) const

inline

Get the underlying size of the endpoint in the native type.

Friends And Related Function Documentation

template<typename InternetProtocol>

bool operator!=	(	const basic_endpoint< InternetProtocol > &	e1,
		const basic_endpoint< InternetProtocol > &	e2
	)

friend

Compare two endpoints for inequality.

template<typename InternetProtocol>

bool operator<	(	const basic_endpoint< InternetProtocol > &	e1,
		const basic_endpoint< InternetProtocol > &	e2
	)

friend

Compare endpoints for ordering.

template<typename Elem , typename Traits , typename InternetProtocol >

std::basic_ostream< Elem, Traits > & operator<<	(	std::basic_ostream< Elem, Traits > &	os,
		const basic_endpoint< InternetProtocol > &	endpoint
	)

Used to output a human-readable string for a specified endpoint.

Parameters

os	The output stream to which the string will be written.
endpoint	The endpoint to be written.

Returns: The output stream.

template<typename InternetProtocol>

bool operator<=	(	const basic_endpoint< InternetProtocol > &	e1,
		const basic_endpoint< InternetProtocol > &	e2
	)

friend

Compare endpoints for ordering.

template<typename InternetProtocol>

bool operator==	(	const basic_endpoint< InternetProtocol > &	e1,
		const basic_endpoint< InternetProtocol > &	e2
	)

friend

Compare two endpoints for equality.

template<typename InternetProtocol>

bool operator>	(	const basic_endpoint< InternetProtocol > &	e1,
		const basic_endpoint< InternetProtocol > &	e2
	)

friend

Compare endpoints for ordering.

template<typename InternetProtocol>

bool operator>=	(	const basic_endpoint< InternetProtocol > &	e1,
		const basic_endpoint< InternetProtocol > &	e2
	)

friend

Compare endpoints for ordering.

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

boost_1_57_0/boost/asio/ip/basic_endpoint.hpp

Public Types

Public Member Functions

Friends

Related Functions

Detailed Description

template<typename InternetProtocol> class boost::asio::ip::basic_endpoint< InternetProtocol >

Member Typedef Documentation

Constructor & Destructor Documentation

Member Function Documentation

Friends And Related Function Documentation

template<typename InternetProtocol>
class boost::asio::ip::basic_endpoint< InternetProtocol >