BootstrapStatusEvent Class Reference

#include <bootstrapstatusevent.h>

Inheritance diagram for BootstrapStatusEvent:

ClientStatusEvent StatusEvent

List of all members.

Public Member Functions

 BootstrapStatusEvent (const BootstrapStatus &status)
BootstrapStatus status () const
int percentComplete () const
QString description () const
QString warning () const
tc::ConnectionStatusReason reason () const
BootstrapStatus::Recommendation recommendedAction () const

Private Attributes

BootstrapStatus _bootstrapStatus


Detailed Description

Definition at line 26 of file bootstrapstatusevent.h.


Constructor & Destructor Documentation

BootstrapStatusEvent::BootstrapStatusEvent ( const BootstrapStatus status  )  [inline]

Constructor.

Definition at line 30 of file bootstrapstatusevent.h.


Member Function Documentation

QString BootstrapStatusEvent::description (  )  const [inline]

Returns a description of Tor's current bootstrapping status.

Definition at line 43 of file bootstrapstatusevent.h.

References BootstrapStatus::description(), and status().

int BootstrapStatusEvent::percentComplete (  )  const [inline]

Returns an integer between 0 and 100 representing an estimate of how much of Tor's bootstrapping process it has completed.

Definition at line 40 of file bootstrapstatusevent.h.

References BootstrapStatus::percentComplete(), and status().

tc::ConnectionStatusReason BootstrapStatusEvent::reason (  )  const [inline]

Returns a ConnectionStatusReason enum value describing the most recent error Tor encountered while attempting to bootstrap, if this event's severity is 'warn'. Otherwise, this simply returns tc::UnrecognizedReason.

Definition at line 54 of file bootstrapstatusevent.h.

References BootstrapStatus::reason(), and status().

BootstrapStatus::Recommendation BootstrapStatusEvent::recommendedAction (  )  const [inline]

Returns the action that the Tor software recommended be taken in response to this bootstrap status event.

Definition at line 58 of file bootstrapstatusevent.h.

References BootstrapStatus::recommendedAction(), and status().

BootstrapStatus BootstrapStatusEvent::status (  )  const [inline]

Returns the BootstrapStatus enum value indicated by this bootstrap status event.

Reimplemented from ClientStatusEvent.

Definition at line 36 of file bootstrapstatusevent.h.

References _bootstrapStatus.

Referenced by MainWindow::customEvent(), description(), percentComplete(), reason(), recommendedAction(), and warning().

QString BootstrapStatusEvent::warning (  )  const [inline]

Returns a description of the most recent error Tor encountered while attempting to bootstrap, if this event's severity is 'warn'. Otherwise, this returns a default-constructed QString.

Definition at line 48 of file bootstrapstatusevent.h.

References status(), and BootstrapStatus::warning().


Member Data Documentation

Current bootstrapping status value.

See also:
status

Definition at line 66 of file bootstrapstatusevent.h.

Referenced by status().


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

Generated on Wed Nov 26 21:02:43 2008 for Vidalia by  doxygen 1.5.7.1