Realistic 3D camera system
3D camera system components
Public Types | Public Member Functions | Friends | List of all members
asio::generic::basic_endpoint< Protocol > Class Template Reference

Describes an endpoint for any socket type. More...

#include <basic_endpoint.hpp>

Public Types

typedef Protocol protocol_type
 The protocol type associated with the endpoint. More...
 
typedef asio::detail::socket_addr_type data_type
 

Public Member Functions

 basic_endpoint ()
 Default constructor. More...
 
 basic_endpoint (const void *socket_address, std::size_t socket_address_size, int socket_protocol=0)
 Construct an endpoint from the specified socket address. More...
 
template<typename Endpoint >
 basic_endpoint (const Endpoint &endpoint)
 Construct an endpoint from the specific endpoint type. 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...
 

Friends

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

Detailed Description

template<typename Protocol>
class asio::generic::basic_endpoint< Protocol >

Describes an endpoint for any socket type.

The asio::generic::basic_endpoint class template describes an endpoint that may be associated with any socket type.

Note
The socket types sockaddr type must be able to fit into a sockaddr_storage structure.
Thread Safety
Distinct objects: Safe.
Shared objects: Unsafe.
Concepts:
Endpoint.

Definition at line 42 of file basic_endpoint.hpp.

Member Typedef Documentation

template<typename Protocol>
typedef asio::detail::socket_addr_type asio::generic::basic_endpoint< Protocol >::data_type

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

Definition at line 53 of file basic_endpoint.hpp.

template<typename Protocol>
typedef Protocol asio::generic::basic_endpoint< Protocol >::protocol_type

The protocol type associated with the endpoint.

Definition at line 46 of file basic_endpoint.hpp.

Constructor & Destructor Documentation

template<typename Protocol>
asio::generic::basic_endpoint< Protocol >::basic_endpoint ( )
inline

Default constructor.

Definition at line 57 of file basic_endpoint.hpp.

template<typename Protocol>
asio::generic::basic_endpoint< Protocol >::basic_endpoint ( const void *  socket_address,
std::size_t  socket_address_size,
int  socket_protocol = 0 
)
inline

Construct an endpoint from the specified socket address.

Definition at line 62 of file basic_endpoint.hpp.

template<typename Protocol>
template<typename Endpoint >
asio::generic::basic_endpoint< Protocol >::basic_endpoint ( const Endpoint &  endpoint)
inline

Construct an endpoint from the specific endpoint type.

Definition at line 70 of file basic_endpoint.hpp.

template<typename Protocol>
asio::generic::basic_endpoint< Protocol >::basic_endpoint ( const basic_endpoint< Protocol > &  other)
inline

Copy constructor.

Definition at line 76 of file basic_endpoint.hpp.

Member Function Documentation

template<typename Protocol>
std::size_t asio::generic::basic_endpoint< Protocol >::capacity ( ) const
inline

Get the capacity of the endpoint in the native type.

Definition at line 136 of file basic_endpoint.hpp.

template<typename Protocol>
data_type* asio::generic::basic_endpoint< Protocol >::data ( )
inline

Get the underlying endpoint in the native type.

Definition at line 112 of file basic_endpoint.hpp.

template<typename Protocol>
const data_type* asio::generic::basic_endpoint< Protocol >::data ( ) const
inline

Get the underlying endpoint in the native type.

Definition at line 118 of file basic_endpoint.hpp.

template<typename Protocol>
basic_endpoint& asio::generic::basic_endpoint< Protocol >::operator= ( const basic_endpoint< Protocol > &  other)
inline

Assign from another endpoint.

Definition at line 90 of file basic_endpoint.hpp.

template<typename Protocol>
protocol_type asio::generic::basic_endpoint< Protocol >::protocol ( ) const
inline

The protocol associated with the endpoint.

Definition at line 106 of file basic_endpoint.hpp.

template<typename Protocol>
void asio::generic::basic_endpoint< Protocol >::resize ( std::size_t  new_size)
inline

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

Definition at line 130 of file basic_endpoint.hpp.

template<typename Protocol>
std::size_t asio::generic::basic_endpoint< Protocol >::size ( ) const
inline

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

Definition at line 124 of file basic_endpoint.hpp.

Friends And Related Function Documentation

template<typename Protocol>
bool operator!= ( const basic_endpoint< Protocol > &  e1,
const basic_endpoint< Protocol > &  e2 
)
friend

Compare two endpoints for inequality.

Definition at line 149 of file basic_endpoint.hpp.

template<typename Protocol>
bool operator< ( const basic_endpoint< Protocol > &  e1,
const basic_endpoint< Protocol > &  e2 
)
friend

Compare endpoints for ordering.

Definition at line 156 of file basic_endpoint.hpp.

template<typename Protocol>
bool operator<= ( const basic_endpoint< Protocol > &  e1,
const basic_endpoint< Protocol > &  e2 
)
friend

Compare endpoints for ordering.

Definition at line 170 of file basic_endpoint.hpp.

template<typename Protocol>
bool operator== ( const basic_endpoint< Protocol > &  e1,
const basic_endpoint< Protocol > &  e2 
)
friend

Compare two endpoints for equality.

Definition at line 142 of file basic_endpoint.hpp.

template<typename Protocol>
bool operator> ( const basic_endpoint< Protocol > &  e1,
const basic_endpoint< Protocol > &  e2 
)
friend

Compare endpoints for ordering.

Definition at line 163 of file basic_endpoint.hpp.

template<typename Protocol>
bool operator>= ( const basic_endpoint< Protocol > &  e1,
const basic_endpoint< Protocol > &  e2 
)
friend

Compare endpoints for ordering.

Definition at line 177 of file basic_endpoint.hpp.

The documentation for this class was generated from the following file:
Generated by   doxygen 1.8.11