OLSR Routing

This section documents the API of the ns-3 OLSR module. More...

Collaboration diagram for OLSR Routing:

Modules
	olsr module tests

Classes
struct	ns3::olsr::Association
	Association. More...
struct	ns3::olsr::AssociationTuple
	An Association Tuple. More...
struct	ns3::olsr::DuplicateTuple
	A Duplicate Tuple. More...
struct	ns3::olsr::MessageHeader::Hello
	HELLO Message Format. More...
struct	ns3::olsr::MessageHeader::Hna
	HNA (Host Network Association) Message Format. More...
struct	ns3::olsr::IfaceAssocTuple
	An Interface Association Tuple. More...
struct	ns3::olsr::LinkTuple
	A Link Tuple. More...
class	ns3::olsr::MessageHeader
	This header can store HELP, TC, MID and HNA messages. More...
struct	ns3::olsr::MessageHeader::Mid
	MID Message Format. More...
struct	ns3::olsr::MprSelectorTuple
	An MPR-Selector Tuple. More...
struct	ns3::olsr::NeighborTuple
	A Neighbor Tuple. More...
class	ns3::OlsrHelper
	Helper class that adds OLSR routing to nodes. More...
class	ns3::olsr::OlsrState
	This class encapsulates all data structures needed for maintaining internal state of an OLSR node. More...
class	ns3::olsr::PacketHeader
	The basic layout of any packet in OLSR is as follows (omitting IP and UDP headers): More...
class	ns3::olsr::RoutingProtocol
	OLSR routing protocol for IPv4. More...
struct	ns3::olsr::RoutingTableEntry
	An OLSR's routing table entry. More...
struct	ns3::olsr::MessageHeader::Tc
	TC Message Format. More...
struct	ns3::olsr::TopologyTuple
	A Topology Tuple. More...
struct	ns3::olsr::TwoHopNeighborTuple
	A 2-hop Tuple. More...

Enumerations
enum class	ns3::olsr::LinkType : uint8_t { ns3::olsr::UNSPEC_LINK = 0 , ns3::olsr::ASYM_LINK = 1 , ns3::olsr::SYM_LINK = 2 , ns3::olsr::LOST_LINK = 3 }
	OLSR link types. More...
enum class	ns3::olsr::NeighborType : uint8_t { ns3::olsr::NOT_NEIGH = 0 , ns3::olsr::SYM_NEIGH = 1 , ns3::olsr::MPR_NEIGH = 2 }
	OLSR neighbor types. More...
enum	ns3::olsr::Willingness : uint8_t {   ns3::olsr::NEVER = 0 , ns3::olsr::LOW = 1 , ns3::olsr::DEFAULT = 3 , ns3::olsr::HIGH = 6 ,   ns3::olsr::ALWAYS = 7 }
	Willingness for forwarding packets from other nodes. More...

Detailed Description

This section documents the API of the ns-3 OLSR module.

For a generic functional description, please refer to the ns-3 manual.

Enumeration Type Documentation

LinkType

enum ns3::olsr::LinkType : uint8_t

strong

OLSR link types.

See RFC 3626 section 18.5.

Enumerator
UNSPEC_LINK	Unspecified link type.
ASYM_LINK	Asymmetric link type.
SYM_LINK	Symmetric link type.
LOST_LINK	Lost link type.

Definition at line 122 of file olsr-routing-protocol.cc.

NeighborType

enum ns3::olsr::NeighborType : uint8_t

strong

OLSR neighbor types.

See RFC 3626 section 18.6.

Enumerator
NOT_NEIGH	Not neighbor type.
SYM_NEIGH	Symmetric neighbor type.
MPR_NEIGH	Asymmetric neighbor type.

Definition at line 161 of file olsr-routing-protocol.cc.

Willingness

enum ns3::olsr::Willingness : uint8_t

Willingness for forwarding packets from other nodes.

The standard defines the following set of values. Values 0 - 7 are allowed by the standard, but this is not enforced in the code.

See RFC 3626 section 18.8

Enumerator
NEVER
LOW
DEFAULT
HIGH
ALWAYS

Definition at line 46 of file olsr-repositories.h.