Circuit Class Reference

#include <circuit.h>

List of all members.

Public Types

enum  Status {
  Unknown, Launched, Built, Extended,
  Failed, Closed
}

Public Member Functions

 Circuit ()
 Circuit (quint64 circId, Status status, QString path)
 Circuit (quint64 circId, Status status, QStringList hops)
bool isEmpty ()
quint64 id ()
Status status ()
QString statusString ()
QString path ()
uint length ()
QStringList hops ()

Static Public Member Functions

static Circuit fromString (QString circuit)
static Status toStatus (QString strStatus)

Private Attributes

quint64 _circId
Status _status
QString _path


Detailed Description

Definition at line 36 of file circuit.h.


Member Enumeration Documentation

enum Circuit::Status

Circuit status events

Enumerator:
Unknown  Unknown circuit status
Launched  Circuit ID assigned to new circuit
Built  All hops finished
Extended  Circuit extended by one hop
Failed  Circuit closed (was not built)
Closed  Circuit closed (was built)

Definition at line 42 of file circuit.h.


Constructor & Destructor Documentation

Circuit::Circuit (  ) 

Default constructor.

Definition at line 34 of file circuit.cpp.

References _circId, _path, _status, and Unknown.

Referenced by fromString().

Circuit::Circuit ( quint64  circId,
Status  status,
QString  path 
)

Constructor

Definition at line 42 of file circuit.cpp.

References _circId, _path, and _status.

Circuit::Circuit ( quint64  circId,
Status  status,
QStringList  hops 
)

Constructor

Definition at line 50 of file circuit.cpp.

References _circId, _path, and _status.


Member Function Documentation

Circuit Circuit::fromString ( QString  circuit  )  [static]

Parses the given string (in Tor's control protocol format)

Parses the string given in Tor control protocol format for a circuit. The format is:

CircuitID SP CircStatus [SP Path]

If the status is "LAUNCHED", the Path is empty.

Definition at line 65 of file circuit.cpp.

References Circuit(), path(), status(), and toStatus().

Referenced by TorControl::getCircuits(), and TorEvents::handleCircuitStatus().

Circuit::Status Circuit::toStatus ( QString  strStatus  )  [static]

Converts a string description of a circuit's status to an enum value

Converts the circuit status string to its proper enum value

Definition at line 83 of file circuit.cpp.

References Built, Closed, Extended, Failed, Launched, status(), and Unknown.

Referenced by fromString().

bool Circuit::isEmpty (  ) 

Returns true if all fields in this Circuit are empty.

Returns true if all fields in this Circuit object are empty.

Definition at line 121 of file circuit.cpp.

References _circId, _status, and Unknown.

Referenced by TorControl::getCircuits().

quint64 Circuit::id (  )  [inline]

Returns the ID for this circuit

Definition at line 67 of file circuit.h.

References _circId.

Referenced by NetViewer::addCircuit(), CircuitListWidget::addCircuit(), NetViewer::circuitPathIDs(), NetViewer::circuitPathNames(), NetViewer::circuitSelected(), CircuitItem::id(), CircuitEvent::id(), CircuitListWidget::mouseReleaseEvent(), CircuitListWidget::removeCircuit(), and NetViewer::resolved().

Status Circuit::status (  )  [inline]

Returns the status of this circuit

Definition at line 69 of file circuit.h.

References _status.

Referenced by CircuitListWidget::addCircuit(), NetViewer::circuitPathIDs(), NetViewer::circuitPathNames(), fromString(), CircuitListWidget::mouseReleaseEvent(), CircuitEvent::status(), statusString(), and toStatus().

QString Circuit::statusString (  ) 

Returns a string representation of the status of this circuit.

Returns a string representation of the circuit's status.

Definition at line 105 of file circuit.cpp.

References _status, Built, Closed, Extended, Failed, Launched, and status().

Referenced by CircuitItem::update().

QString Circuit::path (  )  [inline]

Returns the path chosen for this circuit

Definition at line 73 of file circuit.h.

References _path.

Referenced by NetViewer::addCircuit(), fromString(), and CircuitEvent::path().

uint Circuit::length (  )  [inline]

Returns the length of the circuit's path.

Definition at line 75 of file circuit.h.

References hops().

Referenced by CircuitListWidget::onSelectionChanged().

QStringList Circuit::hops (  )  [inline]

Returns a list of hops on the path.

Definition at line 77 of file circuit.h.

References _path.

Referenced by NetViewer::addCircuit(), NetViewer::circuitPathIDs(), NetViewer::circuitPathNames(), NetViewer::circuitSelected(), length(), and NetViewer::resolved().


Member Data Documentation

quint64 Circuit::_circId [private]

Circuit ID.

Definition at line 81 of file circuit.h.

Referenced by Circuit(), id(), and isEmpty().

Status Circuit::_status [private]

Circuit status.

Definition at line 82 of file circuit.h.

Referenced by Circuit(), isEmpty(), status(), and statusString().

QString Circuit::_path [private]

Circuit path.

Definition at line 83 of file circuit.h.

Referenced by Circuit(), hops(), and path().


The documentation for this class was generated from the following files:
Generated on Wed Sep 5 15:49:29 2007 for Vidalia by  doxygen 1.5.3