ClientManager (I2P Anonymous Network - Java Documentation

java.lang.Object
- net.i2p.router.client.ClientManager

Direct Known Subclasses:

LocalClientManager
```
class ClientManager
extends Object
```
Coordinate connections and various tasks

Author:

jrandom

Field Summary

Fields
Modifier and Type	Field and Description
`protected RouterContext`	`_ctx`
`protected boolean`	`_isStarted`
`protected List<ClientListenerRunner>`	`_listeners`
`protected int`	`_port`
`protected boolean`	`_wasStarted`
`static net.i2p.data.i2cp.SessionId`	`UNKNOWN_SESSION_ID` 65535

Constructor Summary

Constructors
Constructor and Description

ClientManager(RouterContext context, int port)
Does not start the listeners.

Constructors
Constructor and Description
`ClientManager(RouterContext context, int port)` Does not start the listeners.

Method Summary

All Methods Instance Methods Concrete Methods Deprecated Methods
Modifier and Type	Method and Description
`int`	`destinationEstablished(ClientConnectionRunner runner, net.i2p.data.Destination dest)` Add to the clients list.
`(package private) void`	`distributeMessage(net.i2p.data.Destination fromDest, net.i2p.data.Destination toDest, net.i2p.data.Payload payload, net.i2p.data.i2cp.MessageId msgId, long messageNonce, long expiration, int flags)` Distribute message to a local or remote destination.
`net.i2p.data.i2cp.SessionConfig`	`getClientSessionConfig(net.i2p.data.Destination dest)` Return the client's current config, or null if not connected
`net.i2p.crypto.SessionKeyManager`	`getClientSessionKeyManager(net.i2p.data.Hash dest)` Return the client's SessionKeyManager Use this instead of the RouterContext.sessionKeyManager() to prevent correlation attacks across destinations
`(package private) ClientConnectionRunner`	`getRunner(net.i2p.data.Destination dest)` Unsynchronized
`(package private) Set<net.i2p.data.Destination>`	`getRunnerDestinations()`
`net.i2p.internal.I2CPMessageQueue`	`internalConnect()` The InternalClientManager interface.
`boolean`	`isAlive()` As of 0.9.45, this returns true iff the ClientManager is running.
`boolean`	`isLocal(net.i2p.data.Destination dest)` Unsynchronized.
`boolean`	`isLocal(net.i2p.data.Hash destHash)` Unsynchronized.
`Set<net.i2p.data.Destination>`	`listClients()` Unsynchronized.
`void`	`messageDeliveryStatusUpdate(net.i2p.data.Destination fromDest, net.i2p.data.i2cp.MessageId id, long messageNonce, int status)`
`void`	`messageReceived(ClientMessage msg)`
`void`	`registerConnection(ClientConnectionRunner runner)`
`boolean`	`registerEncryptedDestination(ClientConnectionRunner runner, net.i2p.data.Hash hash)` Call after destinationEstablished(), when an encrypted leaseset is created, so we know it's local.
`void`	`registerMetaDest(net.i2p.data.Destination dest)` Declare that we're going to publish a meta LS for this destination.
`void`	`renderStatusHTML(Writer out)` Deprecated. unused
`void`	`reportAbuse(net.i2p.data.Destination dest, String reason, int severity)` Unused
`void`	`requestLeaseSet(net.i2p.data.Destination dest, net.i2p.data.LeaseSet set, long timeout, Job onCreateJob, Job onFailedJob)` Request that a particular client authorize the Leases contained in the LeaseSet, after which the onCreateJob is queued up.
`void`	`requestLeaseSet(net.i2p.data.Hash dest, net.i2p.data.LeaseSet ls)` Request that a particular client authorize the Leases contained in the LeaseSet.
`void`	`restart()`
`boolean`	`shouldPublishLeaseSet(net.i2p.data.Hash destHash)`
`void`	`shutdown(String msg)`
`void`	`start()`
`protected void`	`startListeners()` Call from synchronized method Todo: Start a 3rd listener for IPV6?
`void`	`unregisterConnection(ClientConnectionRunner runner)` Remove all sessions for this runner.
`void`	`unregisterEncryptedDestination(ClientConnectionRunner runner, net.i2p.data.Hash hash)` Remove the hash for the encrypted LS.
`void`	`unregisterMetaDest(net.i2p.data.Destination dest)` Declare that we're no longer going to publish a meta LS for this destination.
`void`	`unregisterSession(net.i2p.data.i2cp.SessionId id, net.i2p.data.Destination dest)` Remove only the following session.

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

- Field Detail
  - _listeners
```
protected final List<ClientListenerRunner> _listeners
```
  - _ctx
```
protected final RouterContext _ctx
```
  - _port
```
protected final int _port
```
  - _isStarted
```
protected volatile boolean _isStarted
```
  - _wasStarted
```
protected volatile boolean _wasStarted
```
  - UNKNOWN_SESSION_ID
```
public static final net.i2p.data.i2cp.SessionId UNKNOWN_SESSION_ID
```
    65535
- Constructor Detail
  - ClientManager
```
public ClientManager(RouterContext context,
                     int port)
```
    Does not start the listeners. Caller must call start()
- Method Detail
  - start
```
public void start()
```
    Since:
    
    0.9.8
  - startListeners
```
protected void startListeners()
```
    Call from synchronized method Todo: Start a 3rd listener for IPV6?
  - restart
```
public void restart()
```
  - shutdown
```
public void shutdown(String msg)
```
    Parameters:
    
    msg - message to send to the clients
  - internalConnect
```
public net.i2p.internal.I2CPMessageQueue internalConnect()
                                                  throws net.i2p.client.I2PSessionException
```
    The InternalClientManager interface. Connects to the router, receiving a message queue to talk to the router with.
    
    Throws:
    
    net.i2p.client.I2PSessionException - if the router isn't ready
    
    Since:
    
    0.8.3
  - isAlive
```
public boolean isAlive()
```
    As of 0.9.45, this returns true iff the ClientManager is running. Prior to that, it also required all external I2CP listeners that were registered to be running. Since most of our connections are in-JVM, we now return true even if we have I2CP port conflicts.
  - registerConnection
```
public void registerConnection(ClientConnectionRunner runner)
```
  - unregisterConnection
```
public void unregisterConnection(ClientConnectionRunner runner)
```
    Remove all sessions for this runner.
  - unregisterSession
```
public void unregisterSession(net.i2p.data.i2cp.SessionId id,
                              net.i2p.data.Destination dest)
```
    Remove only the following session. Does not remove the runner if it has more.
    
    Since:
    
    0.9.21
  - unregisterEncryptedDestination
```
public void unregisterEncryptedDestination(ClientConnectionRunner runner,
                                           net.i2p.data.Hash hash)
```
    Remove the hash for the encrypted LS. Call before unregisterConnection, or when the hash changes.
    
    Since:
    
    0.9.39
  - destinationEstablished
```
public int destinationEstablished(ClientConnectionRunner runner,
                                  net.i2p.data.Destination dest)
```
    Add to the clients list. Check for a dup destination. Side effect: Sets the session ID of the runner. Caller must call runner.disconnectClient() on failure.
    
    Returns:
    
    SessionStatusMessage return code, 1 for success, != 1 for failure
  - registerEncryptedDestination
```
public boolean registerEncryptedDestination(ClientConnectionRunner runner,
                                            net.i2p.data.Hash hash)
```
    Call after destinationEstablished(), when an encrypted leaseset is created, so we know it's local. Add to the clients list. Check for a dup hash. Caller must call runner.disconnectClient() on failure.
    
    Parameters:
    
    hash - the location of the encrypted LS, will change every day
    
    Returns:
    
    success, false on dup
    
    Since:
    
    0.9.39
  - registerMetaDest
```
public void registerMetaDest(net.i2p.data.Destination dest)
                      throws net.i2p.client.I2PSessionException
```
    Declare that we're going to publish a meta LS for this destination. Must be called before publishing the leaseset.
    
    Throws:
    
    net.i2p.client.I2PSessionException - on duplicate dest
    
    Since:
    
    0.9.41
  - unregisterMetaDest
```
public void unregisterMetaDest(net.i2p.data.Destination dest)
```
    Declare that we're no longer going to publish a meta LS for this destination.
    
    Since:
    
    0.9.41
  - distributeMessage
```
void distributeMessage(net.i2p.data.Destination fromDest,
                       net.i2p.data.Destination toDest,
                       net.i2p.data.Payload payload,
                       net.i2p.data.i2cp.MessageId msgId,
                       long messageNonce,
                       long expiration,
                       int flags)
```
    Distribute message to a local or remote destination.
    
    Parameters:
    
    msgId - the router's ID for this message
    
    messageNonce - the client's ID for this message
    
    flags - ignored for local
  - requestLeaseSet
```
public void requestLeaseSet(net.i2p.data.Destination dest,
                            net.i2p.data.LeaseSet set,
                            long timeout,
                            Job onCreateJob,
                            Job onFailedJob)
```
    Request that a particular client authorize the Leases contained in the LeaseSet, after which the onCreateJob is queued up. If that doesn't occur within the timeout specified, queue up the onFailedJob. This call does not block. UNUSED, the call below without jobs is always used.
    
    Parameters:
    
    dest - Destination from which the LeaseSet's authorization should be requested
    
    set - LeaseSet with requested leases - this object must be updated to contain the signed version (as well as any changed/added/removed Leases). The LeaseSet contains Leases only; it is unsigned and does not have the destination set.
    
    timeout - ms to wait before failing
    
    onCreateJob - Job to run after the LeaseSet is authorized
    
    onFailedJob - Job to run after the timeout passes without receiving authorization
  - requestLeaseSet
```
public void requestLeaseSet(net.i2p.data.Hash dest,
                            net.i2p.data.LeaseSet ls)
```
    Request that a particular client authorize the Leases contained in the LeaseSet.
    
    Parameters:
    
    dest - Destination from which the LeaseSet's authorization should be requested
    
    ls - LeaseSet with requested leases - this object must be updated to contain the signed version (as well as any changed/added/removed Leases). The LeaseSet contains Leases only; it is unsigned and does not have the destination set.
  - isLocal
```
public boolean isLocal(net.i2p.data.Destination dest)
```
    Unsynchronized. DOES contain meta destinations.
  - isLocal
```
public boolean isLocal(net.i2p.data.Hash destHash)
```
    Unsynchronized. DOES contain meta destinations.
  - shouldPublishLeaseSet
```
public boolean shouldPublishLeaseSet(net.i2p.data.Hash destHash)
```
    Returns:
    
    true if we don't know about this destination at all
  - listClients
```
public Set<net.i2p.data.Destination> listClients()
```
    Unsynchronized. Does NOT contain meta destinations.
  - getRunner
```
ClientConnectionRunner getRunner(net.i2p.data.Destination dest)
```
    Unsynchronized
  - getClientSessionConfig
```
public net.i2p.data.i2cp.SessionConfig getClientSessionConfig(net.i2p.data.Destination dest)
```
    Return the client's current config, or null if not connected
  - getClientSessionKeyManager
```
public net.i2p.crypto.SessionKeyManager getClientSessionKeyManager(net.i2p.data.Hash dest)
```
    Return the client's SessionKeyManager Use this instead of the RouterContext.sessionKeyManager() to prevent correlation attacks across destinations
  - messageDeliveryStatusUpdate
```
public void messageDeliveryStatusUpdate(net.i2p.data.Destination fromDest,
                                        net.i2p.data.i2cp.MessageId id,
                                        long messageNonce,
                                        int status)
```
    Parameters:
    
    id - the router's ID for this message
    
    messageNonce - the client's ID for this message, greater than zero
    
    status - see I2CP MessageStatusMessage for success/failure codes
  - getRunnerDestinations
```
Set<net.i2p.data.Destination> getRunnerDestinations()
```
    Returns:
    
    unmodifiable, not a copy
  - reportAbuse
```
public void reportAbuse(net.i2p.data.Destination dest,
                        String reason,
                        int severity)
```
    Unused
    
    Parameters:
    
    dest - null for all local destinations
  - renderStatusHTML
```
@Deprecated
public void renderStatusHTML(Writer out)
                                  throws IOException
```
    Deprecated. unused
    
    Throws:
    
    IOException
  - messageReceived
```
public void messageReceived(ClientMessage msg)
```

Class ClientManager

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

_listeners

_ctx

_port

_isStarted

_wasStarted

UNKNOWN_SESSION_ID

Constructor Detail

ClientManager

Method Detail

start

startListeners

restart

shutdown

internalConnect

isAlive

registerConnection

unregisterConnection

unregisterSession

unregisterEncryptedDestination

destinationEstablished

registerEncryptedDestination

registerMetaDest

unregisterMetaDest

distributeMessage

requestLeaseSet

requestLeaseSet

isLocal

isLocal

shouldPublishLeaseSet

listClients

getRunner

getClientSessionConfig

getClientSessionKeyManager

messageDeliveryStatusUpdate

getRunnerDestinations

reportAbuse

renderStatusHTML

messageReceived