asio::generic::datagram_protocol Class Reference

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

#include <datagram_protocol.hpp>

Public Types
typedef basic_endpoint< datagram_protocol >	endpoint
	The type of an endpoint. More...
typedef basic_datagram_socket< datagram_protocol >	socket
	The generic socket type. More...

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

Detailed Description

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

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

Examples

Constructing using a native address family and socket protocol:

datagram_protocol p(AF_INET, IPPROTO_UDP); 

Constructing from a specific protocol type:

datagram_protocol p(asio::ip::udp::v4()); 

Thread Safety

Distinct objects: Safe.
Shared objects: Safe.

Concepts:

Protocol.

Definition at line 49 of file datagram_protocol.hpp.

Member Typedef Documentation

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

The type of an endpoint.

Definition at line 108 of file datagram_protocol.hpp.

typedef basic_datagram_socket<datagram_protocol> asio::generic::datagram_protocol::socket

The generic socket type.

Definition at line 111 of file datagram_protocol.hpp.

Constructor & Destructor Documentation

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

inline

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

Definition at line 53 of file datagram_protocol.hpp.

template<typename Protocol >

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

inline

Construct a generic protocol object from a specific protocol.

Exceptions

Definition at line 64 of file datagram_protocol.hpp.

Member Function Documentation

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

inline

Obtain an identifier for the protocol family.

Definition at line 88 of file datagram_protocol.hpp.

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

inline

Obtain an identifier for the protocol.

Definition at line 82 of file datagram_protocol.hpp.

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

inline

Obtain an identifier for the type of the protocol.

Definition at line 76 of file datagram_protocol.hpp.

Friends And Related Function Documentation

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

friend

Compare two protocols for inequality.

Definition at line 101 of file datagram_protocol.hpp.

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

friend

Compare two protocols for equality.

Definition at line 94 of file datagram_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/datagram_protocol.hpp