sadie/i2p.i2p
1
0
Fork 0
forked from I2P_Developers/i2p.i2p
Code Issues Pull Requests Packages Projects Releases Wiki Activity

streaming javadoc fixes

Browse Source
This commit is contained in:
zzz
2014-02-01 12:37:45 +00:00
parent 99f28519fb
commit 3ab149a399
3 changed files with 10 additions and 5 deletions
Download Patch File Download Diff File Expand all files Collapse all files

9
apps/ministreaming/java/src/net/i2p/client/streaming/package.html
View File

@@ -1,9 +1,9 @@
<html><body> <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 communicating over the IP-like (unreliable, unauthenticated, unordered) I2P
messages. messages.
Note that this class is split across two jars, streaming.jar and ministreaming.jar. 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 real work gets done in streaming.jar. Clients must have both jars
in their classpath. in their classpath.
Most clients will require (only) streaming.jar, ministreaming.jar, and i2p.jar 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 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> 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 net.i2p.client.streaming.StreamSinkServer listens to a destination and dumps
the data from all sockets it accepts to individual files, while the data from all sockets it accepts to individual files, while
net.i2p.client.streaming.StreamSinkClient connects to a particular destination net.i2p.client.streaming.StreamSinkClient connects to a particular destination

4
apps/streaming/java/src/net/i2p/client/streaming/impl/package.html
View File

@@ -1,10 +1,12 @@
<html><body> <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 communicating over the IP-like (unreliable, unauthenticated, unordered) I2P
messages. messages.
This is the streaming implementation (moved for ticket #1135 to here). This is the streaming implementation (moved for ticket #1135 to here).
For the API (which you probably want), see ministreaming. 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. 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 The interfaces and some code are in ministreaming.jar, but the

2
build.xml
View File

@@ -468,7 +468,7 @@
doctitle="I2P Javadocs for Release ${release.number} Build ${i2p.build.number}${build.extra}" doctitle="I2P Javadocs for Release ${release.number} Build ${i2p.build.number}${build.extra}"
windowtitle="I2P Anonymous Network - Java Documentation - Version ${release.number}"> 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="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" 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" /> <group title="Router Console" packages="net.i2p.router.web:net.i2p.router.update" />
<!-- apps and bridges starting here, alphabetical please --> <!-- apps and bridges starting here, alphabetical please -->