SAMv3Handler (Javadocs [I2P+ 2.13.0+]

java.lang.Object
- net.i2p.sam.SAMHandler
- - net.i2p.sam.SAMv1Handler
  - - net.i2p.sam.SAMv3Handler

All Implemented Interfaces:
Runnable, Handler, SAMDatagramReceiver, SAMRawReceiver, SAMStreamReceiver
```
class SAMv3Handler
extends SAMv1Handler
```
Class able to handle a SAM version 3 client connection.

Field Summary

Fields
Modifier and Type	Field and Description
`(package private) boolean`	`sendPorts` package-visible for `SAMHandlerPool`
`static SessionsDB`	`sSessionsHash` sSessionsHash
`(package private) boolean`	`stolenSocket` Stolen socket.
`(package private) boolean`	`streamForwardingSocket` Stream forwarding socket.

Fields inherited from class net.i2p.sam.SAMv1Handler
_id, datagramSession, rawSession, SESSION_ERROR, streamSession

Fields inherited from class net.i2p.sam.SAMHandler
_log, bridge, i2cpProps, socket, stopHandler, stopLock, thread, verMajor, verMinor

Constructor Summary

Constructors
Constructor and Description
`SAMv3Handler(SocketChannel s, int verMajor, int verMinor, Properties i2cpProps, SAMBridge parent)` Create a new SAM version 3 handler.
`SAMv3Handler(SocketChannel s, int verMajor, int verMinor, SAMBridge parent)` Create a new SAM version 3 handler.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`protected boolean`	`execSessionMessage(String opcode, Properties props)` Parse and execute a SESSION message.
`protected boolean`	`execStreamConnect(Properties props)` Parse and execute a STREAM CONNECT message.
`protected boolean`	`execStreamMessage(String opcode, Properties props)` Parse and execute a STREAM message.
`(package private) SAMBridge`	`getBridge()` For SAMv3StreamSession
`String`	`getClientIP()` Get the IP address of the connected SAM client.
`(package private) Session`	`getSession()` For SAMv3DatagramServer
`void`	`handle()` Legacy handle() method.
`(package private) boolean`	`hasActiveStream()`
`void`	`notifyStreamIncomingConnection(Destination d, int fromPort, int toPort)` notifyStreamIncomingConnection.
`static void`	`notifyStreamIncomingConnection(SocketChannel client, Destination d)` Notify the SAM client of an incoming stream connection on a static channel.
`static void`	`notifyStreamIncomingConnection(SocketChannel client, Destination d, int fromPort, int toPort)` Notify the SAM client of an incoming stream connection with port information.
`void`	`notifyStreamResult(boolean verbose, String result, String message)`
`(package private) boolean`	`processLine(String line)` Process a single complete command line dispatched by the pool or the legacy handle() loop.
`(package private) void`	`setSession(SAMv3DatagramSession sess)` For subsessions created by MasterSession
`(package private) void`	`setSession(SAMv3RawSession sess)` For subsessions created by MasterSession
`(package private) void`	`setSession(SAMv3StreamSession sess)` For subsessions created by MasterSession
`void`	`stealSocket()` For SAMv3StreamSession connect and accept
`void`	`stopHandling()` Stop the SAM handler, close the socket (unless stolen), unregister from the bridge and the handler pool.
`boolean`	`verifVersion()` Verify the SAM protocol version is supported by this handler.

Methods inherited from class net.i2p.sam.SAMHandler
closeClientSocket, getClientSocket, getWriteLock, run, shouldStop, startHandling, toString, writeBytes, writeString, writeString

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

- Field Detail
  - sendPorts
```
final boolean sendPorts
```
    package-visible for SAMHandlerPool
  - sSessionsHash
```
public static final SessionsDB sSessionsHash
```
    sSessionsHash
  - stolenSocket
```
volatile boolean stolenSocket
```
    Stolen socket.
  - streamForwardingSocket
```
volatile boolean streamForwardingSocket
```
    Stream forwarding socket.
- Constructor Detail
  - SAMv3Handler
```
public SAMv3Handler(SocketChannel s,
                    int verMajor,
                    int verMinor,
                    Properties i2cpProps,
                    SAMBridge parent)
             throws SAMException,
                    IOException
```
    Create a new SAM version 3 handler. This constructor expects that the SAM HELLO message has been still answered (and stripped) from the socket input stream.
    Parameters:
    s - Socket attached to a SAM client
    verMajor - SAM major version to manage (should be 3)
    verMinor - SAM minor version to manage
    i2cpProps - properties to configure the I2CP connection (host, port, etc)
    Throws:
    SAMException - if the version is not supported
    IOException - if an I/O error occurs
  - SAMv3Handler
```
public SAMv3Handler(SocketChannel s,
                    int verMajor,
                    int verMinor,
                    SAMBridge parent)
             throws SAMException,
                    IOException
```
    Create a new SAM version 3 handler. This constructor expects that the SAM HELLO message has been still answered (and stripped) from the socket input stream.
    Parameters:
    s - Socket attached to a SAM client
    verMajor - SAM major version to manage (should be 3)
    verMinor - SAM minor version to manage
    Throws:
    SAMException - if the version is not supported
    IOException - if an I/O error occurs
- Method Detail
  - execSessionMessage
```
protected boolean execSessionMessage(String opcode,
                                     Properties props)
```
    Parse and execute a SESSION message.
    Overrides:
    execSessionMessage in class SAMv1Handler
    Parameters:
    opcode - the SESSION sub-command (e.g. CREATE, ADD, REMOVE)
    props - the parsed message properties
    Returns:
    true if the handler should continue processing commands
  - execStreamConnect
```
protected boolean execStreamConnect(Properties props)
```
    Parse and execute a STREAM CONNECT message. Dispatches the blocking I2P socket connect to a shared connector pool so the caller's worker thread is never blocked. Error responses (CONNECTION_REFUSED, CANT_REACH_PEER, TIMEOUT, etc.) are sent asynchronously by the ConnectTask. Supports SILENT mode to suppress status messages.
    Overrides:
    execStreamConnect in class SAMv1Handler
    Parameters:
    props - the parsed message properties
    Returns:
    true if the handler should continue processing commands
  - execStreamMessage
```
protected boolean execStreamMessage(String opcode,
                                    Properties props)
```
    Parse and execute a STREAM message.
    Overrides:
    execStreamMessage in class SAMv1Handler
    Parameters:
    opcode - the STREAM sub-command (e.g. CONNECT, ACCEPT, FORWARD)
    props - the parsed message properties
    Returns:
    true if the handler should continue processing commands
  - getBridge
```
SAMBridge getBridge()
```
    For SAMv3StreamSession
  - getClientIP
```
public String getClientIP()
```
    Get the IP address of the connected SAM client.
    Returns:
    the client's IP address as a string
  - getSession
```
Session getSession()
```
    For SAMv3DatagramServer
    Returns:
    may be null
  - handle
```
public void handle()
```
    Legacy handle() method. Not used when the handler is managed by SAMHandlerPool, which dispatches via processLine(). Retained to fulfill the abstract contract in SAMHandler.
    Overrides:
    handle in class SAMv1Handler
  - hasActiveStream
```
boolean hasActiveStream()
```
    Returns:
    true if the handler has an active data stream (stolen or forwarding)
  - notifyStreamIncomingConnection
```
public void notifyStreamIncomingConnection(Destination d,
                                           int fromPort,
                                           int toPort)
                                    throws IOException
```
    notifyStreamIncomingConnection.
    Throws:
    IOException
  - notifyStreamIncomingConnection
```
public static void notifyStreamIncomingConnection(SocketChannel client,
                                                  Destination d)
                                           throws IOException
```
    Notify the SAM client of an incoming stream connection on a static channel.
    Parameters:
    client - the client
    d - the destination of the remote peer
    Throws:
    IOException - if writing to the client socket fails
  - notifyStreamIncomingConnection
```
public static void notifyStreamIncomingConnection(SocketChannel client,
                                                  Destination d,
                                                  int fromPort,
                                                  int toPort)
                                           throws IOException
```
    Notify the SAM client of an incoming stream connection with port information.
    Parameters:
    client - the client
    d - the destination of the remote peer
    fromPort - the source port
    toPort - the destination port
    Throws:
    IOException - if writing to the client socket fails
  - notifyStreamResult
```
public void notifyStreamResult(boolean verbose,
                               String result,
                               String message)
                        throws IOException
```
    Parameters:
    verbose - if false, does nothing
    result - non-null
    message - may be null
    Throws:
    IOException
  - processLine
```
boolean processLine(String line)
```
    Process a single complete command line dispatched by the pool or the legacy handle() loop. Returns false to signal the caller that the handler should stop.
    Parameters:
    line - the complete command line (without trailing newline)
    Returns:
    true if the handler should continue processing commands
  - setSession
```
void setSession(SAMv3DatagramSession sess)
```
    For subsessions created by MasterSession
  - setSession
```
void setSession(SAMv3RawSession sess)
```
    For subsessions created by MasterSession
  - setSession
```
void setSession(SAMv3StreamSession sess)
```
    For subsessions created by MasterSession
  - stealSocket
```
public void stealSocket()
```
    For SAMv3StreamSession connect and accept
  - stopHandling
```
public void stopHandling()
```
    Stop the SAM handler, close the socket (unless stolen), unregister from the bridge and the handler pool.
    Specified by:
    stopHandling in interface Handler
    Overrides:
    stopHandling in class SAMHandler
  - verifVersion
```
public boolean verifVersion()
```
    Verify the SAM protocol version is supported by this handler.
    Overrides:
    verifVersion in class SAMv1Handler
    Returns:
    true if the major version matches this handler's version

Class SAMv3Handler

Field Summary

Fields inherited from class net.i2p.sam.SAMv1Handler

Fields inherited from class net.i2p.sam.SAMHandler

Constructor Summary

Method Summary

Methods inherited from class net.i2p.sam.SAMv1Handler

Methods inherited from class net.i2p.sam.SAMHandler

Methods inherited from class java.lang.Object

Field Detail

sendPorts

sSessionsHash

stolenSocket

streamForwardingSocket

Constructor Detail

SAMv3Handler

SAMv3Handler

Method Detail

execSessionMessage

execStreamConnect

execStreamMessage

getBridge

getClientIP

getSession

handle

hasActiveStream

notifyStreamIncomingConnection

notifyStreamIncomingConnection

notifyStreamIncomingConnection

notifyStreamResult

processLine

setSession

setSession

setSession

stealSocket

stopHandling

verifVersion