PeerTestState (Javadocs [I2P+ 2.13.0+]

java.lang.Object
- net.i2p.router.transport.udp.PeerTestState

```
class PeerTestState
extends Object
```
Track the state of a peer test. Used only by PeerTestManager.

Nested Class Summary
Nested Classes
Modifier and Type Class and Description
static class PeerTestState.Role
Roles for peer testing scenarios.

Nested Classes
Modifier and Type	Class and Description
`static class`	`PeerTestState.Role` Roles for peer testing scenarios.

Constructor Summary
Constructors
Constructor and Description
PeerTestState(PeerTestState.Role role, PeerState bob, boolean isIPv6, long nonce, long now)
Create a new peer test state for the given role.

Constructors
Constructor and Description
`PeerTestState(PeerTestState.Role role, PeerState bob, boolean isIPv6, long nonce, long now)` Create a new peer test state for the given role.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`PeerState2`	`getAlice()` Return Alice's PeerState2 (SSU2 only).
`SessionKey`	`getAliceCipherKey()` Return Alice's cipher key.
`SessionKey`	`getAliceIntroKey()` Return Alice's intro key.
`InetAddress`	`getAliceIP()` If we are Alice, return the IP that Bob says we can be reached at.
`InetAddress`	`getAliceIPFromCharlie()` Return Alice's IP as reported by Charlie.
`SessionKey`	`getAliceMACKey()` Return Alice's MAC key.
`int`	`getAlicePort()` If we are Alice, return the port that Bob says we can be reached at.
`int`	`getAlicePortFromCharlie()` Return Alice's port as reported by Charlie.
`long`	`getBeginTime()` Return the time when this test began.
`PeerState`	`getBob()` Return Bob's PeerState.
`InetAddress`	`getBobIP()` Return Bob's IP address.
`int`	`getBobPort()` Return Bob's port.
`Hash`	`getCharlieHash()` Return Charlie's Hash (SSU2 only).
`SessionKey`	`getCharlieIntroKey()` Return Charlie's intro key.
`InetAddress`	`getCharlieIP()` Return Charlie's IP address.
`int`	`getCharliePort()` Return Charlie's port.
`long`	`getLastSendTime()` Return the time we last sent a packet.
`long`	`getNonce()` Return the test nonce identifier.
`PeerTestState.Role`	`getOurRole()` Return our role in the peer test.
`List<Hash>`	`getPreviousCharlies()` Return previous Charlie hashes (SSU2 only, Bob only).
`long`	`getReceiveAliceTime()` Return the time we last received from Alice.
`long`	`getReceiveBobTime()` Return the time we last received from Bob.
`long`	`getReceiveCharlieTime()` Return the time we last received from Charlie.
`long`	`getSendAliceTime()` Return when we last sent to Alice (SSU2 Bob only).
`long`	`getSendCharlieTime()` Return when we last sent to Charlie (SSU2 Alice only).
`int`	`getStatus()` Return the status code sent to Alice (SSU2 Bob only).
`byte[]`	`getTestData()` Get the test data for retransmission.
`int`	`incrementPacketsRelayed()` Increment and return the packets relayed count.
`boolean`	`isIPv6()` Whether this is an IPv6 test.
`void`	`setAlice(InetAddress ip, int port, Hash hash)` Set Alice's IP, port, and hash.
`void`	`setAlice(PeerState2 alice)` Set Alice's PeerState2 (SSU2 only).
`void`	`setAliceIntroKey(SessionKey key)` Set Alice's intro key.
`void`	`setAliceIPFromCharlie(InetAddress ip)` Set Alice's IP as reported by Charlie.
`void`	`setAliceKeys(SessionKey ck, SessionKey mk)` Set Alice's cipher and MAC keys.
`void`	`setAlicePortFromCharlie(int alicePortFromCharlie)` Set Alice's port as reported by Charlie.
`void`	`setCharlie(InetAddress ip, int port, Hash hash)` Set Charlie's IP, port, and hash.
`void`	`setCharlieIntroKey(SessionKey key)` Set Charlie's intro key.
`void`	`setCharliePort(int charliePort)` Set Charlie's port.
`void`	`setLastSendTime(long when)` Set the time we last sent a packet.
`void`	`setReceiveAliceTime(long when)` Set the time we last received from Alice.
`void`	`setReceiveBobTime(long when)` Set the time we last received from Bob.
`void`	`setReceiveCharlieTime(long when)` Set the time we last received from Charlie.
`void`	`setSendAliceTime(long when)` Set when we last sent to Alice (SSU2 Bob only).
`void`	`setSendCharlieTime(long when)` Set when we last sent to Charlie (SSU2 Alice only).
`void`	`setStatus(int status)` Set the status code sent to Alice (SSU2 Bob only).
`void`	`setTestData(byte[] data)` Save the test data for retransmission.
`String`	`toString()` toString.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - PeerTestState
```
public PeerTestState(PeerTestState.Role role,
                     PeerState bob,
                     boolean isIPv6,
                     long nonce,
                     long now)
```
    Create a new peer test state for the given role.
    Parameters:
    role - our role in the peer test
    bob - Bob's PeerState, or null if we are Bob
    isIPv6 - whether this is an IPv6 test
    nonce - the test nonce identifier
    now - the time when the test begins
- Method Detail
  - getAlice
```
public PeerState2 getAlice()
```
    Return Alice's PeerState2 (SSU2 only).
    Returns:
    Alice's SSU2 state, or null for SSU1
  - getAliceCipherKey
```
public SessionKey getAliceCipherKey()
```
    Return Alice's cipher key.
    Returns:
    the cipher key, or null if not set
  - getAliceIntroKey
```
public SessionKey getAliceIntroKey()
```
    Return Alice's intro key.
    Returns:
    Alice's intro key, or null if not set
  - getAliceIP
```
public InetAddress getAliceIP()
```
    If we are Alice, return the IP that Bob says we can be reached at. The IP that Charlie reports is available via getAliceIPFromCharlie().
    Returns:
    Alice's IP as reported by Bob
  - getAliceIPFromCharlie
```
public InetAddress getAliceIPFromCharlie()
```
    Return Alice's IP as reported by Charlie.
    Returns:
    Alice's IP from Charlie's perspective
  - getAliceMACKey
```
public SessionKey getAliceMACKey()
```
    Return Alice's MAC key.
    Returns:
    the MAC key, or null if not set
  - getAlicePort
```
public int getAlicePort()
```
    If we are Alice, return the port that Bob says we can be reached at. The port Charlie reports is available via getAlicePortFromCharlie().
    Returns:
    Alice's port as reported by Bob
  - getAlicePortFromCharlie
```
public int getAlicePortFromCharlie()
```
    Return Alice's port as reported by Charlie.
    Returns:
    Alice's port from Charlie's perspective
  - getBeginTime
```
public long getBeginTime()
```
    Return the time when this test began.
    Returns:
    the begin timestamp
  - getBob
```
public PeerState getBob()
```
    Return Bob's PeerState.
    Returns:
    Bob's PeerState, or null if we are Bob
  - getBobIP
```
public InetAddress getBobIP()
```
    Return Bob's IP address.
    Returns:
    Bob's remote IP
  - getBobPort
```
public int getBobPort()
```
    Return Bob's port.
    Returns:
    Bob's remote port
  - getCharlieHash
```
public Hash getCharlieHash()
```
    Return Charlie's Hash (SSU2 only).
    Returns:
    Charlie's Hash, or null for SSU1
  - getCharlieIntroKey
```
public SessionKey getCharlieIntroKey()
```
    Return Charlie's intro key.
    Returns:
    Charlie's intro key, or null if not set
  - getCharlieIP
```
public InetAddress getCharlieIP()
```
    Return Charlie's IP address.
    Returns:
    Charlie's IP, or null if not set
  - getCharliePort
```
public int getCharliePort()
```
    Return Charlie's port.
    Returns:
    Charlie's port, or 0 if not set
  - getLastSendTime
```
public long getLastSendTime()
```
    Return the time we last sent a packet.
    Returns:
    the last send timestamp
  - getNonce
```
public long getNonce()
```
    Return the test nonce identifier.
    Returns:
    the nonce
  - getOurRole
```
public PeerTestState.Role getOurRole()
```
    Return our role in the peer test.
    Returns:
    Alice, Bob, or Charlie
  - getPreviousCharlies
```
public List<Hash> getPreviousCharlies()
```
    Return previous Charlie hashes (SSU2 only, Bob only). Does not include the current Charlie.
    Returns:
    list of previous Charlie hashes, or null if not Bob
  - getReceiveAliceTime
```
public long getReceiveAliceTime()
```
    Return the time we last received from Alice.
    Returns:
    the receive timestamp
  - getReceiveBobTime
```
public long getReceiveBobTime()
```
    Return the time we last received from Bob.
    Returns:
    the receive timestamp
  - getReceiveCharlieTime
```
public long getReceiveCharlieTime()
```
    Return the time we last received from Charlie.
    Returns:
    the receive timestamp
  - getSendAliceTime
```
public long getSendAliceTime()
```
    Return when we last sent to Alice (SSU2 Bob only).
    Returns:
    the send timestamp
  - getSendCharlieTime
```
public long getSendCharlieTime()
```
    Return when we last sent to Charlie (SSU2 Alice only).
    Returns:
    the send timestamp
  - getStatus
```
public int getStatus()
```
    Return the status code sent to Alice (SSU2 Bob only).
    Returns:
    the status code
  - getTestData
```
public byte[] getTestData()
```
    Get the test data for retransmission. SSU2 only, used when we are Alice, Bob, or Charlie.
    Returns:
    the test data, or null if not set
  - incrementPacketsRelayed
```
public int incrementPacketsRelayed()
```
    Increment and return the packets relayed count.
    Returns:
    the incremented count
  - isIPv6
```
public boolean isIPv6()
```
    Whether this is an IPv6 test.
    Returns:
    true for IPv6, false for IPv4
  - setAlice
```
public void setAlice(InetAddress ip,
                     int port,
                     Hash hash)
```
    Set Alice's IP, port, and hash.
    Parameters:
    ip - Alice's IP address
    port - Alice's port
    hash - Alice's Hash (SSU2 only), null for SSU1
  - setAlice
```
public void setAlice(PeerState2 alice)
```
    Set Alice's PeerState2 (SSU2 only).
    Parameters:
    alice - Alice's SSU2 state
  - setAliceIntroKey
```
public void setAliceIntroKey(SessionKey key)
```
    Set Alice's intro key.
    Parameters:
    key - Alice's intro key
  - setAliceIPFromCharlie
```
public void setAliceIPFromCharlie(InetAddress ip)
```
    Set Alice's IP as reported by Charlie.
    Parameters:
    ip - Alice's IP from Charlie's perspective
  - setAliceKeys
```
public void setAliceKeys(SessionKey ck,
                         SessionKey mk)
```
    Set Alice's cipher and MAC keys.
    Parameters:
    ck - cipher key
    mk - MAC key
  - setAlicePortFromCharlie
```
public void setAlicePortFromCharlie(int alicePortFromCharlie)
```
    Set Alice's port as reported by Charlie.
    Parameters:
    alicePortFromCharlie - Alice's port from Charlie's perspective
  - setCharlie
```
public void setCharlie(InetAddress ip,
                       int port,
                       Hash hash)
```
    Set Charlie's IP, port, and hash. Saves the previous Charlie hash for tracking rotations.
    Parameters:
    ip - Charlie's IP address
    port - Charlie's port
    hash - Charlie's Hash (SSU2 only), null for SSU1
  - setCharlieIntroKey
```
public void setCharlieIntroKey(SessionKey key)
```
    Set Charlie's intro key.
    Parameters:
    key - Charlie's intro key
  - setCharliePort
```
public void setCharliePort(int charliePort)
```
    Set Charlie's port.
    Parameters:
    charliePort - Charlie's port number
  - setLastSendTime
```
public void setLastSendTime(long when)
```
    Set the time we last sent a packet.
    Parameters:
    when - the last send timestamp
  - setReceiveAliceTime
```
public void setReceiveAliceTime(long when)
```
    Set the time we last received from Alice.
    Parameters:
    when - the receive timestamp
  - setReceiveBobTime
```
public void setReceiveBobTime(long when)
```
    Set the time we last received from Bob.
    Parameters:
    when - the receive timestamp
  - setReceiveCharlieTime
```
public void setReceiveCharlieTime(long when)
```
    Set the time we last received from Charlie.
    Parameters:
    when - the receive timestamp
  - setSendAliceTime
```
public void setSendAliceTime(long when)
```
    Set when we last sent to Alice (SSU2 Bob only).
    Parameters:
    when - the send timestamp
  - setSendCharlieTime
```
public void setSendCharlieTime(long when)
```
    Set when we last sent to Charlie (SSU2 Alice only).
    Parameters:
    when - the send timestamp
  - setStatus
```
public void setStatus(int status)
```
    Set the status code sent to Alice (SSU2 Bob only).
    Parameters:
    status - the status
  - setTestData
```
public void setTestData(byte[] data)
```
    Save the test data for retransmission. SSU2 only, used when we are Alice, Bob, or Charlie.
    Parameters:
    data - the test data
  - toString
```
public String toString()
```
    toString.
    Overrides:
    toString in class Object

Class PeerTestState

Nested Class Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

PeerTestState

Method Detail

getAlice

getAliceCipherKey

getAliceIntroKey

getAliceIP

getAliceIPFromCharlie

getAliceMACKey

getAlicePort

getAlicePortFromCharlie

getBeginTime

getBob

getBobIP

getBobPort

getCharlieHash

getCharlieIntroKey

getCharlieIP

getCharliePort

getLastSendTime

getNonce

getOurRole

getPreviousCharlies

getReceiveAliceTime

getReceiveBobTime

getReceiveCharlieTime

getSendAliceTime

getSendCharlieTime

getStatus

getTestData

incrementPacketsRelayed

isIPv6

setAlice

setAlice

setAliceIntroKey

setAliceIPFromCharlie

setAliceKeys

setAlicePortFromCharlie

setCharlie

setCharlieIntroKey

setCharliePort

setLastSendTime

setReceiveAliceTime

setReceiveBobTime

setReceiveCharlieTime

setSendAliceTime

setSendCharlieTime

setStatus

setTestData

toString