olsr::msg::Message Class Reference

The abstract message class. More...

#include <message.hh>

Inheritance diagram for olsr::msg::Message:

List of all members.

Public Member Functions
virtual	~Message ()
virtual bool	dump (utl::Data &, const address_t &) const =0
virtual void	inc_seqnum ()
Static Public Member Functions
static void	parse (utl::Data d, const address_t &sender, const address_t &receiver, const seqnum_t &pseqnum)
static void	forward (utl::Data &d, const header &mh)
Static Public Attributes
static const ::size_t	min_length = sizeof (raw)
	Minimum length of a message.
Static Protected Attributes
static utl::Seqnum< u_int16_t >	seqnum
	The message sequence number.
Classes
struct	header
struct	raw
	Convenience data structure of the message header. More...

---

Detailed Description

The abstract message class.

---

Constructor & Destructor Documentation

virtual olsr::msg::Message::~Message

(

)

[inline, virtual]

The message destructor.

---

Member Function Documentation

virtual bool olsr::msg::Message::dump	(	utl::Data &	,
		const address_t &
	)			const [pure virtual]

The virtual dump method, forwarded to the actual message dump method.

Implemented in olsr::msg::HELLOMessage, olsr::msg::HNAMessage, olsr::msg::UnknownMessage, olsr::msg::MIDMessage, and olsr::msg::TCMessage.

Referenced by olsr::pkt::Packet::add_message().

virtual void olsr::msg::Message::inc_seqnum

(

)

[inline, virtual]

The sequence number incrementing method.

This is used for the case when a message is split in two separate messages. The second message's sequence number then needs to be incremented. FIXME: I don't see why this should be a virtual method right now...

Reimplemented in olsr::msg::UnknownMessage.

References seqnum.

void olsr::msg::Message::parse	(	utl::Data	d,
		const address_t &	sender,
		const address_t &	receiver,
		const seqnum_t &	pseqnum
	)			[inline, static]

The parsing routine.

• d Data buffer to parse
• sender Address of sending interface
• receiver Address of receiving interface
• pseqnum Packet sequence number

This is the general message parser, that further dispatches to specific message parsers if the message's type is known.

References olsr::msg::Message::raw::addr, ADDRESS_SIZE, olsr::debug, olsr::dup_set, olsr::set::DuplicateSet::dupset(), forward(), HELLO_MESSAGE, HNA_MESSAGE, olsr::msg::Message::raw::hopcount, olsr::main_addr, olsr::set::DuplicateEntry::make_key(), MID_MESSAGE, olsr::msg::HNAMessage::parse(), olsr::msg::MIDMessage::parse(), olsr::msg::TCMessage::parse(), olsr::msg::HELLOMessage::parse(), olsr::utl::Data::raw(), olsr::msg::Message::raw::seqnum, seqnum, olsr::msg::Message::raw::size, olsr::utl::Data_< Self >::size(), TC_MESSAGE, olsr::msg::Message::raw::ttl, olsr::msg::Message::raw::type, and olsr::msg::Message::raw::vtime.

Referenced by olsr::pkt::Packet::parse().

void olsr::msg::Message::forward	(	utl::Data &	d,
		const header &	mh
	)			[inline, static]

The forwarding routine

• d Data of the message to forward
• mh message header

This does forwarding for the message. Actual forwarders for any known message are called.

References olsr::cproxy, olsr::dup_set, olsr::set::DuplicateSet::dupset(), olsr::msg::Message::raw::hopcount, olsr::utl::TimeVal::in_jitter(), olsr::sch::Scheduler::insert(), olsr::set::DuplicateSet::insert(), olsr::set::CoherenceProxy::linkset(), olsr::alg::main_addr_of(), olsr::set::Neighbor::make_key(), olsr::set::DuplicateEntry::make_key(), olsr::set::Link::make_key(), olsr::cst::maxjitter, olsr::msg::Message::header::originator, olsr::utl::Data::raw(), olsr::msg::Message::header::receiver, olsr::scheduler, olsr::msg::Message::header::sender, olsr::msg::Message::raw::seqnum, olsr::set::CoherenceProxy::sym_neighborset(), and olsr::msg::Message::raw::ttl.

Referenced by parse().

---

Member Data Documentation

const ::size_t olsr::msg::Message::min_length = sizeof (raw) [static]

Minimum length of a message.

Reimplemented in olsr::msg::HELLOMessage, olsr::msg::HNAMessage, olsr::msg::MIDMessage, and olsr::msg::TCMessage.

Referenced by olsr::msg::TCMessage::dump(), olsr::msg::MIDMessage::dump(), olsr::msg::HNAMessage::dump(), olsr::msg::HELLOMessage::dump(), and olsr::pkt::Packet::parse().

utl::Seqnum<u_int16_t> olsr::msg::Message::seqnum [static, protected]

The message sequence number.

Referenced by olsr::msg::TCMessage::dump(), olsr::msg::MIDMessage::dump(), olsr::msg::HNAMessage::dump(), olsr::msg::HELLOMessage::dump(), inc_seqnum(), and parse().

---

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

• message.hh
• message.hxx