InternalSocket (I2P Anonymous Network - Java Documentation

java.lang.Object
- java.net.Socket
- - net.i2p.util.InternalSocket

All Implemented Interfaces:

Closeable, AutoCloseable
```
public class InternalSocket
extends Socket
```
A simple in-JVM Socket using Piped Streams. We use port numbers just like regular sockets. Can only connect to InternalServerSocket.

Since:

0.7.9

Constructor Summary

Constructors
Constructor Description

InternalSocket(int port)
client side

InternalSocket(InputStream is, OutputStream os)
server side

Constructors
Constructor	Description
`InternalSocket(int port)`	client side
`InternalSocket(InputStream is, OutputStream os)`	server side

Method Summary

All Methods Static Methods Instance Methods Concrete Methods Deprecated Methods
Modifier and Type	Method	Description
`void`	`bind(SocketAddress endpoint)`	Deprecated. unsupported
`void`	`close()`
`void`	`connect(SocketAddress endpoint)`	Deprecated. unsupported
`void`	`connect(SocketAddress endpoint, int timeout)`	Deprecated. unsupported
`SocketChannel`	`getChannel()`	Deprecated. unsupported
`InetAddress`	`getInetAddress()`	Deprecated. unsupported
`InputStream`	`getInputStream()`
`boolean`	`getKeepAlive()`	Deprecated. unsupported
`InetAddress`	`getLocalAddress()`	Deprecated. unsupported
`int`	`getLocalPort()`	Supported as of 0.9.33, prior to that threw UnsupportedOperationException
`SocketAddress`	`getLocalSocketAddress()`	Deprecated. unsupported
`boolean`	`getOOBInline()`	Deprecated. unsupported
`OutputStream`	`getOutputStream()`
`int`	`getPort()`	Supported as of 0.9.33, prior to that threw UnsupportedOperationException
`int`	`getReceiveBufferSize()`	Deprecated. unsupported
`SocketAddress`	`getRemoteSocketAddress()`	Deprecated. unsupported
`boolean`	`getReuseAddress()`	Deprecated. unsupported
`int`	`getSendBufferSize()`	Deprecated. unsupported
`static Socket`	`getSocket(String host, int port)`	Convenience method to return either a Socket or an InternalSocket
`int`	`getSoLinger()`	Supported as of 0.9.33, prior to that threw UnsupportedOperationException
`int`	`getSoTimeout()`	Always returns 0, even if setSoTimeout() was called.
`boolean`	`getTcpNoDelay()`	Deprecated. unsupported
`int`	`getTrafficClass()`	Deprecated. unsupported
`boolean`	`isBound()`	Deprecated. unsupported
`boolean`	`isClosed()`
`boolean`	`isConnected()`	Supported as of 0.9.33, prior to that threw UnsupportedOperationException
`boolean`	`isInputShutdown()`	Supported as of 0.9.33, prior to that threw UnsupportedOperationException
`boolean`	`isOutputShutdown()`	Supported as of 0.9.33, prior to that threw UnsupportedOperationException
`void`	`sendUrgentData(int data)`	Deprecated. unsupported
`(package private) void`	`setInputStream(InputStream is)`
`void`	`setKeepAlive(boolean on)`	Deprecated. unsupported
`void`	`setOOBInline(boolean on)`	Deprecated. unsupported
`(package private) void`	`setOutputStream(OutputStream os)`
`void`	`setReceiveBufferSize(int size)`	Deprecated. unsupported
`void`	`setReuseAddress(boolean on)`	Deprecated. unsupported
`void`	`setSendBufferSize(int size)`	Deprecated. unsupported
`void`	`setSoLinger(boolean on, int linger)`	Does nothing as of 0.9.33, prior to that threw UnsupportedOperationException
`void`	`setSoTimeout(int timeout)`	Supported as of 0.9.34, if constructed with TimeoutPipedInputStream and TimeoutPipedOutputStream.
`void`	`setTcpNoDelay(boolean on)`	Deprecated. unsupported
`void`	`setTrafficClass(int cize)`	Deprecated. unsupported
`void`	`shutdownInput()`	Supported as of 0.9.33, prior to that threw UnsupportedOperationException
`void`	`shutdownOutput()`	Flushes (as the Socket javadocs advise) and closes.
`String`	`toString()`

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

Methods inherited from class java.net.Socket
getOption, setOption, setPerformancePreferences, setSocketImplFactory, supportedOptions

- Constructor Detail
  - InternalSocket
```
InternalSocket(InputStream is,
               OutputStream os)
```
    server side
  - InternalSocket
```
public InternalSocket(int port)
               throws IOException
```
    client side
    
    Parameters:
    
    port - > 0
    
    Throws:
    
    IOException
- Method Detail
  - getSocket
```
public static Socket getSocket(String host,
                               int port)
                        throws IOException
```
    Convenience method to return either a Socket or an InternalSocket
    
    Parameters:
    
    port - > 0
    
    Throws:
    
    IOException
  - getInputStream
```
public InputStream getInputStream()
```
    Overrides:
    
    getInputStream in class Socket
  - getOutputStream
```
public OutputStream getOutputStream()
```
    Overrides:
    
    getOutputStream in class Socket
  - setInputStream
```
void setInputStream(InputStream is)
```
  - setOutputStream
```
void setOutputStream(OutputStream os)
```
  - close
```
public void close()
```
    Specified by:
    
    close in interface AutoCloseable
    
    Specified by:
    
    close in interface Closeable
    
    Overrides:
    
    close in class Socket
  - isClosed
```
public boolean isClosed()
```
    Overrides:
    
    isClosed in class Socket
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Socket
  - setSoTimeout
```
public void setSoTimeout(int timeout)
```
    Supported as of 0.9.34, if constructed with TimeoutPipedInputStream and TimeoutPipedOutputStream. Otherwise, does nothing.
    
    Overrides:
    
    setSoTimeout in class Socket
    
    See Also:
    
    TimeoutPipedInputStream
  - getSoTimeout
```
public int getSoTimeout()
```
    Always returns 0, even if setSoTimeout() was called.
    
    Overrides:
    
    getSoTimeout in class Socket
  - bind
```
@Deprecated
public void bind(SocketAddress endpoint)
```
    Deprecated.
    unsupported
    
    Overrides:
    
    bind in class Socket
  - connect
```
@Deprecated
public void connect(SocketAddress endpoint)
```
    Deprecated.
    unsupported
    
    Overrides:
    
    connect in class Socket
  - connect
```
@Deprecated
public void connect(SocketAddress endpoint,
                    int timeout)
```
    Deprecated.
    unsupported
    
    Overrides:
    
    connect in class Socket
  - getChannel
```
@Deprecated
public SocketChannel getChannel()
```
    Deprecated.
    unsupported
    
    Overrides:
    
    getChannel in class Socket
  - getInetAddress
```
@Deprecated
public InetAddress getInetAddress()
```
    Deprecated.
    unsupported
    
    Overrides:
    
    getInetAddress in class Socket
  - getKeepAlive
```
@Deprecated
public boolean getKeepAlive()
```
    Deprecated.
    unsupported
    
    Overrides:
    
    getKeepAlive in class Socket
  - getLocalAddress
```
@Deprecated
public InetAddress getLocalAddress()
```
    Deprecated.
    unsupported
    
    Overrides:
    
    getLocalAddress in class Socket
  - getLocalPort
```
public int getLocalPort()
```
    Supported as of 0.9.33, prior to that threw UnsupportedOperationException
    
    Overrides:
    
    getLocalPort in class Socket
    
    Returns:
    
    1 if connected, -1 if not
  - getLocalSocketAddress
```
@Deprecated
public SocketAddress getLocalSocketAddress()
```
    Deprecated.
    unsupported
    
    Overrides:
    
    getLocalSocketAddress in class Socket
  - getOOBInline
```
@Deprecated
public boolean getOOBInline()
```
    Deprecated.
    unsupported
    
    Overrides:
    
    getOOBInline in class Socket
  - getPort
```
public int getPort()
```
    Supported as of 0.9.33, prior to that threw UnsupportedOperationException
    
    Overrides:
    
    getPort in class Socket
    
    Returns:
    
    if connected: actual port for clients, 1 for servers; -1 if not
  - getReceiveBufferSize
```
@Deprecated
public int getReceiveBufferSize()
```
    Deprecated.
    unsupported
    
    Overrides:
    
    getReceiveBufferSize in class Socket
  - getRemoteSocketAddress
```
@Deprecated
public SocketAddress getRemoteSocketAddress()
```
    Deprecated.
    unsupported
    
    Overrides:
    
    getRemoteSocketAddress in class Socket
  - getReuseAddress
```
@Deprecated
public boolean getReuseAddress()
```
    Deprecated.
    unsupported
    
    Overrides:
    
    getReuseAddress in class Socket
  - getSendBufferSize
```
@Deprecated
public int getSendBufferSize()
```
    Deprecated.
    unsupported
    
    Overrides:
    
    getSendBufferSize in class Socket
  - getSoLinger
```
public int getSoLinger()
```
    Supported as of 0.9.33, prior to that threw UnsupportedOperationException
    
    Overrides:
    
    getSoLinger in class Socket
    
    Returns:
    
    -1 always
  - getTcpNoDelay
```
@Deprecated
public boolean getTcpNoDelay()
```
    Deprecated.
    unsupported
    
    Overrides:
    
    getTcpNoDelay in class Socket
  - getTrafficClass
```
@Deprecated
public int getTrafficClass()
```
    Deprecated.
    unsupported
    
    Overrides:
    
    getTrafficClass in class Socket
  - isBound
```
@Deprecated
public boolean isBound()
```
    Deprecated.
    unsupported
    
    Overrides:
    
    isBound in class Socket
  - isConnected
```
public boolean isConnected()
```
    Supported as of 0.9.33, prior to that threw UnsupportedOperationException
    
    Overrides:
    
    isConnected in class Socket
  - isInputShutdown
```
public boolean isInputShutdown()
```
    Supported as of 0.9.33, prior to that threw UnsupportedOperationException
    
    Overrides:
    
    isInputShutdown in class Socket
  - isOutputShutdown
```
public boolean isOutputShutdown()
```
    Supported as of 0.9.33, prior to that threw UnsupportedOperationException
    
    Overrides:
    
    isOutputShutdown in class Socket
  - sendUrgentData
```
@Deprecated
public void sendUrgentData(int data)
```
    Deprecated.
    unsupported
    
    Overrides:
    
    sendUrgentData in class Socket
  - setKeepAlive
```
@Deprecated
public void setKeepAlive(boolean on)
```
    Deprecated.
    unsupported
    
    Overrides:
    
    setKeepAlive in class Socket
  - setOOBInline
```
@Deprecated
public void setOOBInline(boolean on)
```
    Deprecated.
    unsupported
    
    Overrides:
    
    setOOBInline in class Socket
  - setReceiveBufferSize
```
@Deprecated
public void setReceiveBufferSize(int size)
```
    Deprecated.
    unsupported
    
    Overrides:
    
    setReceiveBufferSize in class Socket
  - setReuseAddress
```
@Deprecated
public void setReuseAddress(boolean on)
```
    Deprecated.
    unsupported
    
    Overrides:
    
    setReuseAddress in class Socket
  - setSendBufferSize
```
@Deprecated
public void setSendBufferSize(int size)
```
    Deprecated.
    unsupported
    
    Overrides:
    
    setSendBufferSize in class Socket
  - setSoLinger
```
public void setSoLinger(boolean on,
                        int linger)
```
    Does nothing as of 0.9.33, prior to that threw UnsupportedOperationException
    
    Overrides:
    
    setSoLinger in class Socket
  - setTcpNoDelay
```
@Deprecated
public void setTcpNoDelay(boolean on)
```
    Deprecated.
    unsupported
    
    Overrides:
    
    setTcpNoDelay in class Socket
  - setTrafficClass
```
@Deprecated
public void setTrafficClass(int cize)
```
    Deprecated.
    unsupported
    
    Overrides:
    
    setTrafficClass in class Socket
  - shutdownInput
```
public void shutdownInput()
                   throws IOException
```
    Supported as of 0.9.33, prior to that threw UnsupportedOperationException
    
    Overrides:
    
    shutdownInput in class Socket
    
    Throws:
    
    IOException
  - shutdownOutput
```
public void shutdownOutput()
                    throws IOException
```
    Flushes (as the Socket javadocs advise) and closes. Supported as of 0.9.33, prior to that threw UnsupportedOperationException
    
    Overrides:
    
    shutdownOutput in class Socket
    
    Throws:
    
    IOException

Class InternalSocket

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Methods inherited from class java.net.Socket

Constructor Detail

InternalSocket

InternalSocket

Method Detail

getSocket

getInputStream

getOutputStream

setInputStream

setOutputStream

close

isClosed

toString

setSoTimeout

getSoTimeout

bind

connect

connect

getChannel

getInetAddress

getKeepAlive

getLocalAddress

getLocalPort

getLocalSocketAddress

getOOBInline

getPort

getReceiveBufferSize

getRemoteSocketAddress

getReuseAddress

getSendBufferSize

getSoLinger

getTcpNoDelay

getTrafficClass

isBound

isConnected

isInputShutdown

isOutputShutdown

sendUrgentData

setKeepAlive

setOOBInline

setReceiveBufferSize

setReuseAddress

setSendBufferSize

setSoLinger

setTcpNoDelay

setTrafficClass

shutdownInput

shutdownOutput