MasterSession (Javadocs [I2P+ 2.13.0+]

java.lang.Object
- net.i2p.sam.SAMStreamSession
- - net.i2p.sam.SAMv3StreamSession
  - - net.i2p.sam.MasterSession

All Implemented Interfaces:
Closeable, AutoCloseable, I2PSessionListener, I2PSessionMuxedListener, SAMDatagramReceiver, SAMMessageSess, SAMRawReceiver, Session
```
class MasterSession
extends SAMv3StreamSession
implements SAMDatagramReceiver, SAMRawReceiver, SAMMessageSess, I2PSessionMuxedListener
```
A session that does nothing, but implements interfaces for raw, datagram, and streaming for convenience. We extend SAMv3StreamSession as we must have it set up the I2PSession, in case user adds a STREAM session (and he probably will). This session receives all data from I2P, but you can't send any data on it.

Nested Class Summary
- Nested classes/interfaces inherited from class net.i2p.sam.SAMStreamSession
  SAMStreamSession.DisconnectListener, SAMStreamSession.SAMStreamSessionServer, SAMStreamSession.SAMStreamSessionSocketReader, SAMStreamSession.SAMv1StreamSessionSocketReader, SAMStreamSession.StreamSender

Field Summary
- Fields inherited from class net.i2p.sam.SAMStreamSession
  _isOwnSession, _log, canCreate, DEFAULT_FORCE_FLUSH, forceFlush, PROP_FORCE_FLUSH, recv, server, SOCKET_HANDLER_BUF_SIZE, socketMgr

Constructor Summary

Constructors
Constructor and Description
`MasterSession(String nick, SAMv3DatagramServer dgServer, SAMv3Handler handler, Properties props)` Build a Session according to information registered with the given nickname.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`accept(SAMv3Handler handler, boolean verbose)` Accept a single incoming I2P stream and pipe data through the handler's socket.
`String`	`add(String nick, String style, Properties props)` Add a session
`void`	`close()` Close the primary/master session and all subsessions.
`void`	`connectAsync(SAMv3Handler handler, String dest, Properties props)` Initiate an async STREAM CONNECT.
`void`	`disconnected(I2PSession session)` Called when the I2P session is disconnected.
`void`	`errorOccurred(I2PSession session, String message, Throwable error)` Called when an I2P error occurs.
`int`	`getListenPort()` Get the port for this session's listener.
`int`	`getListenProtocol()` Get the I2CP protocol for this session's listener.
`void`	`messageAvailable(I2PSession session, int msgId, long size)` Called when a message is available (unmuxed).
`void`	`messageAvailable(I2PSession session, int msgId, long size, int proto, int fromPort, int toPort)` Called when a muxed message is available.
`void`	`receiveDatagramBytes(Destination sender, byte[] data, int proto, int fromPort, int toPort)` Send a byte array to a SAM client.
`void`	`receiveRawBytes(byte[] data, int proto, int fromPort, int toPort)` Send a byte array to a SAM client, without informations regarding the sender.
`String`	`remove(String nick, Properties props)` Remove a session
`void`	`reportAbuse(I2PSession session, int severity)` Called when abuse is reported on the session.
`void`	`start()` Overridden to start the acceptor.
`void`	`startForwardingIncoming(Properties props, boolean sendPorts)` Forward sockets from I2P to the host/port provided.
`void`	`stopDatagramReceiving()` Does nothing.
`void`	`stopForwardingIncoming()` does nothing
`void`	`stopRawReceiving()` Does nothing.

Methods inherited from class net.i2p.sam.SAMv3StreamSession
getDB, getNick, getSocketServer, queueSocket

Methods inherited from class net.i2p.sam.SAMStreamSession
checkSocketHandlerId, closeConnection, connect, createSocketHandler, getDestination, getSocketReader, isDestroyed, lookupDest, newSAMStreamSessionSocketReader, newStreamSender, removeSocketHandler, sendBytes, sendBytes, sendBytes, setReceiveLimit

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

Methods inherited from interface net.i2p.sam.SAMMessageSess
getDestination, lookupDest, sendBytes, sendBytes

- Constructor Detail
  - MasterSession
```
public MasterSession(String nick,
                     SAMv3DatagramServer dgServer,
                     SAMv3Handler handler,
                     Properties props)
              throws IOException,
                     DataFormatException,
                     SAMException
```
    Build a Session according to information registered with the given nickname. Caller MUST call start().
    Parameters:
    nick - nickname of the session
    Throws:
    IOException
    DataFormatException
    SAMException
- Method Detail
  - accept
```
public void accept(SAMv3Handler handler,
                   boolean verbose)
            throws SAMException
```
    Description copied from class: SAMv3StreamSession
    Accept a single incoming I2P stream and pipe data through the handler's socket. Validation is synchronous; the blocking accept runs in a dedicated thread so pool workers are never blocked waiting for an incoming I2P connection. Multiple simultaneous accepts are allowed (v3.2+). Accepts and forwarding may not be done at the same time.
    Overrides:
    accept in class SAMv3StreamSession
    Parameters:
    handler - handler whose socket becomes the I2P data pipe
    verbose - if true, send peer Destination as first line
    Throws:
    SAMException - always
  - add
```
public String add(String nick,
                  String style,
                  Properties props)
```
    Add a session
    Returns:
    null for success, or error message
  - close
```
public void close()
```
    Close the primary/master session and all subsessions. Overridden to stop the acceptor and the subsessions.
    Specified by:
    close in interface Closeable
    Specified by:
    close in interface AutoCloseable
    Specified by:
    close in interface SAMMessageSess
    Overrides:
    close in class SAMv3StreamSession
  - connectAsync
```
public void connectAsync(SAMv3Handler handler,
                         String dest,
                         Properties props)
                  throws DataFormatException
```
    Description copied from class: SAMv3StreamSession
    Initiate an async STREAM CONNECT. Validates parameters synchronously, unregisters from the pool, then hands the blocking connect to a shared connector thread pool. Returns immediately — the caller's worker is never blocked by an I2P connection attempt. The ConnectTask handles all error reporting and pipe setup so the calling worker is free to process other commands immediately.
    Overrides:
    connectAsync in class SAMv3StreamSession
    Parameters:
    handler - handler whose socket becomes the I2P data pipe
    dest - Base64-encoded Destination
    props - connection options
    Throws:
    DataFormatException - always
  - disconnected
```
public void disconnected(I2PSession session)
```
    Called when the I2P session is disconnected.
    Specified by:
    disconnected in interface I2PSessionListener
    Specified by:
    disconnected in interface I2PSessionMuxedListener
    Parameters:
    session - the disconnected session
  - errorOccurred
```
public void errorOccurred(I2PSession session,
                          String message,
                          Throwable error)
```
    Called when an I2P error occurs.
    Specified by:
    errorOccurred in interface I2PSessionListener
    Specified by:
    errorOccurred in interface I2PSessionMuxedListener
    Parameters:
    session - the session
    message - error description
    error - the exception, if any
  - getListenPort
```
public int getListenPort()
```
    Description copied from class: SAMStreamSession
    Get the port for this session's listener.
    Specified by:
    getListenPort in interface SAMMessageSess
    Overrides:
    getListenPort in class SAMStreamSession
    Returns:
    the listen port
  - getListenProtocol
```
public int getListenProtocol()
```
    Description copied from class: SAMStreamSession
    Get the I2CP protocol for this session's listener.
    Specified by:
    getListenProtocol in interface SAMMessageSess
    Overrides:
    getListenProtocol in class SAMStreamSession
    Returns:
    the I2CP protocol
  - messageAvailable
```
public void messageAvailable(I2PSession session,
                             int msgId,
                             long size)
```
    Called when a message is available (unmuxed).
    Specified by:
    messageAvailable in interface I2PSessionListener
    Specified by:
    messageAvailable in interface I2PSessionMuxedListener
    Parameters:
    session - the session
    msgId - the message ID
    size - the message size
  - messageAvailable
```
public void messageAvailable(I2PSession session,
                             int msgId,
                             long size,
                             int proto,
                             int fromPort,
                             int toPort)
```
    Called when a muxed message is available.
    Specified by:
    messageAvailable in interface I2PSessionMuxedListener
    Parameters:
    session - the session
    msgId - the message ID
    size - the message size
    proto - the protocol number
    fromPort - the source port
    toPort - the destination port
  - receiveDatagramBytes
```
public void receiveDatagramBytes(Destination sender,
                                 byte[] data,
                                 int proto,
                                 int fromPort,
                                 int toPort)
                          throws IOException
```
    Description copied from interface: SAMDatagramReceiver
    Send a byte array to a SAM client.
    Specified by:
    receiveDatagramBytes in interface SAMDatagramReceiver
    Parameters:
    sender - Destination
    data - Byte array to be received
    proto - I2CP protocol
    fromPort - I2CP from port
    toPort - I2CP to port
    Throws:
    IOException - always
  - receiveRawBytes
```
public void receiveRawBytes(byte[] data,
                            int proto,
                            int fromPort,
                            int toPort)
                     throws IOException
```
    Description copied from interface: SAMRawReceiver
    Send a byte array to a SAM client, without informations regarding the sender.
    Specified by:
    receiveRawBytes in interface SAMRawReceiver
    Parameters:
    data - Byte array to be received
    proto - I2CP protocol
    fromPort - I2CP from port
    toPort - I2CP to port
    Throws:
    IOException - always
  - remove
```
public String remove(String nick,
                     Properties props)
```
    Remove a session
    Parameters:
    props - session configuration properties, may be null
    Returns:
    null for success, or error message
  - reportAbuse
```
public void reportAbuse(I2PSession session,
                        int severity)
```
    Called when abuse is reported on the session.
    Specified by:
    reportAbuse in interface I2PSessionListener
    Specified by:
    reportAbuse in interface I2PSessionMuxedListener
    Parameters:
    session - the session
    severity - the abuse severity level
  - start
```
public void start()
```
    Overridden to start the acceptor.
    Specified by:
    start in interface SAMMessageSess
    Overrides:
    start in class SAMStreamSession
  - startForwardingIncoming
```
public void startForwardingIncoming(Properties props,
                                    boolean sendPorts)
                             throws SAMException
```
    Description copied from class: SAMv3StreamSession
    Forward sockets from I2P to the host/port provided. Accepts and forwarding may not be done at the same time.
    Overrides:
    startForwardingIncoming in class SAMv3StreamSession
    Throws:
    SAMException - always
  - stopDatagramReceiving
```
public void stopDatagramReceiving()
```
    Does nothing.
    Specified by:
    stopDatagramReceiving in interface SAMDatagramReceiver
  - stopForwardingIncoming
```
public void stopForwardingIncoming()
```
    does nothing
    Overrides:
    stopForwardingIncoming in class SAMv3StreamSession
  - stopRawReceiving
```
public void stopRawReceiving()
```
    Does nothing.
    Specified by:
    stopRawReceiving in interface SAMRawReceiver

Class MasterSession

Nested Class Summary

Nested classes/interfaces inherited from class net.i2p.sam.SAMStreamSession

Field Summary

Fields inherited from class net.i2p.sam.SAMStreamSession

Constructor Summary

Method Summary

Methods inherited from class net.i2p.sam.SAMv3StreamSession

Methods inherited from class net.i2p.sam.SAMStreamSession

Methods inherited from class java.lang.Object

Methods inherited from interface net.i2p.sam.SAMMessageSess

Constructor Detail

MasterSession

Method Detail

accept

add

close

connectAsync

disconnected

errorOccurred

getListenPort

getListenProtocol

messageAvailable

messageAvailable

receiveDatagramBytes

receiveRawBytes

remove

reportAbuse

start

startForwardingIncoming

stopDatagramReceiving

stopForwardingIncoming

stopRawReceiving