HopConfig (Javadocs [I2P+ 2.13.0+] - API Version 0.9.70+)

java.lang.Object
- net.i2p.router.tunnel.HopConfig

```
public class HopConfig
extends Object
```
Defines the general configuration for a hop in a tunnel. This is used for both participating tunnels and tunnels we create. Data only stored for tunnels we create should be in TunnelCreatorConfig to save space.

Constructor Summary
Constructors
Constructor and Description
HopConfig()
Creates a new HopConfig with default values

Constructors
Constructor and Description
`HopConfig()` Creates a new HopConfig with default values

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`int`	`getAllocatedBW()` The bandwidth allocated for this hop.
`(package private) int`	`getAndResetRecentMessagesCount()` This returns the number of processed messages since the last time this was called, and resets the count.
`long`	`getCreation()` When was this tunnel created (in ms since the epoch)?
`long`	`getExpiration()` When does this tunnel expire (in ms since the epoch)?
`SessionKey`	`getIVKey()` What key encrypts the preIV before passing it on?
`SessionKey`	`getLayerKey()` What key encrypts the layer before passing it on?
`int`	`getProcessedMessagesCount()` Processed messages count.
`Hash`	`getReceiveFrom()` What is the previous peer in the tunnel (null if gateway)?
`TunnelId`	`getReceiveTunnel()` What tunnel ID are we receiving on? (null if uninitialized)
`long`	`getReceiveTunnelId()` What tunnel ID are we receiving on? (0 if uninitialized)
`int`	`getRecentMessagesCount()` This returns the number of processed messages since the last time getAndResetRecentMessagesCount() was called.
`Hash`	`getSendTo()` What is the next peer in the tunnel (null if endpoint)?
`TunnelId`	`getSendTunnel()` What is the next tunnel ID we are sending to? (null if endpoint)
`long`	`getSendTunnelId()` What is the next tunnel ID we are sending to? (0 if endpoint)
`void`	`incrementProcessedMessages()` Take note of a message being pumped through this tunnel.
`void`	`setAllocatedBW(int bw)` The bandwidth allocated for this hop.
`void`	`setCreation(long when)` The tunnel creation time, in ms since the epoch.
`void`	`setExpiration(long when)` The tunnel expiration time, in ms since the epoch.
`void`	`setIVKey(SessionKey key)` The key to encrypt the IV with before passing it on.
`void`	`setLayerKey(SessionKey key)` The key to encrypt the layer with before passing it on.
`void`	`setReceiveFrom(Hash from)` Do not set for gateway
`void`	`setReceiveTunnelId(long id)` The receive tunnel ID, from 1 to 0xffffffff.
`void`	`setReceiveTunnelId(TunnelId id)` The tunnel ID to receive messages on.
`void`	`setSendTo(Hash to)` Do not set for endpoint
`void`	`setSendTunnelId(long id)` The send tunnel ID, from 1 to 0xffffffff.
`void`	`setSendTunnelId(TunnelId id)` The tunnel ID to send messages through.
`String`	`toString()`

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

- Constructor Detail
  - HopConfig
```
public HopConfig()
```
    Creates a new HopConfig with default values
- Method Detail
  - getAllocatedBW
```
public int getAllocatedBW()
```
    The bandwidth allocated for this hop.
    Returns:
    Bps
  - getAndResetRecentMessagesCount
```
int getAndResetRecentMessagesCount()
```
    This returns the number of processed messages since the last time this was called, and resets the count. It should only be called by code that updates the router stats. See TunnelDispatcher.updateParticipatingStats().
  - getCreation
```
public long getCreation()
```
    When was this tunnel created (in ms since the epoch)?
  - getExpiration
```
public long getExpiration()
```
    When does this tunnel expire (in ms since the epoch)?
  - getIVKey
```
public SessionKey getIVKey()
```
    What key encrypts the preIV before passing it on?
  - getLayerKey
```
public SessionKey getLayerKey()
```
    What key encrypts the layer before passing it on?
  - getProcessedMessagesCount
```
public int getProcessedMessagesCount()
```
    Processed messages count.
    Returns:
    the processed messages count
  - getReceiveFrom
