dtn::core::BundleRouter Class Reference

#include <BundleRouter.h>

Inheritance diagram for dtn::core::BundleRouter:

List of all members.

Public Member Functions
	BundleRouter (string eid)
virtual	~BundleRouter ()
virtual const list< Node > &	getNeighbours ()
virtual bool	isNeighbour (Node &node)
bool	isNeighbour (string eid)
Node	getNeighbour (string eid)
virtual void	tick ()
virtual BundleSchedule	getSchedule (const Bundle &b)
bool	isLocal (const Bundle &b) const
void	raiseEvent (const Event *evt)
Protected Member Functions
void	terminate ()
Private Member Functions
virtual void	discovered (const Node &node)
Private Attributes
list< Node >	m_neighbours
string	m_eid
dtn::utils::Mutex	m_lock
Conditional	m_nexttime

---

Detailed Description

A bundle router search a route for given bundle and return a BundleSchedule. Additional manage a list of currently reachable nodes.

This is a base class which can be extended to implement several routing protocols.

---

Constructor & Destructor Documentation

dtn::core::BundleRouter::BundleRouter

(

string

eid

)

References dtn::core::TimeEvent::className, dtn::core::RouteEvent::className, dtn::core::NodeEvent::className, and dtn::core::EventSwitch::registerEventReceiver().

dtn::core::BundleRouter::~BundleRouter

(

)

[virtual]

destructor

References dtn::core::TimeEvent::className, dtn::core::RouteEvent::className, dtn::core::NodeEvent::className, m_lock, m_neighbours, and dtn::core::EventSwitch::unregisterEventReceiver().

---

Member Function Documentation

const list< Node > & dtn::core::BundleRouter::getNeighbours

(

)

[virtual]

Returns a list of currently reachable nodes.

Returns:

The list of currently reachable nodes.

References m_lock, and m_neighbours.

bool dtn::core::BundleRouter::isNeighbour

(

Node &

node

)

[virtual]

Determine of a specific node is currently reachable.

Parameters:

node

The node to reach.

Returns:

true, if the given node is reachable.

References dtn::core::Node::equals(), m_lock, and m_neighbours.

Referenced by dtn::core::StaticBundleRouter::getSchedule(), and getSchedule().

bool dtn::core::BundleRouter::isNeighbour

(

string

eid

)

References m_lock, and m_neighbours.

Node dtn::core::BundleRouter::getNeighbour

(

string

eid

)

References m_lock, and m_neighbours.

Referenced by raiseEvent().

void dtn::core::BundleRouter::tick

(

)

[virtual]

See also:

Service::tick()

Implements dtn::utils::Service.

References dtn::core::Node::decrementTimeout(), m_lock, m_neighbours, m_nexttime, dtn::core::NODE_UNAVAILABLE, dtn::core::PERMANENT, dtn::core::EventSwitch::raiseEvent(), dtn::utils::MutexLock::unlock(), and dtn::utils::Conditional::wait().

BundleSchedule dtn::core::BundleRouter::getSchedule

(

const Bundle &

b

)

[virtual]

Search for a route and return a schedule for the given bundle

Parameters:

b

A bundle to route.

Returns:

A schedule for the given bundle.

Reimplemented in dtn::core::StaticBundleRouter.

References dtn::data::Bundle::getDestination(), dtn::data::Bundle::isExpired(), isLocal(), isNeighbour(), and m_eid.

Referenced by dtn::core::StaticBundleRouter::getSchedule(), and raiseEvent().

bool dtn::core::BundleRouter::isLocal

(

const Bundle &

b

)

const

References dtn::data::Bundle::getDestination(), and m_eid.

Referenced by getSchedule(), and raiseEvent().

void dtn::core::BundleRouter::raiseEvent

(

const Event *

evt

)

[virtual]

method to receive new events from the EventSwitch

Implements dtn::core::EventReceiver.

References dtn::core::BUNDLE_DELETED, dtn::core::CUSTODY_REJECT, dtn::core::BundleCore::deliver(), discovered(), dtn::core::RouteEvent::getAction(), dtn::core::NodeEvent::getAction(), dtn::core::TimeEvent::getAction(), dtn::core::RouteEvent::getBundle(), dtn::data::Bundle::getDestination(), dtn::core::BundleSchedule::getEID(), dtn::core::BundleCore::getInstance(), getNeighbour(), dtn::core::NodeEvent::getNode(), getSchedule(), isLocal(), dtn::data::LIFETIME_EXPIRED, m_nexttime, dtn::data::NO_KNOWN_ROUTE_TO_DESTINATION_FROM_HERE, dtn::core::NODE_INFO_UPDATED, dtn::core::EventSwitch::raiseEvent(), dtn::core::ROUTE_PROCESS_BUNDLE, dtn::utils::Conditional::signal(), dtn::core::TIME_SECOND_TICK, and dtn::core::BundleCore::transmit().

void dtn::core::BundleRouter::terminate

(

)

[protected, virtual]

Reimplemented from dtn::utils::Service.

References m_nexttime, and dtn::utils::Conditional::signal().

void dtn::core::BundleRouter::discovered

(

const Node &

node

)

[private, virtual]

Updates the list of reachable nodes. If the node is currently unknown a NODE_AVAILABLE event will be raised.

Parameters:

node

The node with new information.

References dtn::core::Node::getURI(), m_lock, m_neighbours, dtn::core::NODE_AVAILABLE, dtn::core::PERMANENT, and dtn::core::EventSwitch::raiseEvent().

Referenced by raiseEvent().

---

Member Data Documentation

list<Node> dtn::core::BundleRouter::m_neighbours [private]

Referenced by discovered(), getNeighbour(), getNeighbours(), isNeighbour(), tick(), and ~BundleRouter().

string dtn::core::BundleRouter::m_eid [private]

Reimplemented in dtn::core::StaticBundleRouter.

Referenced by getSchedule(), and isLocal().

dtn::utils::Mutex dtn::core::BundleRouter::m_lock [private]

Referenced by discovered(), getNeighbour(), getNeighbours(), isNeighbour(), tick(), and ~BundleRouter().

Conditional dtn::core::BundleRouter::m_nexttime [private]

Referenced by raiseEvent(), terminate(), and tick().

---

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

• include/core/BundleRouter.h
• src/core/BundleRouter.cpp