#include <Registration.h>

Classes
class	AlreadyAttachedException
class	NotFoundException
class	NotPersistentException
class	RegistrationException
Public Types
enum	NOTIFY_CALL { NOTIFY_BUNDLE_AVAILABLE = 0, NOTIFY_NEIGHBOR_AVAILABLE = 1, NOTIFY_NEIGHBOR_UNAVAILABLE = 2, NOTIFY_SHUTDOWN = 3 }
Public Member Functions
	Registration ()
virtual	~Registration ()
void	notify (const NOTIFY_CALL)
NOTIFY_CALL	wait ()
void	wait_for_bundle (size_t timeout=0)
void	subscribe (const dtn::data::EID &endpoint)
void	unsubscribe (const dtn::data::EID &endpoint)
bool	hasSubscribed (const dtn::data::EID &endpoint)
const std::set< dtn::data::EID >	getSubscriptions ()
bool	operator== (const std::string &) const
bool	operator== (const Registration &) const
bool	operator< (const Registration &) const
dtn::data::Bundle	receive () throw (dtn::storage::BundleStorage::NoBundleFoundException)
dtn::data::MetaBundle	receiveMetaBundle () throw (dtn::storage::BundleStorage::NoBundleFoundException)
void	delivered (const dtn::data::MetaBundle &m)
const dtn::data::EID &	getDefaultEID () const
const std::string &	getHandle () const
void	abort ()
void	reset ()
void	setPersistent (ibrcommon::Timer::time_t lifetime)
void	unsetPersistent ()
bool	isPersistent ()
bool	isPersistent () const
ibrcommon::Timer::time_t	getExpireTime () const
void	attach ()
void	detach ()
Protected Member Functions
void	underflow ()

Detailed Description

Definition at line 24 of file Registration.h.

Member Enumeration Documentation

enum dtn::api::Registration::NOTIFY_CALL

Enumerator:

NOTIFY_BUNDLE_AVAILABLE
NOTIFY_NEIGHBOR_AVAILABLE
NOTIFY_NEIGHBOR_UNAVAILABLE
NOTIFY_SHUTDOWN

Definition at line 27 of file Registration.h.

Constructor & Destructor Documentation

dtn::api::Registration::Registration ( )

constructor of the registration

Definition at line 73 of file Registration.cpp.

dtn::api::Registration::~Registration ( ) [virtual]

destructor of the registration

Definition at line 80 of file Registration.cpp.

Member Function Documentation

void dtn::api::Registration::abort ( )

abort all blocking operations on this registration

Definition at line 357 of file Registration.cpp.

References ibrcommon::Conditional::abort(), and ibrcommon::Queue< T >::abort().

Referenced by dtn::api::OrderedStreamHandler::finally(), dtn::api::ExtendedApiHandler::finally(), dtn::api::BinaryStreamClient::finally(), dtn::api::ClientHandler::finally(), dtn::api::ExtendedApiHandler::run(), dtn::api::ClientHandler::switchRegistration(), dtn::api::BinaryStreamClient::~BinaryStreamClient(), and dtn::api::ExtendedApiHandler::~ExtendedApiHandler().

Here is the call graph for this function:

void dtn::api::Registration::attach ( )

attaches a client to this registration

Exceptions:

AlreadyAttachedException a client is already attached

Definition at line 415 of file Registration.cpp.

void dtn::api::Registration::delivered ( const dtn::data::MetaBundle & m )

notify a bundle as delivered (and delete it if singleton destination)

Parameters:

id

Definition at line 133 of file Registration.cpp.

References dtn::core::BUNDLE_DELIVERED, dtn::data::PrimaryBlock::DESTINATION_IS_SINGLETON, dtn::data::MetaBundle::get(), dtn::core::BundlePurgeEvent::raise(), and dtn::core::BundleEvent::raise().

Referenced by dtn::api::OrderedStreamHandler::delivered(), dtn::api::BinaryStreamClient::eventBundleForwarded(), and dtn::api::ExtendedApiHandler::run().

