join::NeighborManager Class Reference

ARP / NDP neighbor manager class. More...

#include <neighbormanager.hpp>

Inheritance diagram for join::NeighborManager:

Collaboration diagram for join::NeighborManager:

Public Types
using	NeighborNotify = std::function<void (const NeighborInfo& info)>

Public Member Functions
	NeighborManager (Reactor &reactor=ReactorThread::reactor())
	create instance.
	NeighborManager (const NeighborManager &other)=delete
	create instance by copy.
	NeighborManager (NeighborManager &&other)=delete
	create instance by move.
NeighborManager &	operator= (const NeighborManager &other)=delete
	assign instance by copy.
NeighborManager &	operator= (NeighborManager &&other)=delete
	assign instance by move.
	~NeighborManager ()
	destroy instance.
Neighbor::Ptr	findByIndex (uint32_t index, const IpAddress &ipAddress)
	find a neighbor entry by interface index and IP address.
Neighbor::Ptr	findByName (const std::string &interfaceName, const IpAddress &ipAddress)
	find a neighbor entry by interface name and IP address.
NeighborList	enumerate ()
	enumerate all cached neighbor entries.
NeighborList	enumerate (uint32_t index)
	enumerate all cached neighbor entries for a given interface.
NeighborList	enumerate (const std::string &interfaceName)
	enumerate all cached neighbor entries for a given interface.
int	refresh ()
	refresh all data.
uint64_t	addNeighborListener (const NeighborNotify &cb)
	register a callback invoked on any neighbor table change.
void	removeNeighborListener (uint64_t id)
	unregister a previously registered callback.
int	addNeighbor (uint32_t index, const IpAddress &ipAddress, const MacAddress &macAddress, uint16_t state=NUD_PERMANENT, bool sync=false)
	add or replace a neighbor entry in the kernel table.
int	addNeighbor (const std::string &interfaceName, const IpAddress &ipAddress, const MacAddress &macAddress, uint16_t state=NUD_PERMANENT, bool sync=false)
	add or replace a neighbor entry in the kernel table.
int	removeNeighbor (uint32_t index, const IpAddress &ipAddress, bool sync=false)
	remove a neighbor entry from the kernel table.
int	removeNeighbor (const std::string &interfaceName, const IpAddress &ipAddress, bool sync=false)
	remove a neighbor entry from the kernel table.
int	flushNeighbors (uint32_t index, bool sync=false)
	flush all neighbor entries for a given interface.
int	flushNeighbors (const std::string &interfaceName, bool sync=false)
	flush all neighbor entries for a given interface.
Public Member Functions inherited from join::NetlinkManager
	NetlinkManager (uint32_t groups, Reactor &reactor=ReactorThread::reactor())
	create instance.
	NetlinkManager (const NetlinkManager &)=delete
	create instance by copy.
	NetlinkManager (NetlinkManager &&)=delete
	create instance by move.
NetlinkManager &	operator= (const NetlinkManager &)=delete
	assign instance by copy.
NetlinkManager &	operator= (NetlinkManager &&)=delete
	assign instance by move.
virtual	~NetlinkManager ()
	destroy instance.
Reactor &	reactor () const noexcept
	get the event loop reactor.
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.

Static Public Member Functions
static NeighborManager &	instance ()
	get the a singleton instance.

Friends
class	Neighbor

Additional Inherited Members
Protected Member Functions inherited from join::NetlinkManager
void	start ()
	start listening for netlink events.
void	stop ()
	stop listening for netlink events.
int	sendRequest (struct nlmsghdr *nlh, bool sync, std::chrono::milliseconds timeout=std::chrono::seconds(5))
	send a netlink request, optionally waiting for the ack.
template<typename Func , typename... Args>
void	pushJob (Func &&func, Args &&... args) noexcept
	push a job to be executed on the reactor thread.
virtual void	onReadable (int fd) override final
	method called when data are ready to be read on handle.
void	notifyRequest (uint32_t seq, int error=0)
	notify a pending synchronous request.
Protected Member Functions inherited from join::EventHandler
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 inherited from join::NetlinkManager
static void	addAttributes (struct nlmsghdr *nlh, int type, const void *data, int alen)
	add an attribute to a netlink message.
static struct rtattr *	startNestedAttributes (struct nlmsghdr *nlh, int type)
	open a nested attribute block.
static int	stopNestedAttributes (struct nlmsghdr *nlh, struct rtattr *nested)
	close a nested attribute block.
template<typename T , typename Flag >
static Flag	updateValue (T &oldVal, const T &newVal, Flag changed)
	update a value in place and report whether it changed.
Protected Attributes inherited from join::NetlinkManager
std::unique_ptr< char[]>	_buffer
	internal read buffer.
std::atomic< uint32_t >	_seq
	sequence number.
std::unordered_map< uint32_t, std::unique_ptr< PendingRequest > >	_pending
	synchronous requests indexed by sequence number.
Mutex	_syncMutex
	protection mutex.
LocalMem::Mpsc::Queue< Job * >	_jobs
	job queue.
int	_wakeup = -1
	eventfd used to wake the reactor thread for pending jobs.
Reactor &	_reactor
	event loop reactor.
Static Protected Attributes inherited from join::NetlinkManager
static constexpr size_t	_bufferSize = 16384
	internal buffer size.
static constexpr size_t	_jobQueueSize = 256
	job queue size.

Detailed Description

ARP / NDP neighbor manager class.

Member Typedef Documentation

NeighborNotify

using join::NeighborManager::NeighborNotify = std::function<void (const NeighborInfo& info)>

