join::Icmp Class Reference

ICMP protocol class. More...

#include <protocol.hpp>

Public Types
using	Endpoint = BasicInternetEndpoint <Icmp>
using	Socket = BasicDatagramSocket <Icmp>

Public Member Functions
constexpr	Icmp (int family=AF_INET) noexcept
	create the icmp protocol instance.
constexpr int	family () const noexcept
	get the protocol IP address family.
constexpr int	type () const noexcept
	get the protocol communication semantic.
constexpr int	protocol () const noexcept
	get the protocol type.

Static Public Member Functions
static Icmp &	v4 () noexcept
	get protocol suitable for IPv4 address family.
static Icmp &	v6 () noexcept
	get protocol suitable for IPv6 address family.

Detailed Description

ICMP protocol class.

Member Typedef Documentation

Endpoint

using join::Icmp::Endpoint = BasicInternetEndpoint <Icmp>

Socket

using join::Icmp::Socket = BasicDatagramSocket <Icmp>

Constructor & Destructor Documentation

Icmp()

join::Icmp::Icmp ( int family = AF_INET )

inlineconstexprnoexcept

create the icmp protocol instance.

Parameters

family

IP address family.

Member Function Documentation

family()

int join::Icmp::family ( ) const

inlineconstexprnoexcept

get the protocol IP address family.

Returns

the protocol IP address family.

protocol()

int join::Icmp::protocol ( ) const

inlineconstexprnoexcept

get the protocol type.

Returns

the protocol type.

type()

int join::Icmp::type ( ) const

inlineconstexprnoexcept

get the protocol communication semantic.

Returns

the protocol communication semantic.

v4()

static Icmp & join::Icmp::v4 ( )

inlinestaticnoexcept

get protocol suitable for IPv4 address family.

Returns

an IPv4 address family suitable protocol.

v6()

static Icmp & join::Icmp::v6 ( )

inlinestaticnoexcept

get protocol suitable for IPv6 address family.

Returns

an IPv6 address family suitable protocol.

---

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

• core/include/join/protocol.hpp