Here is the call graph for this function:

void dtn::api::Registration::detach ( void )

detaches a client from this registration

Definition at line 423 of file Registration.cpp.

References ibrcommon::Conditional::reset(), and ibrcommon::Queue< T >::reset().

Referenced by dtn::api::ApiServer::freeRegistration().

Here is the call graph for this function:

const dtn::data::EID & dtn::api::Registration::getDefaultEID ( ) const

returns a default EID based on the registration handle

Returns:: A EID object.

Definition at line 366 of file Registration.cpp.

Referenced by dtn::api::BinaryStreamClient::eventConnectionUp(), dtn::api::OrderedStreamHandler::OrderedStreamHandler(), dtn::api::OrderedStreamHandler::put(), and dtn::api::ExtendedApiHandler::run().

ibrcommon::Timer::time_t dtn::api::Registration::getExpireTime ( ) const

gets the expire time of this registration if it is persistent

See also:: ibrcommon::Timer::get_current_time()

Exceptions:

NotPersistentException the registration is not persistent

Returns:: the expire time according to ibrcommon::Timer::get_current_time()

Definition at line 407 of file Registration.cpp.

References isPersistent().

Here is the call graph for this function:

const std::string & dtn::api::Registration::getHandle ( ) const

returns the handle of this registration

Returns:

Definition at line 371 of file Registration.cpp.

Referenced by dtn::api::ApiServer::componentRun(), dtn::api::BinaryStreamClient::eventConnectionUp(), dtn::api::ApiServer::freeRegistration(), and dtn::api::ExtendedApiHandler::run().

const std::set< dtn::data::EID > dtn::api::Registration::getSubscriptions ( )

Returns:: A list of active subscriptions.

Definition at line 127 of file Registration.cpp.

Referenced by dtn::api::ExtendedApiHandler::run().

bool dtn::api::Registration::hasSubscribed ( const dtn::data::EID & endpoint )

check if this registration has subscribed to a specific endpoint

Parameters:

endpoint

Returns:

Definition at line 121 of file Registration.cpp.

Referenced by dtn::api::ApiServer::raiseEvent().

bool dtn::api::Registration::isPersistent ( )

returns the persistent state of this registration and also sets the persistent state to false, if the timer is expired

Returns:: the persistent state

Definition at line 387 of file Registration.cpp.

References ibrcommon::Timer::get_current_time().

Referenced by dtn::api::ApiServer::freeRegistration(), and getExpireTime().

Here is the call graph for this function:

bool dtn::api::Registration::isPersistent ( ) const

returns the persistent state of this registration

Returns:: the persistent state

Definition at line 397 of file Registration.cpp.

References ibrcommon::Timer::get_current_time().

Here is the call graph for this function:

void dtn::api::Registration::notify ( const NOTIFY_CALL call )

notify the corresponding client about something happen

Definition at line 85 of file Registration.cpp.

References NOTIFY_BUNDLE_AVAILABLE, ibrcommon::Queue< T >::push(), and ibrcommon::Conditional::signal().

Referenced by dtn::api::ApiServer::raiseEvent(), and subscribe().

Here is the call graph for this function:

bool dtn::api::Registration::operator< ( const Registration & other ) const

compares and order a registration (using the handle)

Definition at line 352 of file Registration.cpp.

bool dtn::api::Registration::operator== ( const std::string & other ) const

compares the local handle with the given one

Definition at line 336 of file Registration.cpp.

bool dtn::api::Registration::operator== ( const Registration & other ) const

compares another registration with this one

Definition at line 344 of file Registration.cpp.

dtn::data::Bundle dtn::api::Registration::receive ( ) throw (dtn::storage::BundleStorage::NoBundleFoundException)

Receive a bundle from the queue. If the queue is empty, it will query the storage for more bundles (up to 10). If no bundle is found and the queue is empty an exception is thrown.