I2PSocket (Javadocs [I2P+ 2.13.0+] - API Version 0.9.70+)

All Superinterfaces:
AutoCloseable, Closeable
All Known Implementing Classes:
I2PSocketFull, SocketWrapper
```
public interface I2PSocket
extends Closeable
```
Streaming socket returned by I2PSocketManager.connect(Destination).
Note that this is not a standard Java Socket, if you need one of those, use I2PSocketManager.connectToSocket(Destination) instead.

Nested Class Summary
Nested Classes
Modifier and Type Interface and Description
static interface I2PSocket.SocketErrorListener
Deprecated, unimplemented, does nothing.

Nested Classes
Modifier and Type	Interface and Description
`static interface`	`I2PSocket.SocketErrorListener` Deprecated, unimplemented, does nothing.

Method Summary

All Methods Instance Methods Abstract Methods Default Methods
Modifier and Type	Method and Description
`InputStream`	`getInputStream()` As of 0.9.9 will throw an IOE if socket is closed.
`default long`	`getLifetimeBytesReceived()` How many bytes have been received over the lifetime of this socket.
`default long`	`getLifetimeBytesSent()` How many bytes have been sent over the lifetime of this socket.
`int`	`getLocalPort()` The local port.
`I2PSocketOptions`	`getOptions()` Returns the socket's configuration.
`OutputStream`	`getOutputStream()` As of 0.9.9 will throw an IOE if socket is closed.
`Destination`	`getPeerDestination()` Returns the destination of the peer.
`int`	`getPort()` The remote port.
`long`	`getReadTimeout()` How long we will wait blocked on a read() operation.
`Destination`	`getThisDestination()` Returns the Destination of this side of the socket.
`boolean`	`isClosed()` Returns whether this socket has been closed.
`void`	`reset()` Resets and closes this socket.
`void`	`setOptions(I2PSocketOptions options)` Configure the socket
`void`	`setReadTimeout(long ms)` Define how long we will wait blocked on a read() operation (-1 will make the socket wait forever).
`void`	`setSocketErrorListener(I2PSocket.SocketErrorListener lsnr)` Deprecated, unimplemented, does nothing.

Methods inherited from interface java.io.Closeable
close

- Method Detail
  - getInputStream
```
InputStream getInputStream()
                    throws IOException
```
    As of 0.9.9 will throw an IOE if socket is closed. Prior to that would return null instead of throwing IOE.
    Note that operations on the returned stream may return an IOException whose cause as returned by Throwable.getCause() is an I2PSocketException. If so, the client may retrieve a status code via I2PSocketException.getStatus() to provide specific feedback to the user.
    Returns:
    an InputStream to read from the socket. Non-null since 0.9.9.
    Throws:
    IOException - on failure
  - getLifetimeBytesReceived
```
default long getLifetimeBytesReceived()
```
    How many bytes have been received over the lifetime of this socket.
    Returns:
    bytes received, or 0 if unknown
  - getLifetimeBytesSent
```
default long getLifetimeBytesSent()
```
    How many bytes have been sent over the lifetime of this socket.
    Returns:
    bytes sent, or 0 if unknown
  - getLocalPort
```
int getLocalPort()
```
    The local port.
    Returns:
    Default I2PSession.PORT_UNSPECIFIED (0) or PORT_ANY (0)
  - getOptions
```
I2PSocketOptions getOptions()
```
    Returns the socket's configuration.
    Returns:
    socket's configuration
  - getOutputStream
```
OutputStream getOutputStream()
                      throws IOException
```
    As of 0.9.9 will throw an IOE if socket is closed. Prior to that would return null instead of throwing IOE.
    Note that operations on the returned stream may return an IOException whose cause as returned by Throwable.getCause() is an I2PSocketException. If so, the client may retrieve a status code via I2PSocketException.getStatus() to provide specific feedback to the user.
    Returns:
    an OutputStream to write into the socket. Non-null since 0.9.9.
    Throws:
    IOException - on failure
  - getPeerDestination
```
Destination getPeerDestination()
```
    Returns the destination of the peer.
    Returns:
    the destination of the peer
  - getPort
```
int getPort()
```
    The remote port.
    Returns:
    Default I2PSession.PORT_UNSPECIFIED (0) or PORT_ANY (0)
  - getReadTimeout
```
long getReadTimeout()
```
    How long we will wait blocked on a read() operation. This is simply a helper to query the I2PSocketOptions
    Returns:
    milliseconds to wait, or -1 if we will wait indefinitely
  - getThisDestination
```
Destination getThisDestination()
```
    Returns the Destination of this side of the socket.
    Returns:
    the Destination of this side of the socket
  - isClosed
```
boolean isClosed()
```
    Returns whether this socket has been closed.
    Returns:
    true if this socket has been closed
  - reset
```
void reset()
    throws IOException
```
    Resets and closes this socket. Sends a RESET indication to the far-end.
    Throws:
    IOException - on reset failure
  - setOptions
```
void setOptions(I2PSocketOptions options)
```
    Configure the socket
    Parameters:
    options - I2PSocketOptions to set
  - setReadTimeout
```
void setReadTimeout(long ms)
```
    Define how long we will wait blocked on a read() operation (-1 will make the socket wait forever). This is simply a helper to adjust the I2PSocketOptions
    Parameters:
    ms - timeout in ms
  - setSocketErrorListener
```
void setSocketErrorListener(I2PSocket.SocketErrorListener lsnr)
```
    Deprecated, unimplemented, does nothing.
    Parameters:
    lsnr - the listener (ignored)

Interface I2PSocket

Nested Class Summary

Method Summary

Methods inherited from interface java.io.Closeable

Method Detail

getInputStream

getLifetimeBytesReceived

getLifetimeBytesSent

getLocalPort

getOptions

getOutputStream

getPeerDestination

getPort

getReadTimeout

getThisDestination

isClosed

reset

setOptions

setReadTimeout

setSocketErrorListener