QueuedClientConnectionRunner

java.lang.Object

net.i2p.router.client.ClientConnectionRunner

net.i2p.router.client.QueuedClientConnectionRunner

class QueuedClientConnectionRunnerextends ClientConnectionRunner

Zero-copy in-JVM. While super() starts both a reader and a writer thread, we only need a reader thread here.

Field Summary
Fields
Modifier and Type
Field
Description
private final I2CPMessageQueue
queue
The queue shared with the client.
Fields inherited from class ClientConnectionRunner
_context, _log, _manager, _reader
Modifier and Type
Field
Description
protected final RouterContext
_context
Router context.
protected final Log
_log
Logger for the runner.
protected final ClientManager
_manager
Client manager managing this runner.
protected I2CPMessageReader
_reader
Reads and processes incoming I2CP messages from the client.
Constructor Summary
Constructors
Constructor
Description
QueuedClientConnectionRunner(RouterContext context, ClientManager manager, I2CPMessageQueue queue)
Create a new runner with the given queues.
Method Summary
Modifier and Type
Method
Description
(package private) void
doSend(I2CPMessage msg)
Actually send the I2CPMessage to the client.
(package private) void
doSendWait(I2CPMessage msg, long timeoutMs)
Send the I2CPMessage, giving the client's queue up to timeoutMs to make room.
String
getClientVersion()
The client version.
private I2CPMessageException
queueFull()
The error for a client that is not draining its I2CP queue.
void
setClientVersion(String version)
Does nothing.
void
startRunning()
Starts the reader thread.
void
stopRunning()
Calls super() to stop the reader, and sends a poison message to the client.
(package private) void
writeMessage(I2CPMessage msg)
In super(), doSend queues it to the writer thread and the writer thread calls writeMessage() to write to the output stream.
Methods inherited from class ClientConnectionRunner
ackSendMessage, createListener, disconnectClient, disconnectClient, disconnected, distributeMessage, failLeaseRequest, getAddress, getConfig, getConfig, getDestHash, getDestHash, getDestination, getDestinations, getFloodfillNetworkDatabaseFacade, getIsDead, getLeaseRequest, getLeaseSet, getNextMessageId, getPayload, getPrimaryConfig, getSessionId, getSessionIds, getSessionKeyManager, isDead, leaseSetCreated, receiveMessage, receiveMessage, registerEncryptedLS, removePayload, removeSession, reportAbuse, requestLeaseSet, rerequestAfterTransientPublishFailure, sessionEstablished, setPayload, setSessionId, updateMessageDeliveryStatus
Modifier and Type
Method
Description
(package private) void
ackSendMessage(SessionId sid, MessageId id, long nonce)
Send a notification to the client that their message (id specified) was accepted for delivery (but not necessarily delivered) Doesn't do anything if i2cp.messageReliability = "none" or if the nonce is 0.
protected I2CPMessageReader.I2CPMessageEventListener
createListener()
Allow override for testing.
(package private) void
disconnectClient(String reason)
Send a DisconnectMessage and log with level Log.ERROR.
(package private) void
disconnectClient(String reason, int logLevel)
Disconnect the client with the given reason and log level.
(package private) void
disconnected()
The client was disconnected.
(package private) MessageId
distributeMessage(SendMessageMessage message)
Distribute the message.
void
failLeaseRequest(LeaseRequestState req)
Fail the given lease request and track consecutive failures.
InetAddress
getAddress()
The address of the client socket.
SessionConfig
getConfig(Hash h)
Current client's config, will be null if session not found IS subsession aware.
SessionConfig
getConfig(SessionId id)
Current client's config, will be null if session not found IS subsession aware.
Hash
getDestHash()
Equivalent to ClientConnectionRunner.getConfig(Hash).getDestination().calculateHash(); will be null before session is established Not subsession aware.
Hash
getDestHash(SessionId id)
Return the hash for the given ID.
Destination
getDestination(SessionId id)
Return the dest for the given ID.
(package private) List<Destination>
getDestinations()
Subsession aware.
FloodfillNetworkDatabaseFacade
getFloodfillNetworkDatabaseFacade()
The FloodfillNetworkDatabaseFacade for this runner, the client netDb.
(package private) boolean
getIsDead()
Check if the runner is dead.
(package private) LeaseRequestState
getLeaseRequest(Hash h)
Data for the current leaseRequest, or null if there is no active leaseSet request.
LeaseSet
getLeaseSet(Hash h)
Currently allocated leaseSet.
int
getNextMessageId()
Get the next message id.
(package private) Payload
getPayload(MessageId id)
Only call if _dontSendMSMOnReceive is false, otherwise will always be null.
SessionConfig
getPrimaryConfig()
Primary client's config, will be null if session not set up.
(package private) SessionId
getSessionId(Hash h)
Subsession aware.
(package private) List<SessionId>
getSessionIds()
Subsession aware.
SessionKeyManager
getSessionKeyManager()
The current client's SessionKeyManager.
(package private) boolean
isDead()
Already closed?
(package private) void
leaseSetCreated(LeaseSet ls)
Called after a new leaseSet is granted by the client and the NetworkDb has been updated.
(package private) boolean
receiveMessage(Destination toDest, Destination fromDest, Payload payload)
Synchronously deliver the message to the current runner
(package private) boolean
receiveMessage(Hash toHash, Destination fromDest, Payload payload)
Synchronously deliver the message to the current runner
boolean
registerEncryptedLS(Hash hash)
Call after destinationEstablished(), when an encrypted leaseset is created, so we know it's local.
(package private) void
removePayload(MessageId id)
Only call if _dontSendMSMOnReceive is false.
(package private) void
removeSession(SessionId id)
Kill the session.
void
reportAbuse(Destination dest, String reason, int severity)
Send async abuse message to the client.
(package private) void
requestLeaseSet(Hash h, LeaseSet set, long expirationTime, Job onCreateJob, Job onFailedJob)
Request that a particular client authorize the Leases contained in the LeaseSet, after which the onCreateJob is queued up.
(package private) boolean
rerequestAfterTransientPublishFailure(Destination dest)
Re-queue the pending lease request after netdb publish() rejected the client's LeaseSet as expired (client clock skew or slow signing).
int
sessionEstablished(SessionConfig config)
Caller must send a SessionStatusMessage to the client with the returned code.
(package private) void
setPayload(MessageId id, Payload payload)
Only call if _dontSendMSMOnReceive is false.
(package private) void
setSessionId(Hash hash, SessionId id)
To be called only by ClientManager.
(package private) void
updateMessageDeliveryStatus(Destination dest, MessageId id, long messageNonce, int status)
Send a notification to the client that their message (id specified) was delivered (or failed delivery) Note that this sends the Guaranteed status codes, even though we only support best effort.
Methods inherited from class Object
clone, equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Details
- queue
  private final I2CPMessageQueue queue
  The queue shared with the client.
