Interface EventHandler

All Known Implementing Classes:
DebuggingEventHandler, NullEventHandler

public interface EventHandler
Abstract interface whose methods are invoked when Tor sends us an event.
See Also:
  • Method Details

    • circuitStatus

      void circuitStatus(String status, String circID, String path)
      Invoked when a circuit's status has changed. Possible values for status are:
      • "LAUNCHED" : circuit ID assigned to new circuit
      • "BUILT" : all hops finished, can now accept streams
      • "EXTENDED" : one more hop has been completed
      • "FAILED" : circuit closed (was not built)
      • "CLOSED" : circuit closed (was built)
      circID is the alphanumeric identifier of the affected circuit, and path is a comma-separated list of alphanumeric ServerIDs.
    • streamStatus

      void streamStatus(String status, String streamID, String target)
      Invoked when a stream's status has changed. Possible values for status are:
      • "NEW" : New request to connect
      • "NEWRESOLVE" : New request to resolve an address
      • "SENTCONNECT" : Sent a connect cell along a circuit
      • "SENTRESOLVE" : Sent a resolve cell along a circuit
      • "SUCCEEDED" : Received a reply; stream established
      • "FAILED" : Stream failed and not retriable.
      • "CLOSED" : Stream closed
      • "DETACHED" : Detached from circuit; still retriable.
      streamID is the alphanumeric identifier of the affected stream, and its target is specified as address:port.
    • orConnStatus

      void orConnStatus(String status, String orName)
      Invoked when the status of a connection to an OR has changed. Possible values for status are ["LAUNCHED" | "CONNECTED" | "FAILED" | "CLOSED"]. orName is the alphanumeric identifier of the OR affected.
    • bandwidthUsed

      void bandwidthUsed(long read, long written)
      Invoked once per second. read and written are the number of bytes read and written, respectively, in the last second.
    • newDescriptors

      void newDescriptors(List<String> orList)
      Invoked whenever Tor learns about new ORs. The orList object contains the alphanumeric ServerIDs associated with the new ORs.
    • message

      void message(String severity, String msg)
      Invoked when Tor logs a message. severity is one of ["DEBUG" | "INFO" | "NOTICE" | "WARN" | "ERR"], and msg is the message string.
    • unrecognized

      void unrecognized(String type, String msg)
      Invoked when an unspecified message is received. is the message type, and is the message string.