Boost  v1.57.0
doxygen for www.boost.org
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Modules Pages
boost::asio::ip::udp Class Reference

Encapsulates the flags needed for UDP. More...

#include <udp.hpp>

Public Types

typedef basic_endpoint< udpendpoint
 The type of a UDP endpoint. More...
 
typedef basic_datagram_socket
< udp
socket
 The UDP socket type. More...
 
typedef basic_resolver< udpresolver
 The UDP resolver type. More...
 

Public Member Functions

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...
 

Static Public Member Functions

static udp v4 ()
 Construct to represent the IPv4 UDP protocol. More...
 
static udp v6 ()
 Construct to represent the IPv6 UDP protocol. More...
 

Friends

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

Detailed Description

Encapsulates the flags needed for UDP.

The boost::asio::ip::udp class contains flags necessary for UDP sockets.

Thread Safety
Distinct objects: Safe.
Shared objects: Safe.
Concepts:
Protocol, InternetProtocol.

Member Typedef Documentation

The type of a UDP endpoint.

The UDP resolver type.

Member Function Documentation

int boost::asio::ip::udp::family ( ) const
inline

Obtain an identifier for the protocol family.

int boost::asio::ip::udp::protocol ( ) const
inline

Obtain an identifier for the protocol.

int boost::asio::ip::udp::type ( ) const
inline

Obtain an identifier for the type of the protocol.

static udp boost::asio::ip::udp::v4 ( )
inlinestatic

Construct to represent the IPv4 UDP protocol.

static udp boost::asio::ip::udp::v6 ( )
inlinestatic

Construct to represent the IPv6 UDP protocol.

Friends And Related Function Documentation

bool operator!= ( const udp p1,
const udp p2 
)
friend

Compare two protocols for inequality.

bool operator== ( const udp p1,
const udp p2 
)
friend

Compare two protocols for equality.


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