Boost C++ Libraries

...one of the most highly regarded and expertly designed C++ library projects in the world. Herb Sutter and Andrei Alexandrescu, C++ Coding Standards

This is the documentation for an old version of Boost. Click here to view this page for the latest version.
PrevUpHomeNext

generic::basic_endpoint

Describes an endpoint for any socket type.

template<
    typename Protocol>
class basic_endpoint
Types

Name

Description

data_type

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

protocol_type

The protocol type associated with the endpoint.

Member Functions

Name

Description

basic_endpoint

Default constructor.

Construct an endpoint from the specified socket address.

Construct an endpoint from the specific endpoint type.

Copy constructor.

capacity

Get the capacity of the endpoint in the native type.

data

Get the underlying endpoint in the native type.

operator=

Assign from another endpoint.

protocol

The protocol associated with the endpoint.

resize

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

size

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

Friends

Name

Description

operator!=

Compare two endpoints for inequality.

operator<

Compare endpoints for ordering.

operator<=

Compare endpoints for ordering.

operator==

Compare two endpoints for equality.

operator>

Compare endpoints for ordering.

operator>=

Compare endpoints for ordering.

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

Remarks

The socket types sockaddr type must be able to fit into a sockaddr_storage structure.

Thread Safety

Distinct objects: Safe.

Shared objects: Unsafe.

Requirements

Header: boost/asio/generic/basic_endpoint.hpp

Convenience header: boost/asio.hpp


PrevUpHomeNext