asio::generic::seq_packet_protocol Class Reference

Encapsulates the flags needed for a generic sequenced packet socket. More...

#include <seq_packet_protocol.hpp>

Public Types
typedef basic_endpoint< seq_packet_protocol >	endpoint
	The type of an endpoint. More...
typedef basic_seq_packet_socket< seq_packet_protocol >	socket
	The generic socket type. More...

Public Member Functions
	seq_packet_protocol (int address_family, int socket_protocol)
	Construct a protocol object for a specific address family and protocol. More...
template<typename Protocol >
	seq_packet_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 seq_packet_protocol &p1, const seq_packet_protocol &p2)
	Compare two protocols for equality. More...
bool	operator!= (const seq_packet_protocol &p1, const seq_packet_protocol &p2)
	Compare two protocols for inequality. More...

Detailed Description

Encapsulates the flags needed for a generic sequenced packet socket.

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

Examples

Constructing using a native address family and socket protocol:

seq_packet_protocol p(AF_INET, IPPROTO_SCTP); 

Thread Safety

Distinct objects: Safe.
Shared objects: Safe.

Concepts:

Protocol.

Definition at line 47 of file seq_packet_protocol.hpp.

Member Typedef Documentation

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

The type of an endpoint.

Definition at line 107 of file seq_packet_protocol.hpp.

typedef basic_seq_packet_socket<seq_packet_protocol> asio::generic::seq_packet_protocol::socket

The generic socket type.

Definition at line 110 of file seq_packet_protocol.hpp.

Constructor & Destructor Documentation

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

inline

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

Definition at line 51 of file seq_packet_protocol.hpp.

template<typename Protocol >

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

inline

Construct a generic protocol object from a specific protocol.

Exceptions

Definition at line 63 of file seq_packet_protocol.hpp.

Member Function Documentation

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

inline

Obtain an identifier for the protocol family.

Definition at line 87 of file seq_packet_protocol.hpp.

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

inline

Obtain an identifier for the protocol.

Definition at line 81 of file seq_packet_protocol.hpp.

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

inline

Obtain an identifier for the type of the protocol.

Definition at line 75 of file seq_packet_protocol.hpp.

Friends And Related Function Documentation

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

friend

Compare two protocols for inequality.

Definition at line 100 of file seq_packet_protocol.hpp.

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

friend

Compare two protocols for equality.

Definition at line 93 of file seq_packet_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/seq_packet_protocol.hpp