MobileForwarding::Protocol Class Reference
[libmobileforwarding]

Application skeleton to handle forwarding control messages. More...

#include <mobileforwarding/Protocol.h>

Inheritance diagram for MobileForwarding::Protocol:

[legend]

Collaboration diagram for MobileForwarding::Protocol:

[legend]

List of all members.

Public Member Functions
	Protocol (Mobility::MobileNode *n, DTN::Link *l, const struct timeval &t)
	Constructor.
virtual	~Protocol ()
	Virtual destructor.
void	setOwner (DTN::Node *owner)
	Set the owner node.
virtual DTN::Link *	getLink (const DTN::ByteString &addr)=0
	Get the mock link for an address.
virtual void	tweak (DTN::Bundle *b)
	Modify a bundle, if necessary.
bool	visible (const DTN::ByteString &addr)
	Parameters: addr  The address of a node
Protected Member Functions
Mobility::MobileNode *	node ()
	Non-const accessor for the internally stored mobile node.
const Mobility::MobileNode *	node () const
	Const accessor for the internally stored mobile node.
DTN::Link *	link ()
	Non-const accessor for the internally stored link.
const DTN::Link *	link () const
	Const accessor for the internally stored link.
struct timeval &	lifetime () const
	Const accessor for the default bundle lifetime.

---

Detailed Description

Application skeleton to handle forwarding control messages.

The derived class will need to implement:

• appID() — a unique string for the protocol
• newNeighbor() — the protocol action when a new node becomes visible
• process() — the handler for protocol messages
• getLink() — the mapping from a node address to a (possibly alias) link

The derived class might override:

• tweak() — protocol-specific modifications to bundles

Definition at line 70 of file Protocol.h.

---

Constructor & Destructor Documentation

Protocol::Protocol	(	Mobility::MobileNode *	n,
		DTN::Link *	l,
		const struct timeval &	t
	)

Constructor.

Parameters:

	n	The mobile node running this protocol instance
	l	The physical link through which bundles are sent
	t	The lifetime for a bundle

Definition at line 39 of file Protocol.cc.

---

Member Function Documentation

void Protocol::setOwner

(

DTN::Node *

owner

)

[virtual]

Set the owner node.

Because we don't necessarily have a handle for the node, we allow consumers to set this later.

Parameters:

owner

The consumer's owner node.

Reimplemented from DTN::Consumer.

Definition at line 54 of file Protocol.cc.

References DTN::Node::setForwardingPolicy().

virtual DTN::Link* MobileForwarding::Protocol::getLink

(

const DTN::ByteString &

addr

)

[pure virtual]

Get the mock link for an address.

Parameters:

addr

The address of a bundle receiver

Returns:

a pointer to a DTN::Link, or NULL

Implemented in BasicEpidemic::EpidemicApp.

Referenced by MobileForwarding::Forwarding::forward(), and MobileForwarding::Forwarding::forwardOn().

void Protocol::tweak

(

DTN::Bundle *

b

)

[virtual]

Modify a bundle, if necessary.

Some protocols might need to modify flags, or even annotate the bundle contents. The default behavior is to do nothing.

Parameters:

b

The bundle being handled

Reimplemented in BasicEpidemic::EpidemicApp.

Definition at line 74 of file Protocol.cc.

Referenced by MobileForwarding::Forwarding::forward().

bool Protocol::visible

(

const DTN::ByteString &

addr

)

Parameters:

addr

The address of a node

Returns:

whether we can currently see this node

Definition at line 79 of file Protocol.cc.

References Mobility::MobileNode::visible().

Referenced by MobileForwarding::Forwarding::forward(), and MobileForwarding::Forwarding::forwardOn().

---

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

• mobileforwarding/Protocol.h
• mobileforwarding/Protocol.cc

---