Constructor & Destructor Documentation

NeighborManager() [1/3]

NeighborManager::NeighborManager ( Reactor & reactor = ReactorThread::reactor () )

explicit

create instance.

Parameters

reactor

event loop reactor (uses ReactorThread if nullptr).

NeighborManager() [2/3]

join::NeighborManager::NeighborManager ( const NeighborManager & other )

delete

create instance by copy.

Parameters

other

other interface to copy.

NeighborManager() [3/3]

join::NeighborManager::NeighborManager ( NeighborManager && other )

delete

create instance by move.

Parameters

other

other interface to move.

~NeighborManager()

NeighborManager::~NeighborManager

(

)

destroy instance.

Member Function Documentation

addNeighbor() [1/2]

int NeighborManager::addNeighbor	(	const std::string &	interfaceName,
		const IpAddress &	ipAddress,
		const MacAddress &	macAddress,
		uint16_t	state = NUD_PERMANENT,
		bool	sync = false )

add or replace a neighbor entry in the kernel table.

Parameters

interfaceName	interface name.
ipAddress	destination address.
macAddress	address to associate.
state	NUD state (default: NUD_PERMANENT).
sync	wait for completion.

Returns

0 on success, -1 on failure.

addNeighbor() [2/2]

int NeighborManager::addNeighbor	(	uint32_t	index,
		const IpAddress &	ipAddress,
		const MacAddress &	macAddress,
		uint16_t	state = NUD_PERMANENT,
		bool	sync = false )

add or replace a neighbor entry in the kernel table.

Parameters

index	interface index.
ipAddress	destination address.
macAddress	address to associate.
state	NUD state (default: NUD_PERMANENT).
sync	wait for completion.

Returns

0 on success, -1 on failure.

addNeighborListener()

uint64_t NeighborManager::addNeighborListener

(

const NeighborNotify &

cb

)

register a callback invoked on any neighbor table change.

Parameters

cb	callback to register.

Returns

unique id for the callback.

enumerate() [1/3]

NeighborList NeighborManager::enumerate

(

)

enumerate all cached neighbor entries.

Returns

snapshot of the current neighbor list.

enumerate() [2/3]

NeighborList NeighborManager::enumerate

(

const std::string &

interfaceName

)

enumerate all cached neighbor entries for a given interface.

Parameters

interfaceName

interface name.

Returns

snapshot of neighbor entries on that interface.

enumerate() [3/3]

NeighborList NeighborManager::enumerate

(

uint32_t

index

)

enumerate all cached neighbor entries for a given interface.

Parameters

index

interface index.

Returns

snapshot of neighbor entries on that interface.

findByIndex()

Neighbor::Ptr NeighborManager::findByIndex	(	uint32_t	index,
		const IpAddress &	ipAddress )

find a neighbor entry by interface index and IP address.

Parameters

index	interface index.
ipAddress	destination address.

Returns

neighbor pointer, or nullptr if not found.

findByName()

Neighbor::Ptr NeighborManager::findByName	(	const std::string &	interfaceName,
		const IpAddress &	ipAddress )

find a neighbor entry by interface name and IP address.

Parameters

interfaceName	interface name.
ipAddress	destination address.

Returns

neighbor pointer, or nullptr if not found.

flushNeighbors() [1/2]

int NeighborManager::flushNeighbors	(	const std::string &	interfaceName,
		bool	sync = false )

flush all neighbor entries for a given interface.

Parameters

interfaceName	interface name.
sync	wait for completion.

Returns

0 on success, -1 on failure.

flushNeighbors() [2/2]

int NeighborManager::flushNeighbors	(	uint32_t	index,
		bool	sync = false )

flush all neighbor entries for a given interface.

Parameters

index	interface index.
sync	wait for completion.

Returns

0 on success, -1 on failure.

instance()

NeighborManager & NeighborManager::instance ( )

static

get the a singleton instance.

Returns

reference to the singleton instance.

operator=() [1/2]

NeighborManager & join::NeighborManager::operator= ( const NeighborManager & other )

delete

assign instance by copy.

Parameters

other

other interface to copy.

Returns

A reference of the current object.

operator=() [2/2]

NeighborManager & join::NeighborManager::operator= ( NeighborManager && other )

delete

assign instance by move.

Parameters

other

other interface to move.

Returns

A reference of the current object.

refresh()

int NeighborManager::refresh

(

)

refresh all data.

Returns

0 on success, -1 on failure.

removeNeighbor() [1/2]

int NeighborManager::removeNeighbor	(	const std::string &	interfaceName,
		const IpAddress &	ipAddress,
		bool	sync = false )

remove a neighbor entry from the kernel table.

Parameters

interfaceName	interface name.
ipAddress	destination address.
sync	wait for completion.

Returns

0 on success, -1 on failure.

removeNeighbor() [2/2]

int NeighborManager::removeNeighbor	(	uint32_t	index,
		const IpAddress &	ipAddress,
		bool	sync = false )

remove a neighbor entry from the kernel table.

Parameters

index	interface index.
ipAddress	destination address.
sync	wait for completion.

Returns

0 on success, -1 on failure.

removeNeighborListener()

void NeighborManager::removeNeighborListener

(

uint64_t

id

)

unregister a previously registered callback.

Parameters

id	unique id of the callback function to remove.

Friends And Related Symbol Documentation

Neighbor

friend class Neighbor

friend

---

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

• fabric/include/join/neighbormanager.hpp
• fabric/src/neighbormanager.cpp