Detailed Description

Implementation of "net::Address" for UDP Dispatch.

Definition at line 72 of file udp_core.h.

#include <udp_core.h>

Inheritance diagram for satcat5::udp::Address:

Collaboration diagram for satcat5::udp::Address:

Public Member Functions
	Address (satcat5::udp::Dispatch *iface)
	Connect through the specified UDP interface. More...

void	init (satcat5::udp::Dispatch *iface)
	Deferred initialization of the upstream interface. More...

void	connect (const satcat5::udp::Addr &dstaddr, const satcat5::eth::MacAddr &dstmac, const satcat5::udp::Port &dstport, const satcat5::udp::Port &srcport=satcat5::udp::PORT_NONE, const satcat5::eth::VlanTag &vtag=satcat5::eth::VTAG_NONE)
	Manual address resolution (user supplies IP + MAC).

void	connect (const satcat5::udp::Addr &dstaddr, const satcat5::udp::Port &dstport, const satcat5::udp::Port &srcport=satcat5::udp::PORT_NONE, const satcat5::eth::VlanTag &vtag=satcat5::eth::VTAG_NONE)
	Automatic address resolution (user supplies IP only). More...

void	close () override
	Close any open connections and revert to idle. More...

bool	ready () const override
	Is this address object ready for use? Child MUST override this method.

void	retry () override
	If this Address is not in the ready() state, reattempt any steps required to do so, such as MAC address resolution. More...

satcat5::net::Dispatch *	iface () const override
	Fetch a pointer to the underlying interface. More...

satcat5::io::Writeable *	open_write (unsigned len) override
	Open a new frame to the designated address and type. More...

bool	is_multicast () const override
	Is the destination a broadcast or multicast address? Child MUST override these method.

bool	matches_reply_address () const override
	Does this Address object match the parent interface's current reply address? Multicast destinations should match any source address expected to receive the multicast message. More...

bool	reply_is_multicast () const override
	Was the parent interface's incoming message sent to a multicast address? (i.e., Could that message have many other recipients?) Child MUST override this method.

void	save_reply_address () override
	Bind this Address object to the parent interface's current reply address, as provided in net::Dispatch::open_reply(). More...

satcat5::ip::Addr	dstaddr () const

satcat5::eth::MacAddr	dstmac () const

satcat5::udp::Port	dstport () const

satcat5::eth::Dispatch *	eth () const

satcat5::eth::Header	eth_header () const

satcat5::ip::Header	ip_header (unsigned len) const

satcat5::ip::Addr	gateway () const

satcat5::eth::MacAddr	srcmac () const

satcat5::udp::Port	srcport () const

satcat5::udp::Dispatch *	udp () const

satcat5::udp::Header	udp_header (unsigned len) const

satcat5::eth::VlanTag	vtag () const

bool	write_packet (unsigned nbytes, const void *data)
	All-in-one call that writes an entire packet. More...

Protected Attributes
satcat5::udp::Dispatch *	m_iface

satcat5::ip::Address	m_addr

satcat5::udp::Port	m_dstport

satcat5::udp::Port	m_srcport

Constructor & Destructor Documentation

◆ Address()

Address::Address ( satcat5::udp::Dispatch * iface )

explicit

Connect through the specified UDP interface.

The upstream interface may be null.

See also: init.

Parameters

iface Pointer to the upstream UDP interface.

Definition at line 14 of file udp_core.cc.

Member Function Documentation

◆ close()

void satcat5::udp::Address::close ( )

inlineoverridevirtual

Close any open connections and revert to idle.

Child MUST override this method.

Implements satcat5::net::Address.

Definition at line 102 of file udp_core.h.

◆ connect()

void Address::connect	(	const satcat5::udp::Addr &	dstaddr,
		const satcat5::udp::Port &	dstport,
		const satcat5::udp::Port &	srcport = `satcat5::udp::PORT_NONE`,
		const satcat5::eth::VlanTag &	vtag = `satcat5::eth::VTAG_NONE`
	)

Automatic address resolution (user supplies IP only).

See also: ip_core.h or ip::Address for more information.

Definition at line 43 of file udp_core.cc.

◆ iface()

satcat5::net::Dispatch * Address::iface ( ) const

overridevirtual

Fetch a pointer to the underlying interface.

Child MUST override this method.

Implements satcat5::net::Address.

Definition at line 62 of file udp_core.cc.

◆ init()

void Address::init ( satcat5::udp::Dispatch * iface )

Deferred initialization of the upstream interface.

Used infrequently. If the constructor's interface argument is null, use this method to later assign the upstream interface.

Definition at line 23 of file udp_core.cc.

◆ matches_reply_address()

bool Address::matches_reply_address ( ) const

overridevirtual

Does this Address object match the parent interface's current reply address? Multicast destinations should match any source address expected to receive the multicast message.

Child MUST override this method.

Implements satcat5::net::Address.

Definition at line 55 of file udp_core.cc.

◆ open_write()

satcat5::io::Writeable * Address::open_write ( unsigned len )

overridevirtual

Open a new frame to the designated address and type.

Child MUST override this method.

Returns: Zero if sending a frame is not currently possible.

Implements satcat5::net::Address.

Definition at line 71 of file udp_core.cc.

◆ retry()

void satcat5::udp::Address::retry ( )

inlineoverridevirtual

If this Address is not in the ready() state, reattempt any steps required to do so, such as MAC address resolution.

Child SHOULD override this method if applicable.

Reimplemented from satcat5::net::Address.

Definition at line 104 of file udp_core.h.

◆ save_reply_address()

void Address::save_reply_address ( )

overridevirtual

Bind this Address object to the parent interface's current reply address, as provided in net::Dispatch::open_reply().

Child MUST override this method.

Implements satcat5::net::Address.

Definition at line 75 of file udp_core.cc.

◆ write_packet()

bool Address::write_packet	(	unsigned	nbytes,
		const void *	data
	)

inherited

All-in-one call that writes an entire packet.

Equivalent to open_write(), io::Writeable::write_bytes(), io::Writeable::write_finalize().

Definition at line 11 of file net_address.cc.

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

Detailed Description

Public Member Functions

Protected Attributes

Constructor & Destructor Documentation

◆ Address()

Member Function Documentation

◆ close()

◆ connect()

◆ iface()

◆ init()

◆ matches_reply_address()

◆ open_write()

◆ retry()

◆ save_reply_address()

◆ write_packet()