join::BasicDhcp< Protocol > Class Template Reference

carries DHCP messages over a packet socket. More...

#include <dhcp.hpp>

Inheritance diagram for join::BasicDhcp< Protocol >:

Collaboration diagram for join::BasicDhcp< Protocol >:

Public Types
using	Socket = typename Protocol::Socket

Public Member Functions
	BasicDhcp ()=delete
	create the BasicDhcp instance.
	BasicDhcp (const std::string &interface, Reactor &reactor=ReactorThread::reactor())
	create the instance bound to the given interface.
	BasicDhcp (const BasicDhcp &other)=delete
	create instance by copy.
BasicDhcp &	operator= (const BasicDhcp &other)=delete
	assign instance by copy.
	BasicDhcp (BasicDhcp &&other)=delete
	create instance by move.
BasicDhcp &	operator= (BasicDhcp &&other)=delete
	assign instance by move.
virtual	~BasicDhcp ()
	destroy the instance.
const std::string &	interface () const noexcept
	get the name of the interface the instance is bound to.
const MacAddress &	hardware () const noexcept
	get the hardware address of the interface the instance is bound to.
Public Member Functions inherited from join::EventHandler
	EventHandler ()=default
	create instance.
	EventHandler (const EventHandler &other)=default
	copy constructor.
EventHandler &	operator= (const EventHandler &other)=default
	copy assignment operator.
	EventHandler (EventHandler &&other)=default
	move constructor.
EventHandler &	operator= (EventHandler &&other)=default
	move assignment operator.
virtual	~EventHandler ()=default
	destroy instance.

Protected Member Functions
struct	__attribute__ ((packed)) Frame
	link, internet and transport headers a DHCP message is framed with.
struct	__attribute__ ((packed)) Pseudo
	header the UDP checksum is computed over, RFC 768.
virtual void	onMessage (DhcpPacket::Ptr packet)=0
	method called when a DHCP message is received.
void	onReadable (int fd) override final
	method called when data are ready to be read.
int	transmit (const DhcpPacket &packet, const IpAddress &source, const IpAddress &destination)
	frame a message and write it on the wire.
DhcpPacket::Ptr	receive (const char *data, size_t size) const
	decode a frame received on the wire.
Protected Member Functions inherited from join::EventHandler
virtual void	onEvent (int fd, uint32_t revents)
	method called when events are reported on handle.
virtual void	onWriteable (int fd)
	method called when data are ready to be written on handle.
virtual void	onClose (int fd)
	method called when handle was closed by the peer.
virtual void	onError (int fd)
	method called when an error occurred on handle.

Static Protected Member Functions
static uint16_t	udpChecksum (const Frame &frame, const char *payload, size_t size)
	compute the checksum of a UDP datagram, RFC 768.

Protected Attributes
Socket	_socket
	underlying socket.
DhcpMessage	_message
	DHCP message codec.
std::unique_ptr< char[]>	_buffer
	receive buffer.
const std::string	_interface
	interface name.
const MacAddress	_hardware
	hardware address of the interface.
Reactor &	_reactor
	event loop reactor.

Detailed Description

template<class Protocol>
class join::BasicDhcp< Protocol >

carries DHCP messages over a packet socket.

Member Typedef Documentation

Socket

template<class Protocol >

using join::BasicDhcp< Protocol >::Socket = typename Protocol::Socket

Constructor & Destructor Documentation

BasicDhcp() [1/4]

template<class Protocol >

join::BasicDhcp< Protocol >::BasicDhcp ( )

delete

create the BasicDhcp instance.

BasicDhcp() [2/4]

template<class Protocol >

join::BasicDhcp< Protocol >::BasicDhcp ( const std::string & interface, Reactor & reactor = ReactorThread::reactor () )

inlineexplicit

create the instance bound to the given interface.

Parameters

interface	interface name.
reactor	reactor instance.

Exceptions

std::system_error

if the interface is unknown or the socket could not be bound to it.

BasicDhcp() [3/4]

template<class Protocol >

join::BasicDhcp< Protocol >::BasicDhcp ( const BasicDhcp< Protocol > & other )

delete

create instance by copy.

Parameters

other

other object to copy.

BasicDhcp() [4/4]

template<class Protocol >

