Package net.i2p.i2ptunnel.socks

Class SocketWrapper

java.lang.Object

net.i2p.i2ptunnel.socks.SocketWrapper

All Implemented Interfaces:

Closeable, AutoCloseable, I2PSocket

class SocketWrapper
extends Object
implements I2PSocket

Wrapper around the Socket obtained from the Outproxy, which is a wrapper around the Orchid Stream.

Since:

0.9.27

Nested Class Summary

Nested classes/interfaces inherited from interface net.i2p.client.streaming.I2PSocket

I2PSocket.SocketErrorListener

Constructor Summary

Constructors

Constructor	Description
SocketWrapper(Socket sock)

Method Summary

Modifier and Type	Method	Description
void	close()
SelectableChannel	getChannel()	Deprecated.
InputStream	getInputStream()	As of 0.9.9 will throw an IOE if socket is closed.
int	getLocalPort()	The local port.
I2PSocketOptions	getOptions()
OutputStream	getOutputStream()	As of 0.9.9 will throw an IOE if socket is closed.
Destination	getPeerDestination()
int	getPort()	The remote port.
long	getReadTimeout()	How long we will wait blocked on a read() operation.
Destination	getThisDestination()
boolean	isClosed()
void	reset()	Just calls close()
void	setOptions(I2PSocketOptions options)	Does nothing
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 class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

SocketWrapper

public SocketWrapper(Socket sock)

Method Detail

getThisDestination

public Destination getThisDestination()

Specified by:

getThisDestination in interface I2PSocket

Returns:

the Destination of this side of the socket.

getPeerDestination

public Destination getPeerDestination()

Specified by:

getPeerDestination in interface I2PSocket

Returns:

the destination of the peer.

getInputStream

public InputStream getInputStream()
                           throws IOException

Description copied from interface: I2PSocket

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.

Specified by:

getInputStream in interface I2PSocket

Returns:

an InputStream to read from the socket. Non-null since 0.9.9.

Throws:

IOException - on failure

getOutputStream

public OutputStream getOutputStream()
                             throws IOException

Description copied from interface: I2PSocket

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.

Specified by:

getOutputStream in interface I2PSocket

Returns:

an OutputStream to write into the socket. Non-null since 0.9.9.

Throws:

IOException - on failure

getChannel

@Deprecated
public SelectableChannel getChannel()

Deprecated.

Description copied from interface: I2PSocket

Unimplemented, unlikely to ever be implemented.

Specified by:

getChannel in interface I2PSocket

Returns:

null always

getOptions

public I2PSocketOptions getOptions()

Specified by:

getOptions in interface I2PSocket

Returns:

null always

setOptions

public void setOptions(I2PSocketOptions options)

Does nothing

Specified by:

setOptions in interface I2PSocket

Parameters:

options - I2PSocketOptions to set

getReadTimeout

public long getReadTimeout()

Description copied from interface: I2PSocket

How long we will wait blocked on a read() operation. This is simply a helper to query the I2PSocketOptions

Specified by:

getReadTimeout in interface I2PSocket

Returns:

milliseconds to wait, or -1 if we will wait indefinitely

setReadTimeout

public void setReadTimeout(long ms)

Description copied from interface: I2PSocket

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

Specified by:

setReadTimeout in interface I2PSocket

Parameters:

ms - timeout in ms

close

public void close()
           throws IOException

Specified by:

close in interface AutoCloseable

Specified by:

close in interface Closeable

Throws:

IOException

reset

public void reset()
           throws IOException

Just calls close()

Specified by:

reset in interface I2PSocket

Throws:

IOException

Since:

0.9.30

isClosed

public boolean isClosed()

Specified by:

isClosed in interface I2PSocket

setSocketErrorListener

public void setSocketErrorListener(I2PSocket.SocketErrorListener lsnr)

Deprecated, unimplemented, does nothing

Specified by:

setSocketErrorListener in interface I2PSocket

getPort

public int getPort()

The remote port.

Specified by:

getPort in interface I2PSocket

Returns:

Default I2PSession.PORT_UNSPECIFIED (0) or PORT_ANY (0)

getLocalPort

public int getLocalPort()

The local port.

Specified by:

getLocalPort in interface I2PSocket

Returns:

0 always