TraceConsumer Class Reference
[pydtn]

A special DTN::Consumer that calls the GlobalTracer's hooks. More...

#include <pydtn/TraceConsumer.h>

Inheritance diagram for TraceConsumer:

[legend]

Collaboration diagram for TraceConsumer:

[legend]

List of all members.

Public Member Functions
	TraceConsumer (DTN::Node *owner)
	Constructor.
virtual	~TraceConsumer ()
	Virtual destructor.
virtual void	operator() (const DTN::Bundle &b)
	Concrete specification of the data handling.
virtual void	drop (const DTN::Bundle &b, const DTN::DropCause &c)
	Concrete specification of the bundle drop handling.
virtual void	custody (const DTN::Bundle &b)
	Concrete specification of the custody acceptance handling.
virtual void	persistentStore (const DTN::Bundle &b)
	Recording method for adding a Bundle to the persistent store.
virtual void	persistentRemove (const DTN::Bundle &b, bool cleanup=true)
	Recording method for removing a Bundle from the persistent store.
virtual void	send (const DTN::Bundle &b)
	Recording method for sending a Bundle.
virtual void	recv (const DTN::Bundle &b)
	Recording method for receiving a Bundle.
virtual void	exhausted (const DTN::Bundle &b)
	Recording method for persistent storage exhaustion.

---

Detailed Description

A special DTN::Consumer that calls the GlobalTracer's hooks.

Definition at line 41 of file TraceConsumer.h.

---

Member Function Documentation

void TraceConsumer::operator()

(

const DTN::Bundle &

b

)

[virtual]

Concrete specification of the data handling.

Parameters:

b

The data bundle to handle

Implements DTN::Consumer.

Definition at line 37 of file TraceConsumer.cc.

References GlobalTracer::instance().

void TraceConsumer::drop	(	const DTN::Bundle &	b,
		const DTN::DropCause &	c
	)			[virtual]

Concrete specification of the bundle drop handling.

Parameters:

	b	The data bundle being dropped
	c	The reason for dropping the bundle

Reimplemented from DTN::Consumer.

Definition at line 44 of file TraceConsumer.cc.

References TracerChain::drop(), GlobalTracer::instance(), and DTN::Consumer::m_owner.

void TraceConsumer::custody

(

const DTN::Bundle &

b

)

[virtual]

Concrete specification of the custody acceptance handling.

Parameters:

b

The data bundle being custodially accepted

Reimplemented from DTN::Consumer.

Definition at line 52 of file TraceConsumer.cc.

References GlobalTracer::instance().

void TraceConsumer::persistentStore

(

const DTN::Bundle &

b

)

[virtual]

Recording method for adding a Bundle to the persistent store.

Parameters:

b

A bundle being stored

Reimplemented from DTN::Consumer.

Definition at line 59 of file TraceConsumer.cc.

References TracerChain::enqueue(), GlobalTracer::instance(), and DTN::Consumer::m_owner.

void TraceConsumer::persistentRemove	(	const DTN::Bundle &	b,
		bool	cleanup = true
	)			[virtual]

Recording method for removing a Bundle from the persistent store.

Parameters:

	b	A bundle being removed
	cleanup	Whether the persistent store's clean-up method should be invoked (can cause recursion loops)

Reimplemented from DTN::Consumer.

Definition at line 67 of file TraceConsumer.cc.

References TracerChain::dequeue(), GlobalTracer::instance(), and DTN::Consumer::m_owner.

void TraceConsumer::send

(

const DTN::Bundle &

b

)

[virtual]

Recording method for sending a Bundle.

Parameters:

b

A bundle being sent

Reimplemented from DTN::Consumer.

Definition at line 75 of file TraceConsumer.cc.

References GlobalTracer::instance(), DTN::Consumer::m_owner, and TracerChain::send().

void TraceConsumer::recv

(

const DTN::Bundle &

b

)

[virtual]

Recording method for receiving a Bundle.

Parameters:

b

A bundle being received

Reimplemented from DTN::Consumer.

Definition at line 83 of file TraceConsumer.cc.

References GlobalTracer::instance(), DTN::Consumer::m_owner, and TracerChain::receive().

void TraceConsumer::exhausted

(

const DTN::Bundle &

b

)

[virtual]

Recording method for persistent storage exhaustion.

Parameters:

b

A bundle that could not be stored

Reimplemented from DTN::Consumer.

Definition at line 91 of file TraceConsumer.cc.

References GlobalTracer::instance().

---

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

• pydtn/TraceConsumer.h
• pydtn/TraceConsumer.cc

---