```
public Hash getReceiveFrom()
```
    What is the previous peer in the tunnel (null if gateway)?
  - getReceiveTunnel
```
public TunnelId getReceiveTunnel()
```
    What tunnel ID are we receiving on? (null if uninitialized)
    Returns:
    the receive tunnel or null
  - getReceiveTunnelId
```
public long getReceiveTunnelId()
```
    What tunnel ID are we receiving on? (0 if uninitialized)
    Returns:
    the receive tunnel ID or 0
  - getRecentMessagesCount
```
public int getRecentMessagesCount()
```
    This returns the number of processed messages since the last time getAndResetRecentMessagesCount() was called. As of 0.9.23, does NOT reset the count, see getAndResetRecentMessagesCount().
    Returns:
    the recent messages count
  - getSendTo
```
public Hash getSendTo()
```
    What is the next peer in the tunnel (null if endpoint)?
  - getSendTunnel
```
public TunnelId getSendTunnel()
```
    What is the next tunnel ID we are sending to? (null if endpoint)
    Returns:
    the send tunnel or null
  - getSendTunnelId
```
public long getSendTunnelId()
```
    What is the next tunnel ID we are sending to? (0 if endpoint)
    Returns:
    the send tunnel ID or 0
  - incrementProcessedMessages
```
public void incrementProcessedMessages()
```
    Take note of a message being pumped through this tunnel. "processed" is for incoming and "sent" is for outgoing (could be dropped in between) We use synchronization instead of an AtomicInteger here to save space.
  - setAllocatedBW
```
public void setAllocatedBW(int bw)
```
    The bandwidth allocated for this hop.
    Parameters:
    bw - Bps
  - setCreation
```
public void setCreation(long when)
```
    The tunnel creation time, in ms since the epoch.
  - setExpiration
```
public void setExpiration(long when)
```
    The tunnel expiration time, in ms since the epoch.
  - setIVKey
```
public void setIVKey(SessionKey key)
```
    The key to encrypt the IV with before passing it on.
  - setLayerKey
```
public void setLayerKey(SessionKey key)
```
    The key to encrypt the layer with before passing it on.
  - setReceiveFrom
```
public void setReceiveFrom(Hash from)
```
    Do not set for gateway
    Parameters:
    from - the previous peer hash
  - setReceiveTunnelId
```
public void setReceiveTunnelId(long id)
```
    The receive tunnel ID, from 1 to 0xffffffff.
    Parameters:
    id - 1 to 0xffffffff
    Throws:
    IllegalArgumentException - if less than or equal to zero or greater than max value
  - setReceiveTunnelId
```
public void setReceiveTunnelId(TunnelId id)
```
    The tunnel ID to receive messages on.
    Parameters:
    id - the tunnel ID
  - setSendTo
```
public void setSendTo(Hash to)
```
    Do not set for endpoint
    Parameters:
    to - the next peer hash
  - setSendTunnelId
```
public void setSendTunnelId(long id)
```
    The send tunnel ID, from 1 to 0xffffffff. Do not set for endpoint
    Parameters:
    id - 1 to 0xffffffff
    Throws:
    IllegalArgumentException - if less than or equal to zero or greater than max value
  - setSendTunnelId
```
public void setSendTunnelId(TunnelId id)
```
    The tunnel ID to send messages through. Do not set for endpoint
    Parameters:
    id - the tunnel ID
  - toString
```
public String toString()
```
    Overrides:
    toString in class Object

Class HopConfig

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

HopConfig

Method Detail

getAllocatedBW

getAndResetRecentMessagesCount

getCreation

getExpiration

getIVKey

getLayerKey

getProcessedMessagesCount

getReceiveFrom

getReceiveTunnel

getReceiveTunnelId

getRecentMessagesCount

getSendTo

getSendTunnel

getSendTunnelId

incrementProcessedMessages

setAllocatedBW

setCreation

setExpiration

setIVKey

setLayerKey

setReceiveFrom

setReceiveTunnelId

setReceiveTunnelId

setSendTo

setSendTunnelId

setSendTunnelId

toString