asio::ip::udp Class Reference

Encapsulates the flags needed for UDP. More...

#include <udp.hpp>

List of all members.

Public Types

typedef basic_endpoint< udpendpoint
 The type of a UDP endpoint.
typedef basic_resolver_query< udpresolver_query
 The type of a resolver query.
typedef
basic_resolver_iterator< udp
resolver_iterator
 The type of a resolver iterator.
typedef basic_datagram_socket
< udp
socket
 The IPv4 UDP socket type.
typedef basic_resolver< udpresolver
 The UDP resolver type.

Public Member Functions

int type () const
 Obtain an identifier for the type of the protocol.
int protocol () const
 Obtain an identifier for the protocol.
int family () const
 Obtain an identifier for the protocol family.

Static Public Member Functions

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

Private Member Functions

 udp (int family)

Private Attributes

int family_

Friends

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


Detailed Description

Encapsulates the flags needed for UDP.

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

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

Definition at line 41 of file udp.hpp.


Member Typedef Documentation

The type of a UDP endpoint.

Definition at line 45 of file udp.hpp.

The type of a resolver query.

Definition at line 48 of file udp.hpp.

The type of a resolver iterator.

Definition at line 51 of file udp.hpp.

The IPv4 UDP socket type.

Definition at line 84 of file udp.hpp.

The UDP resolver type.

Definition at line 87 of file udp.hpp.


Constructor & Destructor Documentation

asio::ip::udp::udp ( int  family  )  [inline, explicit, private]

Definition at line 103 of file udp.hpp.

Referenced by v4(), and v6().


Member Function Documentation

static udp asio::ip::udp::v4 (  )  [inline, static]

Construct to represent the IPv4 UDP protocol.

Definition at line 54 of file udp.hpp.

References udp().

static udp asio::ip::udp::v6 (  )  [inline, static]

Construct to represent the IPv4 UDP protocol.

Definition at line 60 of file udp.hpp.

References udp().

int asio::ip::udp::type (  )  const [inline]

Obtain an identifier for the type of the protocol.

Definition at line 66 of file udp.hpp.

int asio::ip::udp::protocol (  )  const [inline]

Obtain an identifier for the protocol.

Definition at line 72 of file udp.hpp.

int asio::ip::udp::family (  )  const [inline]

Obtain an identifier for the protocol family.

Definition at line 78 of file udp.hpp.

References family_.


Friends And Related Function Documentation

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

Compare two protocols for equality.

Definition at line 90 of file udp.hpp.

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

Compare two protocols for inequality.

Definition at line 96 of file udp.hpp.


Member Data Documentation

int asio::ip::udp::family_ [private]

Definition at line 108 of file udp.hpp.

Referenced by family().


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

Generated on Sun May 25 00:21:36 2008 by  doxygen 1.5.6