SAMv3DatagramSession

net.i2p.sam.SAMv3DatagramSession

All Implemented Interfaces:: Closeable, AutoCloseable, SAMDatagramReceiver, SAMMessageSess, Session

class SAMv3DatagramSessionextends SAMDatagramSession implements Session, SAMDatagramReceiver

SAM v3 datagram session implementation.

Field Summary
Fields
Modifier and Type
Field
Description
private final SocketAddress
clientAddress
Where the client's datagrams come from.
private final SAMv3Handler
handler
The handler that created this session.
private final String
nick
Name the client gave this session.
private final SAMv3DatagramServer
server
The UDP server the session is registered with.
Fields inherited from class SAMDatagramSession
DGRAM_SIZE_MAX, recv
Modifier and Type
Field
Description
static final int
DGRAM_SIZE_MAX
Largest datagram payload accepted in either direction, in bytes.
protected SAMDatagramReceiver
recv
Receiver this session hands assembled incoming datagrams to.
Fields inherited from class SAMMessageSession
_isOwnSession, _log
Modifier and Type
Field
Description
protected final boolean
_isOwnSession
True for a session we opened, false for a remote peer's.
protected final Log
_log
Logger for this session's messages.
Constructor Summary
Constructors
Constructor
Description
SAMv3DatagramSession(String nick, Properties props, SAMv3Handler handler, I2PSession isess, int listenProtocol, int listenPort, SAMv3DatagramServer dgServer)
Build a Datagram Session on an existing i2p session registered with the given nickname
SAMv3DatagramSession(String nick, SAMv3DatagramServer dgServer)
Build a DatagramSession according to informations registered with the given nickname
Method Summary
Modifier and Type
Method
Description
String
getNick()
Get the session nickname.
private static SessionRecord
getRec(String nick)
Look up the registered session record for the given nickname, throwing if it has already disappeared.
void
receiveDatagramBytes(Destination sender, byte[] data, int proto, int fromPort, int toPort)
Receive a datagram from I2P and forward to the SAM client.
void
stopDatagramReceiving()
Stop receiving datagrams.
Methods inherited from class SAMDatagramSession
messageReceived, sendBytes, sendBytes, shutDown
Modifier and Type
Method
Description
protected void
messageReceived(byte[] msg, int proto, int fromPort, int toPort)
Handle a received datagram message from I2P.
boolean
sendBytes(String dest, byte[] data, int proto, int fromPort, int toPort)
Send bytes through a SAM DATAGRAM session.
boolean
sendBytes(String dest, byte[] data, int proto, int fromPort, int toPort, boolean sendLeaseSet, int sendTags, int tagThreshold, int expiration)
Send bytes through a SAM DATAGRAM session.
protected void
shutDown()
Shut down the datagram session.
Methods inherited from class SAMMessageSession
close, getDestination, getI2PSession, getListenPort, getListenProtocol, lookupDest, lookupDest, sendBytesThroughMessageSession, sendBytesThroughMessageSession, start
Modifier and Type
Method
Description
void
close()
Close a SAM message-based session.
Destination
getDestination()
Get the SAM message-based session Destination.
protected I2PSession
getI2PSession()
Get the I2PSession object used by the SAM message-based session.
int
getListenPort()
Port to listen on.
int
getListenProtocol()
Protocol family to listen for.
Destination
lookupDest(String name)
Lookup a destination through the I2CP session.
(package private) static Destination
lookupDest(I2PSession session, String name)
Lookup a destination through the I2CP session.
protected boolean
sendBytesThroughMessageSession(String dest, byte[] data, int proto, int fromPort, int toPort)
Actually send bytes through the SAM message-based session I2PSession (er...).
protected boolean
sendBytesThroughMessageSession(String dest, byte[] data, int proto, int fromPort, int toPort, boolean sendLeaseSet, int sendTags, int tagThreshold, int expiration)
Actually send bytes through the SAM message-based session I2PSession, using per-message extended options.
void
start()
Start the SAM message session handler.
Methods inherited from class Object
clone, equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Details
- handler
  private final SAMv3Handler handler
  The handler that created this session.
- server
  private final SAMv3DatagramServer server
  The UDP server the session is registered with.
- nick
  private final String nick
  Name the client gave this session.
- clientAddress
  private final SocketAddress clientAddress
  Where the client's datagrams come from.
Constructor Details
- SAMv3DatagramSession
  public SAMv3DatagramSession(String nick, SAMv3DatagramServer dgServer) throws IOException, DataFormatException, I2PSessionException, SAMException
  Build a DatagramSession according to informations registered with the given nickname
  Caller MUST call start().
  Parameters:
  nick - nickname of the session
  dgServer - the datagram server that dispatches datagrams to this session
  Throws:
  IOException - declared on this constructor, but not raised by the body
  DataFormatException - likewise declared, but not raised by the body
  I2PSessionException - if the session registered under nick cannot be rebuilt from the record's destination
  SAMException - if the nickname is no longer registered
- SAMv3DatagramSession
  public SAMv3DatagramSession(String nick, Properties props, SAMv3Handler handler, I2PSession isess, int listenProtocol, int listenPort, SAMv3DatagramServer dgServer) throws IOException, DataFormatException, I2PSessionException
  Build a Datagram Session on an existing i2p session registered with the given nickname
  Caller MUST call start().
  Parameters:
  nick - nickname of the session
  props - session properties read from the SESSION CREATE command
  handler - handler used to send DATAGRAM replies back to the client
  isess - the existing I2P session this datagram session runs over
  listenProtocol - datagram protocol number to listen for, 0 for any
  listenPort - local port to listen on, 0 for any
  dgServer - the datagram server that dispatches datagrams to this session
  Throws:
  IOException - declared on this constructor, but not raised by the body
  DataFormatException - likewise declared, but not raised by the body
  I2PSessionException - declared on this constructor, but not raised by the body
Method Details
- getNick
  public String getNick()
  Get the session nickname.
  Specified by:
  getNick in interface Session
  Returns:
  the nickname this session is registered under with the SAM v3 handler
- getRec
  private static SessionRecord getRec(String nick) throws SAMException
  Look up the registered session record for the given nickname, throwing if it has already disappeared.
  Parameters:
  nick - the nickname the session was registered under
  Returns:
  the registered session record, never null because a missing one is thrown rather than returned
  Throws:
  SAMException - if the nickname is not registered
- receiveDatagramBytes
  public void receiveDatagramBytes(Destination sender, byte[] data, int proto, int fromPort, int toPort) throws IOException
  Receive a datagram from I2P and forward to the SAM client.
  Specified by:
  receiveDatagramBytes in interface SAMDatagramReceiver
  Parameters:
  sender - the destination that sent the datagram
  data - the datagram payload
  proto - the I2CP protocol
  fromPort - the I2CP from port
  toPort - the I2CP to port
  Throws:
  IOException - if forwarding to the client fails
- stopDatagramReceiving
  public void stopDatagramReceiving()
  Stop receiving datagrams.
  Specified by:
  stopDatagramReceiving in interface SAMDatagramReceiver

Field Summary

Fields inherited from class SAMDatagramSession

Fields inherited from class SAMMessageSession

Constructor Summary

Method Summary

Methods inherited from class SAMDatagramSession

Methods inherited from class SAMMessageSession

Methods inherited from class Object

Field Details

handler

server

nick

clientAddress

Constructor Details

SAMv3DatagramSession

Method Details

getNick

getRec

receiveDatagramBytes

stopDatagramReceiving