SAMDatagramSession (Javadocs [I2P+ 2.13.0+]

java.lang.Object
- net.i2p.sam.SAMMessageSession
- - net.i2p.sam.SAMDatagramSession

All Implemented Interfaces:
Closeable, AutoCloseable, SAMMessageSess
Direct Known Subclasses:
SAMv3DatagramSession
```
class SAMDatagramSession
extends SAMMessageSession
```
SAM DATAGRAM session class.

Field Summary
Fields
Modifier and Type Field and Description
static int DGRAM_SIZE_MAX
DGRAM_SIZE_MAX.
protected SAMDatagramReceiver recv
recv.
- Fields inherited from class net.i2p.sam.SAMMessageSession
  _isOwnSession, _log

Fields
Modifier and Type	Field and Description
`static int`	`DGRAM_SIZE_MAX` DGRAM_SIZE_MAX.
`protected SAMDatagramReceiver`	`recv` recv.

Constructor Summary

Constructors
Modifier	Constructor and Description
`protected`	`SAMDatagramSession(I2PSession sess, Properties props, int listenPort, SAMDatagramReceiver recv)` Create a new SAM DATAGRAM session on an existing I2P session.
	`SAMDatagramSession(InputStream destStream, Properties props, SAMDatagramReceiver recv)` Create a new SAM DATAGRAM session.
`protected`	`SAMDatagramSession(String dest, Properties props, SAMDatagramReceiver recv)` Create a new SAM DATAGRAM session.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and 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 net.i2p.sam.SAMMessageSession
close, getDestination, getI2PSession, getListenPort, getListenProtocol, lookupDest, lookupDest, sendBytesThroughMessageSession, sendBytesThroughMessageSession, start

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

Field Detail
- DGRAM_SIZE_MAX
```
public static final int DGRAM_SIZE_MAX
```
  DGRAM_SIZE_MAX.
  See Also:
  Constant Field Values
- recv
```
protected SAMDatagramReceiver recv
```
  recv.

Constructor Detail

SAMDatagramSession

protected SAMDatagramSession(I2PSession sess,
                             Properties props,
                             int listenPort,
                             SAMDatagramReceiver recv)
                      throws I2PSessionException

Create a new SAM DATAGRAM session on an existing I2P session.

Parameters:: props - unused for now
Throws:: I2PSessionException

SAMDatagramSession
```
public SAMDatagramSession(InputStream destStream,
                          Properties props,
                          SAMDatagramReceiver recv)
                   throws I2PSessionException
```
Create a new SAM DATAGRAM session. Caller MUST call start().
Parameters:
destStream - Input stream containing the destination keys
props - Properties to setup the I2P session
recv - Object that will receive incoming data
Throws:
I2PSessionException

SAMDatagramSession

protected SAMDatagramSession(String dest,
                             Properties props,
                             SAMDatagramReceiver recv)
                      throws IOException,
                             DataFormatException,
                             I2PSessionException

Create a new SAM DATAGRAM session.

Parameters:: dest - Base64-encoded destination (private key); props - Properties to setup the I2P session; recv - Object that will receive incoming data
Throws:: IOException; DataFormatException; I2PSessionException

Method Detail

messageReceived
```
protected void messageReceived(byte[] msg,
                               int proto,
                               int fromPort,
                               int toPort)
```
Handle a received datagram message from I2P.
Specified by:
messageReceived in class SAMMessageSession
Parameters:
msg - the raw I2P datagram message
proto - the I2CP protocol
fromPort - the I2CP from port
toPort - the I2CP to port

sendBytes
```
public boolean sendBytes(String dest,
                         byte[] data,
                         int proto,
                         int fromPort,
                         int toPort)
                  throws DataFormatException,
                         I2PSessionException
```
Send bytes through a SAM DATAGRAM session.
Specified by:
sendBytes in interface SAMMessageSess
Specified by:
sendBytes in class SAMMessageSession
Parameters:
dest - Destination
data - Bytes to be sent
proto - ignored, will always use PROTO_DATAGRAM (17)
Returns:
True if the data was sent, false otherwise
Throws:
DataFormatException - on unknown / bad dest
I2PSessionException - on serious error, probably session closed

sendBytes

public boolean sendBytes(String dest,
                         byte[] data,
                         int proto,
                         int fromPort,
                         int toPort,
                         boolean sendLeaseSet,
                         int sendTags,
                         int tagThreshold,
                         int expiration)
                  throws DataFormatException,
                         I2PSessionException

Send bytes through a SAM DATAGRAM session.

Throws:: DataFormatException; I2PSessionException

shutDown
```
protected void shutDown()
```
Shut down the datagram session.
Specified by:
shutDown in class SAMMessageSession

Class SAMDatagramSession

Field Summary

Fields inherited from class net.i2p.sam.SAMMessageSession

Constructor Summary

Method Summary

Methods inherited from class net.i2p.sam.SAMMessageSession

Methods inherited from class java.lang.Object

Field Detail

DGRAM_SIZE_MAX

recv

Constructor Detail

SAMDatagramSession

SAMDatagramSession

SAMDatagramSession

Method Detail

messageReceived

sendBytes

sendBytes

shutDown