boost::asio::ip::icmp Class Reference

Encapsulates the flags needed for ICMP. More...

#include <icmp.hpp>

Public Types
typedef basic_endpoint< icmp >	endpoint
	The type of a ICMP endpoint. More...
typedef basic_raw_socket< icmp >	socket
	The ICMP socket type. More...
typedef basic_resolver< icmp >	resolver
	The ICMP 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 icmp	v4 ()
	Construct to represent the IPv4 ICMP protocol. More...
static icmp	v6 ()
	Construct to represent the IPv6 ICMP protocol. More...

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

Detailed Description

Encapsulates the flags needed for ICMP.

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

Thread Safety

Distinct objects: Safe.
Shared objects: Safe.

Concepts:

Protocol, InternetProtocol.

Member Typedef Documentation

typedef basic_endpoint<icmp> boost::asio::ip::icmp::endpoint

The type of a ICMP endpoint.

typedef basic_resolver<icmp> boost::asio::ip::icmp::resolver

The ICMP resolver type.

typedef basic_raw_socket<icmp> boost::asio::ip::icmp::socket

The ICMP socket type.

Member Function Documentation

int boost::asio::ip::icmp::family ( ) const

inline

Obtain an identifier for the protocol family.

int boost::asio::ip::icmp::protocol ( ) const

inline

Obtain an identifier for the protocol.

int boost::asio::ip::icmp::type ( ) const

inline

Obtain an identifier for the type of the protocol.

static icmp boost::asio::ip::icmp::v4 ( )

inlinestatic

Construct to represent the IPv4 ICMP protocol.

static icmp boost::asio::ip::icmp::v6 ( )

inlinestatic

Construct to represent the IPv6 ICMP protocol.

Friends And Related Function Documentation

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

friend

Compare two protocols for inequality.

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

friend

Compare two protocols for equality.

---

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

• boost_1_57_0/boost/asio/ip/icmp.hpp