Package net.i2p.client.streaming.impl

Class I2PSocketManagerFull

  • All Implemented Interfaces:
    I2PSocketManager
    public class I2PSocketManagerFull
extends 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.

    • Constructor Detail

      • I2PSocketManagerFull

        public I2PSocketManagerFull​(I2PAppContext context,
                            I2PSession session,
                            Properties opts,
                            String name,
                            IncomingConnectionFilter connectionFilter)
        This is what I2PSocketManagerFactory.createManager() returns. Direct instantiation by others is deprecated.
        Parameters:
        context - non-null
        session - non-null
        opts - may be null
        name - non-null

    • Method Detail

      • buildOptions

        public I2PSocketOptions buildOptions​(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.
        Specified by:
        buildOptions in interface I2PSocketManager
        Parameters:
        opts - The new options, may be null

      • addSubsession

        public I2PSession addSubsession​(InputStream privateKeyStream,
                                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.
        Specified by:
        addSubsession in interface I2PSocketManager
        Parameters:
        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
        Returns:
        a new subsession, non-null
        Throws:
        I2PSessionException
        Since:
        0.9.21

      • 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.
        Specified by:
        ping in interface I2PSocketManager
        Parameters:
        peer -
        timeoutMs - timeout in ms, greater than zero
        Returns:
        true on success, false on failure
        Throws:
        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.
        Specified by:
        ping in interface I2PSocketManager
        Parameters:
        peer - Destination to ping
        localPort - 0 - 65535
        remotePort - 0 - 65535
        timeoutMs - timeout in ms, greater than zero
        Returns:
        success or failure
        Throws:
        IllegalArgumentException
        Since:
        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.
        Specified by:
        ping in interface I2PSocketManager
        Parameters:
        peer - Destination to ping
        localPort - 0 - 65535
        remotePort - 0 - 65535
        timeoutMs - timeout in ms, greater than zero
        payload - to include in the ping
        Returns:
        the payload received in the pong, zero-length if none, null on failure or timeout
        Throws:
        IllegalArgumentException
        Since:
        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?
        Specified by:
        setAcceptTimeout in interface I2PSocketManager
        Parameters:
        ms - milliseconds to wait, maximum

      • 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.
        Specified by:
        setDefaultOptions in interface I2PSocketManager
        Parameters:
        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.
        Specified by:
        getDefaultOptions in interface 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.
        Specified by:
        getServerSocket in interface I2PSocketManager
        Returns:
        non-null

      • getStandardServerSocket

        public ServerSocket getStandardServerSocket()
                                     throws 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.
        Specified by:
        getStandardServerSocket in interface I2PSocketManager
        Throws:
        IOException
        Since:
        0.8.4

      • connect

        public I2PSocket connect​(Destination peer,
                         I2PSocketOptions options)
                  throws I2PException,
                         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.
        Specified by:
        connect in interface I2PSocketManager
        Parameters:
        peer - Destination to connect to
        options - I2P socket options to be used for connecting, may be null
        Returns:
        I2PSocket if successful
        Throws:
        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,
                         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.
        Specified by:
        connect in interface I2PSocketManager
        Parameters:
        peer - Destination to connect to
        Returns:
        I2PSocket if successful
        Throws:
        NoRouteToHostException - if the peer is not found or not reachable
        I2PException - if there is some other I2P-related problem

      • connectToSocket

        public Socket connectToSocket​(Destination peer,
                              int timeout)
                       throws IOException
        Like connect() but returns a real Socket, and throws only IOE, for easier porting of apps.
        Specified by:
        connectToSocket in interface I2PSocketManager
        Parameters:
        timeout - ms if > 0, forces blocking (disables connectDelay)
        Throws:
        IOException
        Since:
        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.
        Specified by:
        destroySocketManager in interface I2PSocketManager

      • isDestroyed

        public boolean isDestroyed()
        Has the socket manager been destroyed?
        Specified by:
        isDestroyed in interface I2PSocketManager
        Since:
        0.9.9

      • listSockets

        public Set<I2PSocket> listSockets()
        Retrieve a set of currently connected I2PSockets, either initiated locally or remotely.
        Specified by:
        listSockets in interface I2PSocketManager
        Returns:
        set of currently connected I2PSockets