StandardSocket (Javadocs [I2P+ 2.13.0+]

java.lang.Object
- java.net.Socket
- - net.i2p.client.streaming.impl.StandardSocket

All Implemented Interfaces:
Closeable, AutoCloseable
```
class StandardSocket
extends Socket
```
Bridge to I2PSocket. This extends Socket to make porting apps easier. Methods throw IOExceptions like Sockets do, rather than returning null for some methods. StandardSockets are always bound, and always start out connected (unless connectDelay is > 0). You may not create an unbound StandardSocket. Create this through the SocketManager. Todo: Make public and add getPeerDestination() ?

Constructor Summary
Constructors
Constructor and Description
StandardSocket(I2PSocket socket)
Wraps an I2PSocket in a java.net.Socket.

Constructors
Constructor and Description
`StandardSocket(I2PSocket socket)` Wraps an I2PSocket in a java.net.Socket.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`bind(SocketAddress bindpoint)` Binding is not supported.
`void`	`close()` Closes the socket and the underlying I2PSocket.
`void`	`connect(SocketAddress endpoint)` Connecting is not supported.
`void`	`connect(SocketAddress endpoint, int timeout)` Connecting is not supported.
`SocketChannel`	`getChannel()` Channel is not supported.
`InetAddress`	`getInetAddress()` No remote address.
`InputStream`	`getInputStream()` Input stream from the underlying I2PSocket.
`boolean`	`getKeepAlive()` Keep-alive setting.
`InetAddress`	`getLocalAddress()` No local address.
`int`	`getLocalPort()` Local port.
`SocketAddress`	`getLocalSocketAddress()` Local socket address.
`boolean`	`getOOBInline()` OOB inline is not supported.
`OutputStream`	`getOutputStream()` Output stream from the underlying I2PSocket.
`int`	`getPort()` Remote port.
`int`	`getReceiveBufferSize()` Inbound buffer size.
`SocketAddress`	`getRemoteSocketAddress()` Remote socket address.
`boolean`	`getReuseAddress()` Reuse address is not supported.
`int`	`getSendBufferSize()` Outbound buffer size.
`int`	`getSoLinger()` SO_LINGER is not implemented.
`int`	`getSoTimeout()` Socket timeout.
`boolean`	`getTcpNoDelay()` TCP_NODELAY is not supported.
`int`	`getTrafficClass()` Traffic class is not supported.
`boolean`	`isBound()` Always bound.
`boolean`	`isClosed()` Whether closed.
`boolean`	`isConnected()` Whether connected.
`boolean`	`isInputShutdown()` Whether input shutdown.
`boolean`	`isOutputShutdown()` Whether output shutdown.
`void`	`sendUrgentData(int data)` Urgent data is not supported.
`void`	`setKeepAlive(boolean on)` Keep-alive setting.
`void`	`setOOBInline(boolean on)` OOB inline setting.
`void`	`setPerformancePreferences(int connectionTime, int latency, int bandwidth)` Does nothing.
`void`	`setReceiveBufferSize(int size)` Does nothing.
`void`	`setReuseAddress(boolean on)` Does nothing.
`void`	`setSendBufferSize(int size)` Does nothing.
`void`	`setSoLinger(boolean on, int linger)` Does nothing.
`void`	`setSoTimeout(int timeout)` Socket timeout.
`void`	`setTcpNoDelay(boolean on)` Does nothing.
`void`	`setTrafficClass(int tc)` Does nothing.
`void`	`shutdownInput()` Shuts down the input side, closing the underlying I2PSocket.
`void`	`shutdownOutput()` Shuts down the output side, closing the underlying I2PSocket.
`String`	`toString()` String representation of the underlying I2PSocket.

Methods inherited from class java.net.Socket
setSocketImplFactory

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - StandardSocket
```
StandardSocket(I2PSocket socket)
```
    Wraps an I2PSocket in a java.net.Socket.
- Method Detail
  - bind
```
public void bind(SocketAddress bindpoint)
```
    Binding is not supported.
    Overrides:
    bind in class Socket
    Throws:
    UnsupportedOperationException - always
  - close
```
public void close()
           throws IOException
```
    Closes the socket and the underlying I2PSocket.
    Specified by:
    close in interface Closeable
    Specified by:
    close in interface AutoCloseable
    Overrides:
    close in class Socket
    Throws:
    IOException
  - connect
```
public void connect(SocketAddress endpoint)
```
    Connecting is not supported.
    Overrides:
    connect in class Socket
    Throws:
    UnsupportedOperationException - always
  - connect
```
public void connect(SocketAddress endpoint,
                    int timeout)
```
    Connecting is not supported.
    Overrides:
    connect in class Socket
    Throws:
    UnsupportedOperationException - always
  - getChannel
```
public SocketChannel getChannel()
```
    Channel is not supported.
    Overrides:
    getChannel in class Socket
    Returns:
    null always, unimplemented
  - getInetAddress
```
public InetAddress getInetAddress()
```
    No remote address.
    Overrides:
    getInetAddress in class Socket
    Returns:
    null always
  - getInputStream
```
public InputStream getInputStream()
                           throws IOException
```
    Input stream from the underlying I2PSocket.
    Overrides:
    getInputStream in class Socket
    Returns:
    the input stream
    Throws:
    IOException - if the socket has no input stream
  - getKeepAlive
```
public boolean getKeepAlive()
```
    Keep-alive setting.
    Overrides:
    getKeepAlive in class Socket
    Returns:
    true if keep-alive is enabled (inactivity action is SEND)
  - getLocalAddress
```
public InetAddress getLocalAddress()
```
    No local address.
    Overrides:
    getLocalAddress in class Socket
    Returns:
    null always
  - getLocalPort
```
public int getLocalPort()
```
    Local port.
    Overrides:
    getLocalPort in class Socket
    Returns:
    the port or 0 if unknown
  - getLocalSocketAddress
```
public SocketAddress getLocalSocketAddress()
```
    Local socket address.
    Overrides:
    getLocalSocketAddress in class Socket
    Returns:
    an I2PSocketAddress as of 0.9.26; prior to that, returned null
  - getOOBInline
```
public boolean getOOBInline()
```
    OOB inline is not supported.
    Overrides:
    getOOBInline in class Socket
    Returns:
    false always
  - getOutputStream
```
public OutputStream getOutputStream()
                             throws IOException
```
    Output stream from the underlying I2PSocket.
    Overrides:
    getOutputStream in class Socket
    Returns:
    the output stream
    Throws:
    IOException - if the socket has no output stream
  - getPort
```
public int getPort()
```
    Remote port.
    Overrides:
    getPort in class Socket
    Returns:
    the port or 0 if unknown
  - getReceiveBufferSize
```
public int getReceiveBufferSize()
```
    Inbound buffer size.
    Overrides:
    getReceiveBufferSize in class Socket
    Returns:
    the inbound buffer size, or 64KB if options are unavailable
  - getRemoteSocketAddress
```
public SocketAddress getRemoteSocketAddress()
```
    Remote socket address.
    Overrides:
    getRemoteSocketAddress in class Socket
    Returns:
    an I2PSocketAddress as of 0.9.26; prior to that, threw UnsupportedOperationException
  - getReuseAddress
```
public boolean getReuseAddress()
```
    Reuse address is not supported.
    Overrides:
    getReuseAddress in class Socket
    Returns:
    false always
  - getSendBufferSize
```
public int getSendBufferSize()
```
    Outbound buffer size.
    Overrides:
    getSendBufferSize in class Socket
    Returns:
    the inbound buffer size, or 64KB if options are unavailable
  - getSoLinger
```
public int getSoLinger()
```
    SO_LINGER is not implemented.
    Overrides:
    getSoLinger in class Socket
    Returns:
    -1 always (not implemented)
  - getSoTimeout
```
public int getSoTimeout()
```
    Socket timeout.
    Overrides:
    getSoTimeout in class Socket
    Returns:
    the socket timeout in milliseconds
  - getTcpNoDelay
```
public boolean getTcpNoDelay()
```
    TCP_NODELAY is not supported.
    Overrides:
    getTcpNoDelay in class Socket
    Returns:
    false always
  - getTrafficClass
```
public int getTrafficClass()
```
    Traffic class is not supported.
    Overrides:
    getTrafficClass in class Socket
    Returns:
    0 always
  - isBound
```
public boolean isBound()
```
    Always bound.
    Overrides:
    isBound in class Socket
    Returns:
    true always
  - isClosed
```
public boolean isClosed()
```
    Whether closed.
    Overrides:
    isClosed in class Socket
    Returns:
    whether closed
  - isConnected
```
public boolean isConnected()
```
    Whether connected.
    Overrides:
    isConnected in class Socket
    Returns:
    whether connected
  - isInputShutdown
```
public boolean isInputShutdown()
```
    Whether input shutdown.
    Overrides:
    isInputShutdown in class Socket
    Returns:
    whether input shutdown
  - isOutputShutdown
```
public boolean isOutputShutdown()
```
    Whether output shutdown.
    Overrides:
    isOutputShutdown in class Socket
    Returns:
    whether output shutdown
  - sendUrgentData
```
public void sendUrgentData(int data)
```
    Urgent data is not supported.
    Overrides:
    sendUrgentData in class Socket
    Throws:
    UnsupportedOperationException - always
  - setKeepAlive
```
public void setKeepAlive(boolean on)
```
    Keep-alive setting.
    Overrides:
    setKeepAlive in class Socket
    Parameters:
    on - true to enable keep-alive (inactivity action SEND), false for NOOP
  - setOOBInline
```
public void setOOBInline(boolean on)
```
    OOB inline setting.
    Overrides:
    setOOBInline in class Socket
    Parameters:
    on - true to throw UnsupportedOperationException, false does nothing
    Throws:
    UnsupportedOperationException - if on is true
  - setPerformancePreferences
```
public void setPerformancePreferences(int connectionTime,
                                      int latency,
                                      int bandwidth)
```
    Does nothing.
    Overrides:
    setPerformancePreferences in class Socket
  - setReceiveBufferSize
```
public void setReceiveBufferSize(int size)
```
    Does nothing.
    Overrides:
    setReceiveBufferSize in class Socket
  - setReuseAddress
```
public void setReuseAddress(boolean on)
```
    Does nothing.
    Overrides:
    setReuseAddress in class Socket
  - setSendBufferSize
```
public void setSendBufferSize(int size)
```
    Does nothing.
    Overrides:
    setSendBufferSize in class Socket
  - setSoLinger
```
public void setSoLinger(boolean on,
                        int linger)
```
    Does nothing.
    Overrides:
    setSoLinger in class Socket
  - setSoTimeout
```
public void setSoTimeout(int timeout)
                  throws SocketException
```
    Socket timeout.
    Overrides:
    setSoTimeout in class Socket
    Parameters:
    timeout - the timeout in milliseconds
    Throws:
    SocketException - if the options are unavailable
  - setTcpNoDelay
```
public void setTcpNoDelay(boolean on)
```
    Does nothing.
    Overrides:
    setTcpNoDelay in class Socket
  - setTrafficClass
```
public void setTrafficClass(int tc)
```
    Does nothing.
    Overrides:
    setTrafficClass in class Socket
  - shutdownInput
```
public void shutdownInput()
                   throws IOException
```
    Shuts down the input side, closing the underlying I2PSocket.
    Overrides:
    shutdownInput in class Socket
    Throws:
    IOException
  - shutdownOutput
```
public void shutdownOutput()
                    throws IOException
```
    Shuts down the output side, closing the underlying I2PSocket.
    Overrides:
    shutdownOutput in class Socket
    Throws:
    IOException
  - toString
```
public String toString()
```
    String representation of the underlying I2PSocket.
    Overrides:
    toString in class Socket

Class StandardSocket

Constructor Summary

Method Summary

Methods inherited from class java.net.Socket

Methods inherited from class java.lang.Object

Constructor Detail

StandardSocket

Method Detail

bind

close

connect

connect

getChannel

getInetAddress

getInputStream

getKeepAlive

getLocalAddress

getLocalPort

getLocalSocketAddress

getOOBInline

getOutputStream

getPort

getReceiveBufferSize

getRemoteSocketAddress

getReuseAddress

getSendBufferSize

getSoLinger

getSoTimeout

getTcpNoDelay

getTrafficClass

isBound

isClosed

isConnected

isInputShutdown

isOutputShutdown

sendUrgentData

setKeepAlive

setOOBInline

setPerformancePreferences

setReceiveBufferSize

setReuseAddress

setSendBufferSize

setSoLinger

setSoTimeout

setTcpNoDelay

setTrafficClass

shutdownInput

shutdownOutput

toString