Method Detail

• getConsecutiveFailures

  int getConsecutiveFailures()

  The number of consecutive test failures.

  Returns:

  the count of consecutive failures

• getDestination

  Hash getDestination()

  If this is a client tunnel, what destination is it for?

• getEndpoint

  Hash getEndpoint()

  For convenience

  Returns:

  getPeer(getLength() - 1)

• getExpiration

  long getExpiration()

  The tunnel's expiration time.

  Returns:

  expiration time in milliseconds since epoch

• getFarEnd

  Hash getFarEnd()

  For convenience

  Returns:

  isInbound() ? getGateway() : getEndpoint()

• getGateway

  Hash getGateway()

  For convenience

  Returns:

  getPeer(0)

• getLastLatency

  int getLastLatency()

  The latency of the last tunnel test.

  Returns:

  latency in milliseconds, or -1 if not available

• getLastRealTraffic

  long getLastRealTraffic()

  When the tunnel last carried real traffic.

  Returns:

  the timestamp, or 0 if it never carried real traffic

• getLength

  int getLength()

  How many peers are there in the tunnel (including the creator)?

• getPeer

  Hash getPeer(int hop)

  The peer at the given hop. The gateway is hop 0.

• getProcessedMessagesCount

  int getProcessedMessagesCount()

  The count of messages that have been processed through this tunnel.

  Returns:

  the number of processed messages

• getReceiveTunnelId

  TunnelId getReceiveTunnelId(int hop)

  The tunnelId that the given hop receives messages on. The gateway is hop 0.

  Returns:

  the receive tunnel id

• getSendTunnelId

  TunnelId getSendTunnelId(int hop)

  The tunnelId that the given hop sends messages on. The gateway is hop 0.

  Returns:

  the send tunnel id

• getTestStatus

  TunnelTestStatus getTestStatus()

  The current test status of this tunnel for UI display.

  Returns:

  the current test status (UNTESTED, TESTING, GOOD, FAILING, or FAILED)

• getTunnelFailed

  boolean getTunnelFailed()

  Has the tunnel failed completely?

  Returns:

  the tunnel failed

• getVerifiedBytesTransferred

  long getVerifiedBytesTransferred()

  Number of bytes known to have travelled through the tunnel in its lifetime.

• incrementVerifiedBytesTransferred

  void incrementVerifiedBytesTransferred(int numBytes)

  Increment the verified byte count for data successfully sent through the tunnel.

  Parameters:

  numBytes - the number of bytes to add to the verified total

• isInbound

  boolean isInbound()

  Is this an inbound tunnel?

• recordRealTraffic

  void recordRealTraffic()

  Record that the tunnel carried real (non-test) traffic. Updated only at the real traffic delivery sites — inbound data arrival (InboundEndpointProcessor) and outbound message dispatch (OutboundClientMessageOneShotJob) — never by TestJob, so test traffic cannot pollute the proof that the tunnel works.

• setExpiration

  void setExpiration(long when)

  The tunnel's expiration time. Allows proactive tunnel cleanup by marking tunnels for expiry.

  Parameters:

  when - expiration time in milliseconds since epoch

• setReused

  void setReused()

  Note that we reused this tunnel

• setTestFailed

  void setTestFailed()

  The test status when a test fails. Called by TestJob when a tunnel test fails.

• setTestStarted

  void setTestStarted()

  The test status when a test is started. Called by TestJob when beginning a tunnel test.

• testSuccessful

  void testSuccessful(int responseTime)

  Record that the tunnel successfully processed a test with the given response time.

  Parameters:

  responseTime - the response time in milliseconds

• wasReused

  boolean wasReused()

  Did we reuse this tunnel?