dtn::ContactEvent Class Reference

#include <BundleEvent.h>

Inheritance diagram for dtn::ContactEvent:

dtn::BundleEvent dtn::ContactDownEvent dtn::ContactUpEvent dtn::LinkAvailableEvent dtn::LinkCreatedEvent dtn::LinkDeletedEvent dtn::LinkStateChangeRequest dtn::LinkUnavailableEvent List of all members.

Detailed Description

Abstract class for the subset of events related to contacts and links that defines a reason code enumerated type.

Definition at line 340 of file BundleEvent.h.

Public Types

enum  reason_t {
  INVALID = 0, NO_INFO, USER, BROKEN,
  SHUTDOWN, RECONNECT, IDLE, TIMEOUT,
  UNBLOCKED
}
 Reason codes for contact state operations. More...

Public Member Functions

 ContactEvent (event_type_t type, reason_t reason=NO_INFO)
 Constructor.

Static Public Member Functions

static const char * reason_to_str (reason_t reason)
 Reason to string conversion.

Public Attributes

reason_t reason_
 reason code for the event


Member Enumeration Documentation

enum dtn::ContactEvent::reason_t

Reason codes for contact state operations.

Enumerator:
INVALID  Should not be used.
NO_INFO  No additional info.
USER  User action (i.e. console / config).
BROKEN  Unexpected session interruption.
SHUTDOWN  Clean connection shutdown.
RECONNECT  Re-establish link after failure.
IDLE  Idle connection shut down by the CL.
TIMEOUT  Scheduled link ended duration.
UNBLOCKED  No longer busy.

Definition at line 345 of file BundleEvent.h.


Constructor & Destructor Documentation

dtn::ContactEvent::ContactEvent ( event_type_t  type,
reason_t  reason = NO_INFO 
) [inline]

Constructor.

Definition at line 376 of file BundleEvent.h.


Member Function Documentation

static const char* dtn::ContactEvent::reason_to_str ( reason_t  reason  )  [inline, static]

Reason to string conversion.

Definition at line 360 of file BundleEvent.h.

References BROKEN, IDLE, INVALID, NO_INFO, NOTREACHED, RECONNECT, SHUTDOWN, TIMEOUT, UNBLOCKED, and USER.

Referenced by dtn::CLConnection::break_contact(), dtn::BundleDaemon::handle_contact_down(), dtn::BundleDaemon::handle_link_state_change_request(), and dtn::ContactManager::handle_link_unavailable().


Member Data Documentation

reason_t dtn::ContactEvent::reason_

reason code for the event

Definition at line 379 of file BundleEvent.h.

Referenced by dtn::BundleDaemon::handle_contact_down(), dtn::BundleDaemon::handle_link_state_change_request(), and dtn::ContactManager::handle_link_unavailable().


The documentation for this class was generated from the following file:
Generated on Fri Dec 22 14:48:03 2006 for DTN Reference Implementation by  doxygen 1.5.1