Vidalia  0.2.21
Public Types | Public Member Functions | Static Public Member Functions | Private Attributes | List of all members
BootstrapStatus Class Reference

#include <BootstrapStatus.h>

Public Types

enum  Status {
  UnrecognizedStatus, ConnectingToDirMirror, HandshakingWithDirMirror, CreatingOneHopCircuit,
  RequestingNetworkStatus, LoadingNetworkStatus, LoadingAuthorityCertificates, RequestingDescriptors,
  LoadingDescriptors, ConnectingToEntryGuard, HandshakingWithEntryGuard, EstablishingCircuit,
  BootstrappingDone
}
 
enum  Recommendation { UnrecognizedRecommendation, RecommendIgnore, RecommendWarn }
 

Public Member Functions

 BootstrapStatus ()
 
 BootstrapStatus (tc::Severity severity, Status status, int percentComplete, const QString &description, const QString &warning=QString(), tc::ConnectionStatusReason reason=tc::UnrecognizedReason, Recommendation action=UnrecognizedRecommendation)
 
tc::Severity severity () const
 
Status status () const
 
int percentComplete () const
 
QString description () const
 
QString warning () const
 
tc::ConnectionStatusReason reason () const
 
Recommendation recommendedAction () const
 
bool isValid () const
 

Static Public Member Functions

static Status statusFromString (const QString &tag)
 
static Recommendation actionFromString (const QString &str)
 

Private Attributes

tc::Severity _severity
 
Status _status
 
int _percentComplete
 
QString _description
 
QString _warning
 
tc::ConnectionStatusReason _reason
 
Recommendation _action
 

Detailed Description

Definition at line 25 of file BootstrapStatus.h.

Member Enumeration Documentation

Actions the Tor software might recommend controllers take in response to a bootstrap status problem event.

Enumerator:
UnrecognizedRecommendation 
RecommendIgnore 
RecommendWarn 

Definition at line 47 of file BootstrapStatus.h.

Currently enumerated bootstrapping states defined by Tor's control protocol (Tor >= 0.2.1.0-alpha-dev.

Enumerator:
UnrecognizedStatus 
ConnectingToDirMirror 
HandshakingWithDirMirror 
CreatingOneHopCircuit 
RequestingNetworkStatus 
LoadingNetworkStatus 
LoadingAuthorityCertificates 
RequestingDescriptors 
LoadingDescriptors 
ConnectingToEntryGuard 
HandshakingWithEntryGuard 
EstablishingCircuit 
BootstrappingDone 

Definition at line 30 of file BootstrapStatus.h.

Constructor & Destructor Documentation

BootstrapStatus::BootstrapStatus ( )
BootstrapStatus::BootstrapStatus ( tc::Severity  severity,
Status  status,
int  percentComplete,
const QString &  description,
const QString &  warning = QString(),
tc::ConnectionStatusReason  reason = tc::UnrecognizedReason,
Recommendation  action = UnrecognizedRecommendation 
)

Member Function Documentation

BootstrapStatus::Recommendation BootstrapStatus::actionFromString ( const QString &  str)
static

Converts a string RECOMMENDATION value to a RecommendAction enum value.

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

Definition at line 79 of file BootstrapStatus.cpp.

References RecommendIgnore, RecommendWarn, and UnrecognizedRecommendation.

Referenced by TorControl::bootstrapStatus(), and TorEvents::handleClientStatusEvent().

QString BootstrapStatus::description ( ) const
inline

Returns a description of Tor's current bootstrapping status.

Definition at line 76 of file BootstrapStatus.h.

References _description.

Referenced by BootstrapStatus(), and MainWindow::bootstrapStatusChanged().

bool BootstrapStatus::isValid ( ) const

Returns true if this object represents a valid bootstrap status phase.

Definition at line 90 of file BootstrapStatus.cpp.

References _percentComplete, _severity, _status, tc::UnrecognizedSeverity, and UnrecognizedStatus.

Referenced by MainWindow::authenticated().

int BootstrapStatus::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 73 of file BootstrapStatus.h.

References _percentComplete.

Referenced by MainWindow::bootstrapStatusChanged().

tc::ConnectionStatusReason BootstrapStatus::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 87 of file BootstrapStatus.h.

References _reason.

Referenced by BootstrapStatus(), and MainWindow::bootstrapStatusChanged().

Recommendation BootstrapStatus::recommendedAction ( ) const
inline

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

Definition at line 91 of file BootstrapStatus.h.

References _action.

Referenced by MainWindow::bootstrapStatusChanged().

tc::Severity BootstrapStatus::severity ( ) const
inline

Returns the severity of this bootstrap status event.

Definition at line 65 of file BootstrapStatus.h.

References _severity.

Referenced by BootstrapStatus(), and MainWindow::bootstrapStatusChanged().

Status BootstrapStatus::status ( ) const
inline

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

Definition at line 69 of file BootstrapStatus.h.

References _status.

Referenced by BootstrapStatus(), and MainWindow::bootstrapStatusChanged().

BootstrapStatus::Status BootstrapStatus::statusFromString ( const QString &  str)
static
QString BootstrapStatus::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 81 of file BootstrapStatus.h.

References _warning.

Referenced by BootstrapStatus().

Member Data Documentation

Recommendation BootstrapStatus::_action
private

Recommendation enum value describing Tor's suggested response to this bootstrap status event.

See Also
recommendedAction

Definition at line 140 of file BootstrapStatus.h.

Referenced by BootstrapStatus(), and recommendedAction().

QString BootstrapStatus::_description
private

Description of Tor's current bootstrapping status.

See Also
description

Definition at line 122 of file BootstrapStatus.h.

Referenced by BootstrapStatus(), and description().

int BootstrapStatus::_percentComplete
private

Approximate percentage of Tor's bootstrapping process that is complete.

See Also
percentComplete

Definition at line 117 of file BootstrapStatus.h.

Referenced by BootstrapStatus(), isValid(), and percentComplete().

tc::ConnectionStatusReason BootstrapStatus::_reason
private

ConnectionStatusReason enum value describing the most recent error Tor encountered while attempting to bootstrap.

See Also
reason

Definition at line 134 of file BootstrapStatus.h.

Referenced by BootstrapStatus(), and reason().

tc::Severity BootstrapStatus::_severity
private

Severity of the current bootstrap status.

See Also
severity

Definition at line 107 of file BootstrapStatus.h.

Referenced by BootstrapStatus(), isValid(), and severity().

Status BootstrapStatus::_status
private

Current bootstrapping status value.

See Also
status

Definition at line 112 of file BootstrapStatus.h.

Referenced by BootstrapStatus(), isValid(), and status().

QString BootstrapStatus::_warning
private

Description of the most recent error Tor encountered while attempting to bootstrap.

See Also
warning

Definition at line 128 of file BootstrapStatus.h.

Referenced by BootstrapStatus(), and warning().


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