join::BasicDhcp< Protocol >::BasicDhcp ( BasicDhcp< Protocol > && other )

delete

create instance by move.

Parameters

other

other object to move.

~BasicDhcp()

template<class Protocol >

virtual join::BasicDhcp< Protocol >::~BasicDhcp ( )

inlinevirtual

destroy the instance.

Member Function Documentation

__attribute__() [1/2]

template<class Protocol >

struct join::BasicDhcp< Protocol >::__attribute__ ( (packed) )

inlineprotected

link, internet and transport headers a DHCP message is framed with.

__attribute__() [2/2]

template<class Protocol >

struct join::BasicDhcp< Protocol >::__attribute__ ( (packed) )

inlineprotected

header the UDP checksum is computed over, RFC 768.

hardware()

template<class Protocol >

const MacAddress & join::BasicDhcp< Protocol >::hardware ( ) const

inlinenoexcept

get the hardware address of the interface the instance is bound to.

Returns

the hardware address.

interface()

template<class Protocol >

const std::string & join::BasicDhcp< Protocol >::interface ( ) const

inlinenoexcept

get the name of the interface the instance is bound to.

Returns

the interface name.

onMessage()

template<class Protocol >

virtual void join::BasicDhcp< Protocol >::onMessage ( DhcpPacket::Ptr packet )

protectedpure virtual

method called when a DHCP message is received.

Parameters

packet

message received.

Implemented in join::BasicDhcpClient< Protocol >, and join::BasicDhcpServer< Protocol >.

onReadable()

template<class Protocol >

void join::BasicDhcp< Protocol >::onReadable ( int fd )

inlinefinaloverrideprotectedvirtual

method called when data are ready to be read.

Parameters

fd	file descriptor.

Reimplemented from join::EventHandler.

operator=() [1/2]

template<class Protocol >

BasicDhcp & join::BasicDhcp< Protocol >::operator= ( BasicDhcp< Protocol > && other )

delete

assign instance by move.

Parameters

other

other object to move.

Returns

a reference of the current object.

operator=() [2/2]

template<class Protocol >

BasicDhcp & join::BasicDhcp< Protocol >::operator= ( const BasicDhcp< Protocol > & other )

delete

assign instance by copy.

Parameters

other

other object to copy.

Returns

a reference of the current object.

receive()

template<class Protocol >

DhcpPacket::Ptr join::BasicDhcp< Protocol >::receive ( const char * data, size_t size ) const

inlineprotected

decode a frame received on the wire.

Parameters

data	frame received.
size	frame size.

Returns

the message decoded, nullptr if the frame does not carry one.

transmit()

template<class Protocol >

int join::BasicDhcp< Protocol >::transmit ( const DhcpPacket & packet, const IpAddress & source, const IpAddress & destination )

inlineprotected

frame a message and write it on the wire.

Parameters

packet	message to send.
source	source address.
destination	destination address.

Returns

0 on success, -1 on failure.

udpChecksum()

template<class Protocol >

static uint16_t join::BasicDhcp< Protocol >::udpChecksum ( const Frame & frame, const char * payload, size_t size )

inlinestaticprotected

compute the checksum of a UDP datagram, RFC 768.

Parameters

frame	frame carrying the datagram, its checksum field must be zero.
payload	datagram payload.
size	payload size.

Returns

the checksum.

Member Data Documentation

_buffer

template<class Protocol >

std::unique_ptr<char[]> join::BasicDhcp< Protocol >::_buffer

protected

receive buffer.

_hardware

template<class Protocol >

const MacAddress join::BasicDhcp< Protocol >::_hardware

protected

hardware address of the interface.

_interface

template<class Protocol >

const std::string join::BasicDhcp< Protocol >::_interface

protected

interface name.

_message

template<class Protocol >

DhcpMessage join::BasicDhcp< Protocol >::_message

protected

DHCP message codec.

_reactor

template<class Protocol >

Reactor& join::BasicDhcp< Protocol >::_reactor

protected

event loop reactor.

_socket

template<class Protocol >

Socket join::BasicDhcp< Protocol >::_socket

protected

underlying socket.

---

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

• fabric/include/join/dhcp.hpp
• fabric/include/join/dhcp_protocol.hpp