All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Defines
Public Types | Public Member Functions | Static Public Member Functions | Private Member Functions | Private Attributes | Friends
asio::ip::icmp Class Reference

Encapsulates the flags needed for ICMP. More...

#include <icmp.hpp>

List of all members.

Public Types

typedef basic_endpoint< icmpendpoint
 The type of a ICMP endpoint.
typedef basic_resolver< icmpresolver
 The ICMP resolver type.
typedef
basic_resolver_iterator< icmp
resolver_iterator
 The type of a resolver iterator.
typedef basic_resolver_query
< icmp
resolver_query
 The type of a resolver query.
typedef basic_raw_socket< icmpsocket
 The ICMP socket type.

Public Member Functions

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

Static Public Member Functions

static icmp v4 ()
 Construct to represent the IPv4 ICMP protocol.
static icmp v6 ()
 Construct to represent the IPv6 ICMP protocol.

Private Member Functions

 icmp (int protocol, int family)

Private Attributes

int family_
int protocol_

Friends

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

Detailed Description

Encapsulates the flags needed for ICMP.

The asio::ip::icmp class contains flags necessary for ICMP sockets.

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

Definition at line 41 of file icmp.hpp.


Member Typedef Documentation

The type of a ICMP endpoint.

Definition at line 45 of file icmp.hpp.

The ICMP resolver type.

Definition at line 87 of file icmp.hpp.

The type of a resolver iterator.

Definition at line 51 of file icmp.hpp.

The type of a resolver query.

Definition at line 48 of file icmp.hpp.

The ICMP socket type.

Definition at line 84 of file icmp.hpp.


Constructor & Destructor Documentation

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

Definition at line 103 of file icmp.hpp.


Member Function Documentation

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

Obtain an identifier for the protocol family.

Definition at line 78 of file icmp.hpp.

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

Obtain an identifier for the protocol.

Definition at line 72 of file icmp.hpp.

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

Obtain an identifier for the type of the protocol.

Definition at line 66 of file icmp.hpp.

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

Construct to represent the IPv4 ICMP protocol.

Definition at line 54 of file icmp.hpp.

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

Construct to represent the IPv6 ICMP protocol.

Definition at line 60 of file icmp.hpp.


Friends And Related Function Documentation

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

Compare two protocols for inequality.

Definition at line 96 of file icmp.hpp.

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

Compare two protocols for equality.

Definition at line 90 of file icmp.hpp.


Member Data Documentation

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

Definition at line 110 of file icmp.hpp.

Definition at line 109 of file icmp.hpp.


The documentation for this class was generated from the following file:
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Defines


Castor
Author(s): Carpe Noctem
autogenerated on Fri Nov 8 2013 11:05:41