asio::generic::stream_protocol Class Reference

Encapsulates the flags needed for a generic stream-oriented socket. More...

#include <stream_protocol.hpp>

Public Types
typedef basic_endpoint< stream_protocol >	endpoint
	The type of an endpoint. More...
typedef basic_stream_socket< stream_protocol >	socket
	The generic socket type. More...
typedef basic_socket_iostream< stream_protocol >	iostream
	The generic socket iostream type. More...

Public Member Functions
	stream_protocol (int address_family, int socket_protocol)
	Construct a protocol object for a specific address family and protocol. More...
template<typename Protocol >
	stream_protocol (const Protocol &source_protocol)
	Construct a generic protocol object from a specific protocol. More...
int	type () const
	Obtain an identifier for the type of the protocol. More...
int	protocol () const
	Obtain an identifier for the protocol. More...
int	family () const
	Obtain an identifier for the protocol family. More...

Friends
bool	operator== (const stream_protocol &p1, const stream_protocol &p2)
	Compare two protocols for equality. More...
bool	operator!= (const stream_protocol &p1, const stream_protocol &p2)
	Compare two protocols for inequality. More...

Detailed Description

Encapsulates the flags needed for a generic stream-oriented socket.

The asio::generic::stream_protocol class contains flags necessary for stream-oriented sockets of any address family and protocol.

Examples

Constructing using a native address family and socket protocol:

stream_protocol p(AF_INET, IPPROTO_TCP); 

Constructing from a specific protocol type:

stream_protocol p(asio::ip::tcp::v4()); 

Thread Safety

Distinct objects: Safe.
Shared objects: Safe.

Concepts:

Protocol.

Definition at line 50 of file stream_protocol.hpp.

Member Typedef Documentation

typedef basic_endpoint<stream_protocol> asio::generic::stream_protocol::endpoint

The type of an endpoint.

Definition at line 107 of file stream_protocol.hpp.

typedef basic_socket_iostream<stream_protocol> asio::generic::stream_protocol::iostream

The generic socket iostream type.

Definition at line 114 of file stream_protocol.hpp.

typedef basic_stream_socket<stream_protocol> asio::generic::stream_protocol::socket

The generic socket type.

Definition at line 110 of file stream_protocol.hpp.

Constructor & Destructor Documentation

asio::generic::stream_protocol::stream_protocol ( int  address_family, int  socket_protocol  )

inline

Construct a protocol object for a specific address family and protocol.

Definition at line 54 of file stream_protocol.hpp.

template<typename Protocol >

asio::generic::stream_protocol::stream_protocol ( const Protocol &  source_protocol )

inline

Construct a generic protocol object from a specific protocol.

Exceptions

Definition at line 65 of file stream_protocol.hpp.

Member Function Documentation

int asio::generic::stream_protocol::family ( ) const

inline

Obtain an identifier for the protocol family.

Definition at line 89 of file stream_protocol.hpp.

int asio::generic::stream_protocol::protocol ( ) const

inline

Obtain an identifier for the protocol.

Definition at line 83 of file stream_protocol.hpp.

int asio::generic::stream_protocol::type ( ) const

inline

Obtain an identifier for the type of the protocol.

Definition at line 77 of file stream_protocol.hpp.

Friends And Related Function Documentation

bool operator!= ( const stream_protocol &  p1, const stream_protocol &  p2  )

friend

Compare two protocols for inequality.

Definition at line 101 of file stream_protocol.hpp.

bool operator== ( const stream_protocol &  p1, const stream_protocol &  p2  )

friend

Compare two protocols for equality.

Definition at line 95 of file stream_protocol.hpp.

---

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

• /home/martin/ver/3DLab/code/asio-1.10.6/include/asio/generic/stream_protocol.hpp