join::Dhcp Class Reference

dynamic host configuration protocol class. More...

#include <dhcp_protocol.hpp>

Public Types
using	Transport = Raw
using	Endpoint = typename Transport::Endpoint
using	Socket = typename Transport::Socket
using	Client = BasicDhcpClient<Dhcp>
using	Server = BasicDhcpServer<Dhcp>

Public Member Functions
constexpr	Dhcp () noexcept=default
	construct the DHCP 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 Attributes
static constexpr uint16_t	clientPort = 68
	port a client listens on.
static constexpr uint16_t	serverPort = 67
	port a server listens on.
static constexpr size_t	maxMsgSize = 1472
	maximum DHCP message size.

Detailed Description

dynamic host configuration protocol class.

Member Typedef Documentation

Client

using join::Dhcp::Client = BasicDhcpClient<Dhcp>

Endpoint

using join::Dhcp::Endpoint = typename Transport::Endpoint

Server

using join::Dhcp::Server = BasicDhcpServer<Dhcp>

Socket

using join::Dhcp::Socket = typename Transport::Socket

Transport

using join::Dhcp::Transport = Raw

Constructor & Destructor Documentation

Dhcp()

join::Dhcp::Dhcp ( )

constexprdefaultnoexcept

construct the DHCP protocol instance.

Member Function Documentation

family()

int join::Dhcp::family ( ) const

inlineconstexprnoexcept

get the protocol IP address family.

Returns

the protocol IP address family.

protocol()

int join::Dhcp::protocol ( ) const

inlineconstexprnoexcept

get the protocol type.

Returns

the protocol type.

type()

int join::Dhcp::type ( ) const

inlineconstexprnoexcept

get the protocol communication semantic.

Returns

the protocol communication semantic.

Member Data Documentation

clientPort

uint16_t join::Dhcp::clientPort = 68

staticconstexpr

port a client listens on.

maxMsgSize

size_t join::Dhcp::maxMsgSize = 1472

staticconstexpr

maximum DHCP message size.

serverPort

uint16_t join::Dhcp::serverPort = 67

staticconstexpr

port a server listens on.

---

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

• fabric/include/join/dhcp_protocol.hpp