Constructor Details
- QueuedClientConnectionRunner
  public QueuedClientConnectionRunner(RouterContext context, ClientManager manager, I2CPMessageQueue queue)
  Create a new runner with the given queues.
  Parameters:
  context - the router context
  manager - the client manager
  queue - the I2CP message queue
Method Details
- startRunning
  public void startRunning()
  Starts the reader thread. Does not call super().
  Overrides:
  startRunning in class ClientConnectionRunner
- stopRunning
  public void stopRunning()
  Calls super() to stop the reader, and sends a poison message to the client.
  Overrides:
  stopRunning in class ClientConnectionRunner
- writeMessage
  void writeMessage(I2CPMessage msg)
  In super(), doSend queues it to the writer thread and the writer thread calls writeMessage() to write to the output stream. Since we have no writer thread this shouldn't happen.
  Overrides:
  writeMessage in class ClientConnectionRunner
  Parameters:
  msg - the message to write
- doSend
  void doSend(I2CPMessage msg) throws I2CPMessageException
  Actually send the I2CPMessage to the client. Non-blocking.
  Overrides:
  doSend in class ClientConnectionRunner
  Parameters:
  msg - the message to send
  Throws:
  I2CPMessageException - if queue full or on other errors
- doSendWait
  void doSendWait(I2CPMessage msg, long timeoutMs) throws I2CPMessageException
  Send the I2CPMessage, giving the client's queue up to timeoutMs to make room.
  The in-JVM dispatcher drains this queue every few milliseconds, so a full queue means the client is briefly behind rather than gone. Refusing the message outright costs far more than the wait does: a dropped LeaseSet request spends a whole request timing out and then rebuilds the tunnel, for a message that would have been handed over milliseconds later.
  Overrides:
  doSendWait in class ClientConnectionRunner
  Parameters:
  msg - the message to send
  timeoutMs - how long to wait for space in the client's queue
  Throws:
  I2CPMessageException - if the queue is still full after the wait, or on other errors
- queueFull
  private I2CPMessageException queueFull()
  The error for a client that is not draining its I2CP queue.
  Names the client's side of the queue rather than saying only that a write failed, because that is the fact the operator needs: the router's own writer is healthy and the client is the side that has stopped reading.
  Returns:
  a fresh exception carrying the pending and free-slot counts of the queue
- setClientVersion
  public void setClientVersion(String version)
  Does nothing. Client version is the core version.
  Overrides:
  setClientVersion in class ClientConnectionRunner
  Parameters:
  version - the client version string
- getClientVersion
  public String getClientVersion()
  The client version.
  Overrides:
  getClientVersion in class ClientConnectionRunner
  Returns:
  always the published core version; the client version is fixed and cannot be set

Field Summary

Fields inherited from class ClientConnectionRunner

Constructor Summary

Method Summary

Methods inherited from class ClientConnectionRunner

Methods inherited from class Object

Field Details

queue

Constructor Details

QueuedClientConnectionRunner

Method Details

startRunning

stopRunning

writeMessage

doSend

doSendWait

queueFull

setClientVersion

getClientVersion