Interfaces and factories for the base I2P SDK used to develop applications that communicate through I2P.
When a client application wants to communicate over I2P, the first thing it needs to do is get a I2PClient from the I2PClientFactory. If it does not already have a Destination, it must generate one with the I2PClient.createDestination(OutputStream) before proceeding. Once it has one, it then creates an I2PSession which serves as the bridge to the I2P network, allowing it to send messages (via I2PSession.sendMessage(Destination, byte[])) and receive messages (via I2PSession.receiveMessage(int)). In addition, the client receives asynchronous notification of network activity by providing an implementation of I2PSessionListener.
This client package provides the basic necessity for communicating over I2P, but there are three other subpackages that are helpful. Specifically:
net.i2p.client.datagram- for applications that want their messages to be both authenticated and repliablenet.i2p.client.naming- for applications that want to resolve readable names intoDestinationsnet.i2p.client.streaming- for applications that want to use a streaming API to provide reliable in order message delivery (note: the streaming library is packaged seperate from the main SDK - in the mstreaming.jar and streaming.jar)
The I2PSession implementation itself communicates with the I2P router over I2CP, the Invisible Internet Client Protocol.
- ClassDescriptionDefine the standard means of interacting with the I2P systemProvide a means of hooking into an appropriate I2PClient implementation.Define the standard means of sending and receiving messages on the I2P network by using the I2CP (the client protocol).Simple holder for tunnel pair information.Thrown when there is a problem doing something on the session.Define a means for the router to asynchronously notify the client that a new message is available or the router is under attack.Define a means for the router to asynchronously notify the client that a new message is available or the router is under attack.Simple client implementation with no Destination, just used to talk to the router.Deferred callback for
IPSession.lookupNonblocking().The return value ofI2PSession.lookupDest2(String, long).Advanced options attached to a single outgoing I2CP message.Overridesi2cp.gzipsession option and size threshold for this message only.Reliability bits 9-10.Asynchronously notify the client of the status of a sent message.Event fired when a tunnel is removed from a client tunnel pool.Why a tunnel was removed from a client's pool.Listener for tunnel status changes.