ConnectionManager (Javadocs [I2P+ 2.13.0+]

java.lang.Object
- net.i2p.client.streaming.impl.ConnectionManager

```
class ConnectionManager
extends Object
```
Coordinate all of the connections for a single local destination.

Nested Class Summary
Nested Classes
Modifier and Type Class and Description
static interface ConnectionManager.PingNotifier
The callback interface for a pong.

Nested Classes
Modifier and Type	Class and Description
`static interface`	`ConnectionManager.PingNotifier` The callback interface for a pong.

Field Summary
Fields
Modifier and Type Field and Description
static String PROP_BLACKLIST
Blacklist property for streaming.
(package private) static String PROP_MAX_PONG_DELAY
Property: maximum pong delay in ms.

Fields
Modifier and Type	Field and Description
`static String`	`PROP_BLACKLIST` Blacklist property for streaming.
`(package private) static String`	`PROP_MAX_PONG_DELAY` Property: maximum pong delay in ms.

Constructor Summary

Constructors
Constructor and Description
`ConnectionManager(I2PAppContext context, I2PSession session, ConnectionOptions defaultOptions, IncomingConnectionFilter connectionFilter)` Manage all conns for this session

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`boolean`	`answerPings()` Do we respond to pings that aren't on an existing connection?
`(package private) void`	`cleanupPool()` Periodic pool cleanup — evicts stale connections.
`Connection`	`connect(Destination peer, ConnectionOptions opts, I2PSession session)` Build a new connection to the given peer.
`void`	`disconnectAllHard()` Something b0rked hard, so kill all of our connections without mercy.
`boolean`	`getAllowIncomingConnections()` Whether incoming connections are accepted.
`(package private) Connection`	`getConnectionByInboundId(long id)` Look up a connection by its inbound stream ID.
`(package private) Connection`	`getConnectionByOutboundId(long id)` Look up a connection by its outbound stream ID.
`ConnectionHandler`	`getConnectionHandler()` Connection handler for this manager.
`MessageHandler`	`getMessageHandler()` Message handler for this manager.
`PacketHandler`	`getPacketHandler()` Packet handler for this manager.
`PacketQueue`	`getPacketQueue()` Outbound packet queue.
`I2PSession`	`getSession()` This is the primary session only
`long`	`getSoTimeout()` Socket accept() timeout.
`Set<Connection>`	`listConnections()` Connections currently managed.
`boolean`	`ping(Destination peer, int fromPort, int toPort, long timeoutMs)` Ping the destination and wait for a pong.
`boolean`	`ping(Destination peer, int fromPort, int toPort, long timeoutMs, boolean blocking)` Ping the destination, optionally waiting for a pong.
`boolean`	`ping(Destination peer, int fromPort, int toPort, long timeoutMs, boolean blocking, ConnectionManager.PingNotifier notifier)` Ping the destination, optionally waiting for a pong.
`byte[]`	`ping(Destination peer, int fromPort, int toPort, long timeoutMs, byte[] payload)` Ping the destination with a payload and wait for the pong.
`boolean`	`ping(Destination peer, long timeoutMs)` Ping the destination and wait for a pong.
`Connection`	`receiveConnection(Packet synPacket)` Create a new connection based on the SYN packet we received.
`boolean`	`receivePing(Connection con, Packet ping)` Process a ping by checking for throttling, etc., then sending a pong.
`(package private) void`	`receivePong(long pingId, ByteArray payload)` Process a received pong response.
`(package private) void`	`registerOutboundId(Connection con)` Register outbound id.
`void`	`removeConnection(Connection con)` Remove a connection from the manager.
`void`	`setAllowIncomingConnections(boolean allow)` Enable or disable acceptance of incoming connections.
`void`	`setSoTimeout(long x)` Socket accept() timeout.
`void`	`shutdown()` Kill all connections and the timers.
`String`	`toString()`
`void`	`updateOptions()` Update the throttler options
`void`	`updateOptsFromShare(Connection con)` Update opts from share.
`void`	`updateShareOpts(Connection con)` Update share opts.
`boolean`	`wasRecentlyClosed(long inboundID)` Was this conn recently closed?

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

- Field Detail
  - PROP_BLACKLIST
```
public static final String PROP_BLACKLIST
```
    Blacklist property for streaming.
    See Also:
    Constant Field Values
  - PROP_MAX_PONG_DELAY
```
static final String PROP_MAX_PONG_DELAY
```
    Property: maximum pong delay in ms.
    See Also:
    Constant Field Values
- Constructor Detail
  - ConnectionManager
```
public ConnectionManager(I2PAppContext context,
                         I2PSession session,
                         ConnectionOptions defaultOptions,
                         IncomingConnectionFilter connectionFilter)
```
    Manage all conns for this session
    Parameters:
    context - the I2P app context
    session - the primary session, packets may come in on subsessions also
    defaultOptions - the default connection options
    connectionFilter - the incoming connection filter
- Method Detail
  - answerPings
```
public boolean answerPings()
```
    Do we respond to pings that aren't on an existing connection?
    Returns:
    true if we answer pings
  - cleanupPool
```
void cleanupPool()
```
    Periodic pool cleanup — evicts stale connections. Called from timer or on shutdown.
  - connect
```
public Connection connect(Destination peer,
                          ConnectionOptions opts,
                          I2PSession session)
```
    Build a new connection to the given peer. This blocks if there is no connection delay, otherwise it returns immediately.
    Parameters:
    peer - Destination to contact, non-null
    opts - Connection's options
    session - generally the session from the constructor, but could be a subsession
    Returns:
    new connection, or null if we have exceeded our limit
  - disconnectAllHard
```
public void disconnectAllHard()
```
    Something b0rked hard, so kill all of our connections without mercy. Don't bother sending close packets. This will not close the ServerSocket. This will not kill the timer threads. CAN continue to use the manager.
  - getAllowIncomingConnections
```
public boolean getAllowIncomingConnections()
```
    Whether incoming connections are accepted.
    Returns:
    if we should accept connections
  - getConnectionByInboundId
```
Connection getConnectionByInboundId(long id)
```
    Look up a connection by its inbound stream ID.
    Parameters:
    id - the inbound stream ID
    Returns:
    the connection, or null if not found
  - getConnectionByOutboundId
```
Connection getConnectionByOutboundId(long id)
```
    Look up a connection by its outbound stream ID. Not guaranteed to be unique, but in case we receive more than one packet on an inbound connection that we haven't ack'ed yet...
    Parameters:
    id - the outbound stream ID
    Returns:
    the connection, or null if not found
  - getConnectionHandler
```
public ConnectionHandler getConnectionHandler()
```
    Connection handler for this manager.
    Returns:
    the connection handler
  - getMessageHandler
```
public MessageHandler getMessageHandler()
```
    Message handler for this manager.
    Returns:
    the message handler
  - getPacketHandler
```
public PacketHandler getPacketHandler()
```
    Packet handler for this manager.
    Returns:
    the packet handler
  - getPacketQueue
```
public PacketQueue getPacketQueue()
```
    Outbound packet queue.
    Returns:
    the outbound packet queue
  - getSession
```
public I2PSession getSession()
```
    This is the primary session only
    Returns:
    the session
  - getSoTimeout
```
public long getSoTimeout()
```
    Socket accept() timeout.
    Returns:
    accept timeout in ms.
  - listConnections
```
public Set<Connection> listConnections()
```
    Connections currently managed.
    Returns:
    set of Connection objects
  - ping
```
public boolean ping(Destination peer,
                    int fromPort,
                    int toPort,
                    long timeoutMs)
```
    Ping the destination and wait for a pong.
    Parameters:
    peer - the destination
    fromPort - the source port
    toPort - the destination port
    timeoutMs - greater than zero
    Returns:
    true if pong received
  - ping
```
public boolean ping(Destination peer,
                    int fromPort,
                    int toPort,
                    long timeoutMs,
                    boolean blocking)
```
    Ping the destination, optionally waiting for a pong.
    Parameters:
    peer - the destination
    fromPort - the source port
    toPort - the destination port
    timeoutMs - greater than zero
    blocking - true to block until pong
    Returns:
    true if blocking and pong received
  - ping
```
public boolean ping(Destination peer,
                    int fromPort,
                    int toPort,
                    long timeoutMs,
                    boolean blocking,
                    ConnectionManager.PingNotifier notifier)
```
    Ping the destination, optionally waiting for a pong.
    Parameters:
    peer - the destination
    fromPort - the source port
    toPort - the destination port
    timeoutMs - greater than zero
    blocking - true to block until pong
    notifier - may be null
    Returns:
    true if blocking and pong received
  - ping
```
public byte[] ping(Destination peer,
                   int fromPort,
                   int toPort,
                   long timeoutMs,
                   byte[] payload)
```
    Ping the destination with a payload and wait for the pong.
    Parameters:
    peer - the destination
    fromPort - the source port
    toPort - the destination port
    timeoutMs - greater than zero
    payload - non-null, include in packet, up to 32 bytes may be returned in pong not copied, do not modify
    Returns:
    the payload received in the pong, zero-length if none, null on failure or timeout
  - ping
```
public boolean ping(Destination peer,
                    long timeoutMs)
```
    Ping the destination and wait for a pong.
    Parameters:
    peer - the destination
    timeoutMs - greater than zero
    Returns:
    true if pong received
  - receiveConnection
```
public Connection receiveConnection(Packet synPacket)
```
    Create a new connection based on the SYN packet we received.
    Parameters:
    synPacket - SYN packet to process
    Returns:
    created Connection with the packet's data already delivered to it, or null if the syn's streamId was already taken, or if the connection was rejected
  - receivePing
```
public boolean receivePing(Connection con,
                           Packet ping)
```
    Process a ping by checking for throttling, etc., then sending a pong.
    Parameters:
    con - null if unknown
    ping - Ping packet to process, must have From and Sig fields, with signature already verified, only if answerPings() returned true
    Returns:
    true if we sent a pong
  - receivePong
```
void receivePong(long pingId,
                 ByteArray payload)
```
    Process a received pong response.
    Parameters:
    pingId - the ping stream ID to match
    payload - the pong payload, may be null
  - registerOutboundId
```
void registerOutboundId(Connection con)
```
    Register outbound id.
  - removeConnection
```
public void removeConnection(Connection con)
```
    Remove a connection from the manager.
    Parameters:
    con - Connection to drop.
  - setAllowIncomingConnections
```
public void setAllowIncomingConnections(boolean allow)
```
    Enable or disable acceptance of incoming connections. When first enabled, initializes throttlers if needed.
    Parameters:
    allow - true to accept incoming connections
  - setSoTimeout
```
public void setSoTimeout(long x)
```
    Socket accept() timeout.
    Parameters:
    x -
  - shutdown
```
public void shutdown()
```
    Kill all connections and the timers. Don't bother sending close packets. As of 0.9.17, this will close the ServerSocket, killing one thread in accept(). CANNOT continue to use the manager or restart.
  - toString
```
public String toString()
```
    Overrides:
    toString in class Object
  - updateOptions
```
public void updateOptions()
```
    Update the throttler options
  - updateOptsFromShare
```
public void updateOptsFromShare(Connection con)
```
    Update opts from share.
    Parameters:
    con - the connection
  - updateShareOpts
```
public void updateShareOpts(Connection con)
```
    Update share opts.
    Parameters:
    con - the connection
  - wasRecentlyClosed
```
public boolean wasRecentlyClosed(long inboundID)
```
    Was this conn recently closed?

Class ConnectionManager

Nested Class Summary

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

PROP_BLACKLIST

PROP_MAX_PONG_DELAY

Constructor Detail

ConnectionManager

Method Detail

answerPings

cleanupPool

connect

disconnectAllHard

getAllowIncomingConnections

getConnectionByInboundId

getConnectionByOutboundId

getConnectionHandler

getMessageHandler

getPacketHandler

getPacketQueue

getSession

getSoTimeout

listConnections

ping

ping

ping

ping

ping

receiveConnection

receivePing

receivePong

registerOutboundId

removeConnection

setAllowIncomingConnections

setSoTimeout

shutdown

toString

updateOptions

updateOptsFromShare

updateShareOpts

wasRecentlyClosed