diff --git a/apps/ministreaming/java/src/net/i2p/client/streaming/package.html b/apps/ministreaming/java/src/net/i2p/client/streaming/package.html index 3e2ce48750c77a8a39a6266615d9002e04d85a4c..b1168f632e6ee2564dd85fa7f491715046e955b7 100644 --- a/apps/ministreaming/java/src/net/i2p/client/streaming/package.html +++ b/apps/ministreaming/java/src/net/i2p/client/streaming/package.html @@ -1,9 +1,9 @@ <html><body> -<p>Implements a TCP-like (reliable, authenticated, in order) set of sockets for +<p>API, interfaces, and factory for a TCP-like (reliable, authenticated, in order) set of sockets for communicating over the IP-like (unreliable, unauthenticated, unordered) I2P messages. Note that this class is split across two jars, streaming.jar and ministreaming.jar. -The interfaces and some very old code are in ministreaming.jar, but the +The interfaces are in ministreaming.jar, but the real work gets done in streaming.jar. Clients must have both jars in their classpath. Most clients will require (only) streaming.jar, ministreaming.jar, and i2p.jar @@ -23,7 +23,10 @@ net.i2p.client.streaming.I2PServerSocket#accept} method, which will provide an application wants to create a new stream to a peer, it should do so with the appropriate {@link net.i2p.client.streaming.I2PSocketManager#connect} call.</p> -<p>There is a simple pair of demo applications available as well - +<p>This package also contains the I2PSocketEepGet utility, which is an HTTP client +that uses an existing I2PSocketManager.</p> + +<p>There is a simple pair of demo applications available in the test directory - net.i2p.client.streaming.StreamSinkServer listens to a destination and dumps the data from all sockets it accepts to individual files, while net.i2p.client.streaming.StreamSinkClient connects to a particular destination diff --git a/apps/streaming/java/src/net/i2p/client/streaming/impl/package.html b/apps/streaming/java/src/net/i2p/client/streaming/impl/package.html index dbf1d2d02fbd6ba90e50b245149b14d161e8156c..d629a68f98cd7363bf56b6fda1a5990065322bbf 100644 --- a/apps/streaming/java/src/net/i2p/client/streaming/impl/package.html +++ b/apps/streaming/java/src/net/i2p/client/streaming/impl/package.html @@ -1,10 +1,12 @@ <html><body> -<p>Implements a TCP-like (reliable, authenticated, in order) set of sockets for +<p>Implementation of a TCP-like (reliable, authenticated, in order) set of sockets for communicating over the IP-like (unreliable, unauthenticated, unordered) I2P messages. This is the streaming implementation (moved for ticket #1135 to here). For the API (which you probably want), see ministreaming. +Clients should not need to access anything in this package directly. +Use the interfaces and factory in net.i2p.streaming. Note that this class is split across two jars, streaming.jar and ministreaming.jar. The interfaces and some code are in ministreaming.jar, but the diff --git a/build.xml b/build.xml index 81cfe97c81a20ba7c2ecd9ba668c70cd3cf40952..432434a664e7da2030049a9bb817952acb358f48 100644 --- a/build.xml +++ b/build.xml @@ -468,7 +468,7 @@ doctitle="I2P Javadocs for Release ${release.number} Build ${i2p.build.number}${build.extra}" windowtitle="I2P Anonymous Network - Java Documentation - Version ${release.number}"> <group title="Core SDK (i2p.jar)" packages="net.i2p:net.i2p.*:net.i2p.client:net.i2p.client.*:net.i2p.internal:net.i2p.internal.*:freenet.support.CPUInformation:org.bouncycastle.oldcrypto:org.bouncycastle.oldcrypto.*:gnu.crypto.*:gnu.gettext:com.nettgryppa.security:net.metanotion:net.metanotion.*" /> - <group title="Streaming Library" packages="net.i2p.client.streaming" /> + <group title="Streaming Library" packages="net.i2p.client.streaming:net.i2p.client.streaming.impl" /> <group title="Router" packages="net.i2p.router:net.i2p.router.*:net.i2p.data.i2np:org.cybergarage.*:org.freenetproject:org.xlattice.crypto.filters" /> <group title="Router Console" packages="net.i2p.router.web:net.i2p.router.update" /> <!-- apps and bridges starting here, alphabetical please -->