I2PSocketManagerFull (I2P Anonymous Network - Java Documentation

java.lang.Object
- net.i2p.client.streaming.impl.I2PSocketManagerFull

すべての実装されたインタフェース:

I2PSocketManager
```
public class I2PSocketManagerFull
extends java.lang.Object
implements I2PSocketManager
```
Centralize the coordination and multiplexing of the local client's streaming. There should be one I2PSocketManager for each I2PSession, and if an application is sending and receiving data through the streaming library using an I2PSocketManager, it should not attempt to call I2PSession's setSessionListener or receive any messages with its .receiveMessage This is what I2PSocketManagerFactory.createManager() returns. Direct instantiation by others is deprecated.

ネストされたクラスの概要
- インタフェースから継承されたネストされたクラス/インタフェース net.i2p.client.streaming.I2PSocketManager
  I2PSocketManager.DisconnectListener

フィールドの概要

フィールド
修飾子とタイプフィールド説明

(package private) static PcapWriter pcapWriter

(package private) static java.lang.String PROP_PCAP

フィールド
修飾子とタイプ	フィールド	説明
`(package private) static PcapWriter`	`pcapWriter`
`(package private) static java.lang.String`	`PROP_PCAP`

コンストラクタの概要

コンストラクタ
コンストラクタ	説明
`I2PSocketManagerFull()`	推奨されていません。 use 4-arg constructor
`I2PSocketManagerFull(I2PAppContext context, I2PSession session, java.util.Properties opts, java.lang.String name)`	This is what I2PSocketManagerFactory.createManager() returns.

メソッドの概要

すべてのメソッドインスタンス・メソッド concreteメソッド推奨されていないメソッド
修飾子とタイプ	メソッド	説明
`void`	`addDisconnectListener(I2PSocketManager.DisconnectListener lsnr)`
`I2PSession`	`addSubsession(java.io.InputStream privateKeyStream, java.util.Properties opts)`	For a server, you must call connect() on the returned object.
`I2PSocketOptions`	`buildOptions()`	Create a copy of the current options, to be used in a setDefaultOptions() call.
`I2PSocketOptions`	`buildOptions(java.util.Properties opts)`	Create a modified copy of the current options, to be used in a setDefaultOptions() call.
`I2PSocket`	`connect(Destination peer)`	Create a new connected socket.
`I2PSocket`	`connect(Destination peer, I2PSocketOptions options)`	Create a new connected socket.
`java.net.Socket`	`connectToSocket(Destination peer)`	Like connect() but returns a real Socket, and throws only IOE, for easier porting of apps.
`java.net.Socket`	`connectToSocket(Destination peer, int timeout)`	Like connect() but returns a real Socket, and throws only IOE, for easier porting of apps.
`void`	`destroySocketManager()`	Destroy the socket manager, freeing all the associated resources.
`long`	`getAcceptTimeout()`
`ConnectionManager`	`getConnectionManager()`
`I2PSocketOptions`	`getDefaultOptions()`	Current options, not a copy, setters may be used to make changes.
`java.lang.String`	`getName()`	For logging / diagnostics only
`I2PServerSocket`	`getServerSocket()`	Returns non-null socket.
`I2PSession`	`getSession()`
`java.net.ServerSocket`	`getStandardServerSocket()`	Like getServerSocket but returns a real ServerSocket for easier porting of apps.
`java.util.List<I2PSession>`	`getSubsessions()`
`void`	`init(I2PAppContext context, I2PSession session, java.util.Properties opts, java.lang.String name)`	推奨されていません。 use 4-arg constructor
`boolean`	`isDestroyed()`	Has the socket manager been destroyed?
`java.util.Set<I2PSocket>`	`listSockets()`	Retrieve a set of currently connected I2PSockets, either initiated locally or remotely.
`boolean`	`ping(Destination peer, int localPort, int remotePort, long timeoutMs)`	Ping the specified peer, returning true if they replied to the ping within the timeout specified, false otherwise.
`byte[]`	`ping(Destination peer, int localPort, int remotePort, long timeoutMs, byte[] payload)`	Ping the specified peer, returning true if they replied to the ping within the timeout specified, false otherwise.
`boolean`	`ping(Destination peer, long timeoutMs)`	Ping the specified peer, returning true if they replied to the ping within the timeout specified, false otherwise.
`I2PSocket`	`receiveSocket()`	The accept() call.
`void`	`removeDisconnectListener(I2PSocketManager.DisconnectListener lsnr)`
`void`	`removeSubsession(I2PSession session)`	Remove the subsession
`void`	`setAcceptTimeout(long ms)`	How long should we wait for the client to .accept() a socket before sending back a NACK/Close?
`void`	`setDefaultOptions(I2PSocketOptions options)`	Update the options on a running socket manager.
`void`	`setName(java.lang.String name)`	For logging / diagnostics only

クラスから継承されたメソッド java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- フィールドの詳細
  - pcapWriter
```
static PcapWriter pcapWriter
```
  - PROP_PCAP
```
static final java.lang.String PROP_PCAP
```
    関連項目:
    
    定数フィールド値
- コンストラクタの詳細
  - I2PSocketManagerFull
```
@Deprecated
public I2PSocketManagerFull()
```
    推奨されていません。 use 4-arg constructor
    
    例外:
    
    java.lang.UnsupportedOperationException - always
  - I2PSocketManagerFull
```
public I2PSocketManagerFull(I2PAppContext context,
                            I2PSession session,
                            java.util.Properties opts,
                            java.lang.String name)
```
    This is what I2PSocketManagerFactory.createManager() returns. Direct instantiation by others is deprecated.
    
    パラメータ:
    
    context - non-null
    
    session - non-null
    
    opts - may be null
    
    name - non-null
- メソッドの詳細
  - init
```
@Deprecated
public void init(I2PAppContext context,
                 I2PSession session,
                 java.util.Properties opts,
                 java.lang.String name)
```
    推奨されていません。 use 4-arg constructor
    
    インタフェースからコピーされた説明: I2PSocketManager
    
    Deprecated - Factory will initialize.
    
    定義:
    
    init インタフェース内 I2PSocketManager
    
    例外:
    
    java.lang.UnsupportedOperationException - always
  - buildOptions
```
public I2PSocketOptions buildOptions()
```
    Create a copy of the current options, to be used in a setDefaultOptions() call.
    
    定義:
    
    buildOptions インタフェース内 I2PSocketManager
  - buildOptions
```
public I2PSocketOptions buildOptions(java.util.Properties opts)
```
    Create a modified copy of the current options, to be used in a setDefaultOptions() call. As of 0.9.19, defaults in opts are honored.
    
    定義:
    
    buildOptions インタフェース内 I2PSocketManager
    
    パラメータ:
    
    opts - The new options, may be null
  - getSession
```
public I2PSession getSession()
```
    定義:
    
    getSession インタフェース内 I2PSocketManager
    
    戻り値:
    
    the session, non-null
  - addSubsession
```
public I2PSession addSubsession(java.io.InputStream privateKeyStream,
                                java.util.Properties opts)
                         throws I2PSessionException
```
    For a server, you must call connect() on the returned object. Connecting the primary session does NOT connect any subsessions. If the primary session is not connected, connecting a subsession will connect the primary session first.
    
    定義:
    
    addSubsession インタフェース内 I2PSocketManager
    
    パラメータ:
    
    privateKeyStream - null for transient, if non-null must have same encryption keys as primary session and different signing keys
    
    opts - subsession options if any, may be null
    
    戻り値:
    
    a new subsession, non-null
    
    例外:
    
    I2PSessionException
    
    導入されたバージョン:
    
    0.9.21
  - removeSubsession
```
public void removeSubsession(I2PSession session)
```
    Remove the subsession
    
    定義:
    
    removeSubsession インタフェース内 I2PSocketManager
    
    導入されたバージョン:
    
    0.9.21
  - getSubsessions
```
public java.util.List<I2PSession> getSubsessions()
```
    定義:
    
    getSubsessions インタフェース内 I2PSocketManager
    
    戻り値:
    
    a list of subsessions, non-null, does not include the primary session
    
    導入されたバージョン:
    
    0.9.21
  - getConnectionManager
```
public ConnectionManager getConnectionManager()
```
  - receiveSocket
```
public I2PSocket receiveSocket()
                        throws I2PException,
                               java.net.ConnectException,
                               java.net.SocketTimeoutException
```
    The accept() call. This only listens on the primary session. There is no way to get incoming connections on a subsession.
    
    戻り値:
    
    connected I2PSocket, or null through 0.9.16, non-null as of 0.9.17
    
    例外:
    
    I2PException - if session is closed
    
    RouterRestartException - (extends I2PException) if the router is apparently restarting, since 0.9.34
    
    java.net.ConnectException - (since 0.9.17; I2PServerSocket interface always declared it)
    
    java.net.SocketTimeoutException - if a timeout was previously set with setSoTimeout and the timeout has been reached.
  - ping
```
public boolean ping(Destination peer,
                    long timeoutMs)
```
    Ping the specified peer, returning true if they replied to the ping within the timeout specified, false otherwise. This call blocks. Uses the ports from the default options. TODO There is no way to ping on a subsession.
    
    定義:
    
    ping インタフェース内 I2PSocketManager
    
    パラメータ:
    
    peer -
    
    timeoutMs - timeout in ms, greater than zero
    
    戻り値:
    
    true on success, false on failure
    
    例外:
    
    java.lang.IllegalArgumentException
  - ping
```
public boolean ping(Destination peer,
                    int localPort,
                    int remotePort,
                    long timeoutMs)
```
    Ping the specified peer, returning true if they replied to the ping within the timeout specified, false otherwise. This call blocks. Uses the ports specified. TODO There is no way to ping on a subsession.
    
    定義:
    
    ping インタフェース内 I2PSocketManager
    
    パラメータ:
    
    peer - Destination to ping
    
    localPort - 0 - 65535
    
    remotePort - 0 - 65535
    
    timeoutMs - timeout in ms, greater than zero
    
    戻り値:
    
    success or failure
    
    例外:
    
    java.lang.IllegalArgumentException
    
    導入されたバージョン:
    
    0.9.12
  - ping
```
public byte[] ping(Destination peer,
                   int localPort,
                   int remotePort,
                   long timeoutMs,
                   byte[] payload)
```
    Ping the specified peer, returning true if they replied to the ping within the timeout specified, false otherwise. This call blocks. Uses the ports specified. TODO There is no way to ping on a subsession.
    
    定義:
    
    ping インタフェース内 I2PSocketManager
    
    パラメータ:
    
    peer - Destination to ping
    
    localPort - 0 - 65535
    
    remotePort - 0 - 65535
    
    timeoutMs - timeout in ms, greater than zero
    
    payload - to include in the ping
    
    戻り値:
    
    the payload received in the pong, zero-length if none, null on failure or timeout
    
    例外:
    
    java.lang.IllegalArgumentException
    
    導入されたバージョン:
    
    0.9.18
  - setAcceptTimeout
```
public void setAcceptTimeout(long ms)
```
    How long should we wait for the client to .accept() a socket before sending back a NACK/Close?
    
    定義:
    
    setAcceptTimeout インタフェース内 I2PSocketManager
    
    パラメータ:
    
    ms - milliseconds to wait, maximum
  - getAcceptTimeout
```
public long getAcceptTimeout()
```
    定義:
    
    getAcceptTimeout インタフェース内 I2PSocketManager
  - setDefaultOptions
```
public void setDefaultOptions(I2PSocketOptions options)
```
    Update the options on a running socket manager. Parameters in the I2PSocketOptions interface may be changed directly with the setters; no need to use this method for those. This does NOT update the underlying I2CP or tunnel options; use getSession().updateOptions() for that. TODO There is no way to update the options on a subsession.
    
    定義:
    
    setDefaultOptions インタフェース内 I2PSocketManager
    
    パラメータ:
    
    options - as created from a call to buildOptions(properties), non-null
  - getDefaultOptions
```
public I2PSocketOptions getDefaultOptions()
```
    Current options, not a copy, setters may be used to make changes. TODO There is no facility to specify the session.
    
    定義:
    
    getDefaultOptions インタフェース内 I2PSocketManager
  - getServerSocket
```
public I2PServerSocket getServerSocket()
```
    Returns non-null socket. This method does not throw exceptions, but methods on the returned socket may throw exceptions if the socket or socket manager is closed. This only listens on the primary session. There is no way to get incoming connections on a subsession.
    
    定義:
    
    getServerSocket インタフェース内 I2PSocketManager
    
    戻り値:
    
    non-null
  - getStandardServerSocket
```
public java.net.ServerSocket getStandardServerSocket()
                                              throws java.io.IOException
```
    Like getServerSocket but returns a real ServerSocket for easier porting of apps. This only listens on the primary session. There is no way to get incoming connections on a subsession.
    
    定義:
    
    getStandardServerSocket インタフェース内 I2PSocketManager
    
    例外:
    
    java.io.IOException
    
    導入されたバージョン:
    
    0.8.4
  - connect
```
public I2PSocket connect(Destination peer,
                         I2PSocketOptions options)
                  throws I2PException,
                         java.net.NoRouteToHostException
```
    Create a new connected socket. Blocks until the socket is created, unless the connectDelay option (i2p.streaming.connectDelay) is set and greater than zero. If so this will return immediately, and the client may quickly write initial data to the socket and this data will be bundled in the SYN packet.
    
    定義:
    
    connect インタフェース内 I2PSocketManager
    
    パラメータ:
    
    peer - Destination to connect to
    
    options - I2P socket options to be used for connecting, may be null
    
    戻り値:
    
    I2PSocket if successful
    
    例外:
    
    java.net.NoRouteToHostException - if the peer is not found or not reachable
    
    I2PException - if there is some other I2P-related problem
  - connect
```
public I2PSocket connect(Destination peer)
                  throws I2PException,
                         java.net.NoRouteToHostException
```
    Create a new connected socket. Blocks until the socket is created, unless the connectDelay option (i2p.streaming.connectDelay) is set and greater than zero in the default options. If so this will return immediately, and the client may quickly write initial data to the socket and this data will be bundled in the SYN packet.
    
    定義:
    
    connect インタフェース内 I2PSocketManager
    
    パラメータ:
    
    peer - Destination to connect to
    
    戻り値:
    
    I2PSocket if successful
    
    例外:
    
    java.net.NoRouteToHostException - if the peer is not found or not reachable
    
    I2PException - if there is some other I2P-related problem
  - connectToSocket
```
public java.net.Socket connectToSocket(Destination peer)
                                throws java.io.IOException
```
    Like connect() but returns a real Socket, and throws only IOE, for easier porting of apps.
    
    定義:
    
    connectToSocket インタフェース内 I2PSocketManager
    
    例外:
    
    java.io.IOException
    
    導入されたバージョン:
    
    0.8.4
  - connectToSocket
```
public java.net.Socket connectToSocket(Destination peer,
                                       int timeout)
                                throws java.io.IOException
```
    Like connect() but returns a real Socket, and throws only IOE, for easier porting of apps.
    
    定義:
    
    connectToSocket インタフェース内 I2PSocketManager
    
    パラメータ:
    
    timeout - ms if > 0, forces blocking (disables connectDelay)
    
    例外:
    
    java.io.IOException
    
    導入されたバージョン:
    
    0.8.4
  - destroySocketManager
```
public void destroySocketManager()
```
    Destroy the socket manager, freeing all the associated resources. This method will block until all the managed sockets are closed. CANNOT be restarted.
    
    定義:
    
    destroySocketManager インタフェース内 I2PSocketManager
  - isDestroyed
```
public boolean isDestroyed()
```
    Has the socket manager been destroyed?
    
    定義:
    
    isDestroyed インタフェース内 I2PSocketManager
    
    導入されたバージョン:
    
    0.9.9
  - listSockets
```
public java.util.Set<I2PSocket> listSockets()
```
    Retrieve a set of currently connected I2PSockets, either initiated locally or remotely.
    
    定義:
    
    listSockets インタフェース内 I2PSocketManager
    
    戻り値:
    
    set of currently connected I2PSockets
  - getName
```
public java.lang.String getName()
```
    For logging / diagnostics only
    
    定義:
    
    getName インタフェース内 I2PSocketManager
  - setName
```
public void setName(java.lang.String name)
```
    For logging / diagnostics only
    
    定義:
    
    setName インタフェース内 I2PSocketManager
  - addDisconnectListener
```
public void addDisconnectListener(I2PSocketManager.DisconnectListener lsnr)
```
    定義:
    
    addDisconnectListener インタフェース内 I2PSocketManager
  - removeDisconnectListener
```
public void removeDisconnectListener(I2PSocketManager.DisconnectListener lsnr)
```
    定義:
    
    removeDisconnectListener インタフェース内 I2PSocketManager

クラス I2PSocketManagerFull

ネストされたクラスの概要

インタフェースから継承されたネストされたクラス/インタフェース net.i2p.client.streaming.I2PSocketManager

フィールドの概要

コンストラクタの概要

メソッドの概要

クラスから継承されたメソッド java.lang.Object

フィールドの詳細

pcapWriter

PROP_PCAP

コンストラクタの詳細

I2PSocketManagerFull

I2PSocketManagerFull

メソッドの詳細

init

buildOptions

buildOptions

getSession

addSubsession

removeSubsession

getSubsessions

getConnectionManager

receiveSocket

ping

ping

ping

setAcceptTimeout

getAcceptTimeout

setDefaultOptions

getDefaultOptions

getServerSocket

getStandardServerSocket

connect

connect

connectToSocket

connectToSocket

destroySocketManager

isDestroyed

listSockets

getName

setName

addDisconnectListener

removeDisconnectListener