SAMv2StreamSession

java.lang.Object

net.i2p.sam.SAMStreamSession

net.i2p.sam.SAMv2StreamSession

All Implemented Interfaces:: Closeable, AutoCloseable, SAMMessageSess

class SAMv2StreamSessionextends SAMStreamSession

SAMv2 STREAM session class.

Nested Class Summary
Modifier and Type
Class
Description
class
SAMv2StreamSession.SAMv2StreamSessionSocketReader
SAM STREAM socket reader, running in its own thread.
private class
SAMv2StreamSession.StreamConnector
SAM STREAM socket connecter, running in its own thread.
private class
SAMv2StreamSession.V2StreamSender
Thread sending the v2 stream data.
Nested classes/interfaces inherited from class SAMStreamSession
SAMStreamSession.DisconnectListener, SAMStreamSession.SAMStreamSessionServer, SAMStreamSession.SAMStreamSessionSocketReader, SAMStreamSession.SAMv1StreamSessionSocketReader, SAMStreamSession.StreamSender
Modifier and Type
Class
Description
protected class
SAMStreamSession.DisconnectListener
Closes SAM session when the underlying I2P manager disconnects.
class
SAMStreamSession.SAMStreamSessionServer
SAM STREAM session server, running in its own thread.
static class
SAMStreamSession.SAMStreamSessionSocketReader
Reads bytes off one tunnel socket and pushes them to the SAM client.
class
SAMStreamSession.SAMv1StreamSessionSocketReader
SAMv1StreamSessionSocketReader.
protected static class
SAMStreamSession.StreamSender
Lets us push data through the stream without blocking, (even after exceeding the I2PSocket's buffer).
Field Summary
Fields inherited from class SAMStreamSession
_isOwnSession, _log, canCreate, DEFAULT_FORCE_FLUSH, forceFlush, PROP_FORCE_FLUSH, recv, server, SOCKET_HANDLER_BUF_SIZE, socketMgr
Modifier and Type
Field
Description
protected final boolean
_isOwnSession
Whether this is our own session, as opposed to a remote peer's.
protected final Log
_log
Logger for this session's messages.
protected final boolean
canCreate
Whether this session may create outgoing connections.
static final String
DEFAULT_FORCE_FLUSH
Default for SAMStreamSession.PROP_FORCE_FLUSH.
protected final boolean
forceFlush
Should we flush every time we get a STREAM SEND, or leave that up to the streaming lib to decide?
static final String
PROP_FORCE_FLUSH
Config key for flushing on every STREAM SEND.
protected final SAMStreamReceiver
recv
The receiver that decodes incoming SAM messages.
protected final SAMStreamSession.SAMStreamSessionServer
server
The server this session belongs to.
protected static final int
SOCKET_HANDLER_BUF_SIZE
Read buffer size for each socket reader.
protected final I2PSocketManager
socketMgr
The socket manager used for outgoing connections.
Constructor Summary
Constructors
Constructor
Description
SAMv2StreamSession(InputStream destStream, String dir, Properties props, SAMStreamReceiver recv)
Create a new SAM STREAM session.
SAMv2StreamSession(String dest, String dir, Properties props, SAMStreamReceiver recv)
Create a new SAM STREAM session.
Method Summary
Public Methods
Modifier and Type
Method
Description
boolean
connect(int id, String dest, Properties props)
Connect the SAM STREAM session to the specified Destination.
protected SAMStreamSession.SAMStreamSessionSocketReader
newSAMStreamSessionSocketReader(I2PSocket s, int id)
Creates the version 2 socket reader for this session.
protected SAMStreamSession.StreamSender
newStreamSender(I2PSocket s, int id)
Lets us push data through the stream without blocking, (even after exceeding the I2PSocket's buffer).
boolean
setReceiveLimit(int id, long limit, boolean nolimit)
Set a receive limit on a stream.
Methods inherited from class SAMStreamSession
checkSocketHandlerId, close, closeConnection, createSocketHandler, getDestination, getListenPort, getListenProtocol, getSocketReader, isDestroyed, lookupDest, removeSocketHandler, sendBytes, sendBytes, sendBytes, start
Modifier and Type
Method
Description
protected boolean
checkSocketHandlerId(int id)
Check whether a SAM STREAM session socket handler id is still in use.
void
close()
Close a SAM STREAM session.
boolean
closeConnection(int id)
Close a connection managed by the SAM STREAM session.
protected int
createSocketHandler(I2PSocket s, int id)
Create a new SAM STREAM session socket handler, detaching its thread.
Destination
getDestination()
Get the SAM STREAM session Destination.
int
getListenPort()
Get the port for this session's listener.
int
getListenProtocol()
Get the I2CP protocol for this session's listener.
protected SAMStreamSession.SAMStreamSessionSocketReader
getSocketReader(int id)
Get a SAM STREAM session socket handler.
boolean
isDestroyed()
Is the underlying streaming socket manager destroyed?
Destination
lookupDest(String name)
Lookup a destination through the I2CP session.
protected void
removeSocketHandler(int id)
Remove and gracefully close a SAM STREAM session socket handler.
boolean
sendBytes(int id, InputStream in, int size)
Send bytes through a SAM STREAM session.
boolean
sendBytes(String s, byte[] b, int pr, int fp, int tp)
Sending bytes is not supported in a STREAM or MASTER session; always throws.
boolean
sendBytes(String s, byte[] b, int pr, int fp, int tp, boolean sendLeaseSet, int sendTags, int tagThreshold, int expiration)
Sending bytes is not supported in a STREAM or MASTER session; always throws.
void
start()
Start the SAM STREAM session server, if applicable.
Methods inherited from class Object
clone, equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details
- SAMv2StreamSession
  public SAMv2StreamSession(String dest, String dir, Properties props, SAMStreamReceiver recv) throws IOException, DataFormatException, SAMException
  Create a new SAM STREAM session.
  Caller MUST call start().
  Parameters:
  dest - Base64-encoded destination and private keys (same format as PrivateKeyFile)
  dir - Session direction ("RECEIVE", "CREATE" or "BOTH")
  props - Properties to setup the I2P session
  recv - Object that will receive incoming data
  Throws:
  IOException - declared on this constructor, but not raised by the body
  DataFormatException - likewise declared, but not raised by the body
  SAMException - if dir names no known direction, if i2cp.tcp.port is not a number, or if the I2P session cannot be created
- SAMv2StreamSession
  public SAMv2StreamSession(InputStream destStream, String dir, Properties props, SAMStreamReceiver recv) throws IOException, DataFormatException, SAMException
  Create a new SAM STREAM session.
  Caller MUST call start().
  Parameters:
  destStream - Input stream containing the destination and private keys (same format as PrivateKeyFile)
  dir - Session direction ("RECEIVE", "CREATE" or "BOTH")
  props - Properties to setup the I2P session
  recv - Object that will receive incoming data
  Throws:
  IOException - declared on this constructor, but not raised by the body
  DataFormatException - likewise declared, but not raised by the body
  SAMException - if dir names no known direction, if i2cp.tcp.port is not a number, or if the I2P session cannot be created
Method Details
- connect
  public boolean connect(int id, String dest, Properties props) throws DataFormatException, SAMInvalidDirectionException
  Connect the SAM STREAM session to the specified Destination.
  Overrides:
  connect in class SAMStreamSession
  Parameters:
  id - Unique id for the connection
  dest - Base64-encoded Destination to connect to
  props - Options to be used for connection
  Returns:
  true if the communication with the SAM client is ok
  Throws:
  DataFormatException - if the destination is not valid
  SAMInvalidDirectionException - if trying to connect through a receive-only session
- newStreamSender
  protected SAMStreamSession.StreamSender newStreamSender(I2PSocket s, int id) throws IOException
  Lets us push data through the stream without blocking, (even after exceeding the I2PSocket's buffer).
  Overrides:
  newStreamSender in class SAMStreamSession
  Parameters:
  s - I2PSocket
  id - the caller's own socket id, passed through to the sender
  Returns:
  v2StreamSender
  Throws:
  IOException - if the socket's output stream cannot be obtained
- newSAMStreamSessionSocketReader
  protected SAMStreamSession.SAMStreamSessionSocketReader newSAMStreamSessionSocketReader(I2PSocket s, int id) throws IOException
  Creates the version 2 socket reader for this session.
  Overrides:
  newSAMStreamSessionSocketReader in class SAMStreamSession
  Parameters:
  s - Socket to be handled
  id - Unique id assigned to the handler
  Returns:
  the socket reader
  Throws:
  IOException - if the socket reader cannot be created
- setReceiveLimit
  public boolean setReceiveLimit(int id, long limit, boolean nolimit)
  Set a receive limit on a stream.
  Overrides:
  setReceiveLimit in class SAMStreamSession
  Parameters:
  id - the SAM stream id whose reader gets the limit
  limit - the receive limit in bytes
  nolimit - true for unlimited
  Returns:
  true if the limit was set, false if the reader was not found

Nested Class Summary

Nested classes/interfaces inherited from class SAMStreamSession

Field Summary

Fields inherited from class SAMStreamSession

Constructor Summary

Method Summary

Methods inherited from class SAMStreamSession

Methods inherited from class Object

Constructor Details

SAMv2StreamSession

Method Details

connect

newStreamSender

newSAMStreamSessionSocketReader

setReceiveLimit