All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Defines
Classes | Public Types | Public Member Functions | Private Member Functions | Private Attributes | Friends | Related Functions
asio::local::basic_endpoint< Protocol > Class Template Reference

Describes an endpoint for a UNIX socket. More...

#include <basic_endpoint.hpp>

List of all members.

Classes

union  data_union

Public Types

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

Public Member Functions

 basic_endpoint ()
 Default constructor.
 basic_endpoint (const char *path)
 Construct an endpoint using the specified path name.
 basic_endpoint (const std::string &path)
 Construct an endpoint using the specified path name.
 basic_endpoint (const basic_endpoint &other)
 Copy constructor.
std::size_t capacity () const
 Get the capacity of the endpoint in the native type.
data_typedata ()
 Get the underlying endpoint in the native type.
const data_typedata () const
 Get the underlying endpoint in the native type.
basic_endpointoperator= (const basic_endpoint &other)
 Assign from another endpoint.
std::string path () const
 Get the path associated with the endpoint.
void path (const char *p)
 Set the path associated with the endpoint.
void path (const std::string &p)
 Set the path associated with the endpoint.
protocol_type protocol () const
 The protocol associated with the endpoint.
void resize (std::size_t size)
 Set the underlying size of the endpoint in the native type.
std::size_t size () const
 Get the underlying size of the endpoint in the native type.

Private Member Functions

void init (const char *path, std::size_t path_length)

Private Attributes

union
asio::local::basic_endpoint::data_union 
data_
std::size_t path_length_

Friends

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

Related Functions

(Note that these are not member functions.)

template<typename Elem , typename Traits , typename Protocol >
std::basic_ostream< Elem,
Traits > & 
operator<< (std::basic_ostream< Elem, Traits > &os, const basic_endpoint< Protocol > &endpoint)
 Output an endpoint as a string.

Detailed Description

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

Describes an endpoint for a UNIX socket.

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

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

Definition at line 60 of file local/basic_endpoint.hpp.


Member Typedef Documentation

template<typename Protocol>
typedef asio::detail::socket_addr_type asio::local::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 71 of file local/basic_endpoint.hpp.

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

The protocol type associated with the endpoint.

Definition at line 64 of file local/basic_endpoint.hpp.


Constructor & Destructor Documentation

template<typename Protocol>
asio::local::basic_endpoint< Protocol >::basic_endpoint ( ) [inline]

Default constructor.

Definition at line 75 of file local/basic_endpoint.hpp.

template<typename Protocol>
asio::local::basic_endpoint< Protocol >::basic_endpoint ( const char *  path) [inline]

Construct an endpoint using the specified path name.

Definition at line 81 of file local/basic_endpoint.hpp.

template<typename Protocol>
asio::local::basic_endpoint< Protocol >::basic_endpoint ( const std::string &  path) [inline]

Construct an endpoint using the specified path name.

Definition at line 88 of file local/basic_endpoint.hpp.

template<typename Protocol>
asio::local::basic_endpoint< Protocol >::basic_endpoint ( const basic_endpoint< Protocol > &  other) [inline]

Copy constructor.

Definition at line 94 of file local/basic_endpoint.hpp.


Member Function Documentation

template<typename Protocol>
std::size_t asio::local::basic_endpoint< Protocol >::capacity ( ) const [inline]

Get the capacity of the endpoint in the native type.

Definition at line 157 of file local/basic_endpoint.hpp.

template<typename Protocol>
data_type* asio::local::basic_endpoint< Protocol >::data ( ) [inline]

Get the underlying endpoint in the native type.

Definition at line 115 of file local/basic_endpoint.hpp.

template<typename Protocol>
const data_type* asio::local::basic_endpoint< Protocol >::data ( ) const [inline]

Get the underlying endpoint in the native type.

Definition at line 121 of file local/basic_endpoint.hpp.

template<typename Protocol>
void asio::local::basic_endpoint< Protocol >::init ( const char *  path,
std::size_t  path_length 
) [inline, private]

Definition at line 214 of file local/basic_endpoint.hpp.

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

Assign from another endpoint.

Definition at line 101 of file local/basic_endpoint.hpp.

template<typename Protocol>
std::string asio::local::basic_endpoint< Protocol >::path ( ) const [inline]

Get the path associated with the endpoint.

Definition at line 163 of file local/basic_endpoint.hpp.

template<typename Protocol>
void asio::local::basic_endpoint< Protocol >::path ( const char *  p) [inline]

Set the path associated with the endpoint.

Definition at line 169 of file local/basic_endpoint.hpp.

template<typename Protocol>
void asio::local::basic_endpoint< Protocol >::path ( const std::string &  p) [inline]

Set the path associated with the endpoint.

Definition at line 176 of file local/basic_endpoint.hpp.

template<typename Protocol>
protocol_type asio::local::basic_endpoint< Protocol >::protocol ( ) const [inline]

The protocol associated with the endpoint.

Definition at line 109 of file local/basic_endpoint.hpp.

template<typename Protocol>
void asio::local::basic_endpoint< Protocol >::resize ( std::size_t  size) [inline]

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

Definition at line 134 of file local/basic_endpoint.hpp.

template<typename Protocol>
std::size_t asio::local::basic_endpoint< Protocol >::size ( ) const [inline]

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

Definition at line 127 of file local/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 189 of file local/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 196 of file local/basic_endpoint.hpp.

template<typename Elem , typename Traits , typename Protocol >
std::basic_ostream< Elem, Traits > & operator<< ( std::basic_ostream< Elem, Traits > &  os,
const basic_endpoint< Protocol > &  endpoint 
) [related]

Output an endpoint as a string.

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

Parameters:
osThe output stream to which the string will be written.
endpointThe endpoint to be written.
Returns:
The output stream.

Definition at line 249 of file local/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 182 of file local/basic_endpoint.hpp.


Member Data Documentation

template<typename Protocol>
union asio::local::basic_endpoint::data_union asio::local::basic_endpoint< Protocol >::data_ [private]
template<typename Protocol>
std::size_t asio::local::basic_endpoint< Protocol >::path_length_ [private]

Definition at line 211 of file local/basic_endpoint.hpp.


The documentation for this class was generated from the following file:
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Defines


Castor
Author(s): Carpe Noctem
autogenerated on Fri Nov 8 2013 11:05:41