Package net.i2p.sam

Class SAMDatagramSession

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. Supports DG2/3 as of 0.9.68

Author:

human

Field Summary

Fields

Modifier and Type	Field	Description
static final int	DGRAM_SIZE_MAX
protected SAMDatagramReceiver	recv

Fields inherited from class net.i2p.sam.SAMMessageSession

_isOwnSession, _log

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method	Description
protected void	messageReceived(byte[] msg, int proto, int fromPort, int toPort)	Handle a new received message
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()	Do whatever is needed to shutdown the SAM session

Methods inherited from class net.i2p.sam.SAMMessageSession

close, getDestination, getI2PSession, getListenPort, getListenProtocol, sendBytesThroughMessageSession, sendBytesThroughMessageSession, start

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Details

DGRAM_SIZE_MAX

public static final int DGRAM_SIZE_MAX

See Also:

• Constant Field Values

recv

protected SAMDatagramReceiver recv

Constructor Details

SAMDatagramSession

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

Create a new SAM DATAGRAM session. v1/v2 (DG1 only) or v3 (DG 1/2/3)

Parameters:

dest - Base64-encoded destination (private key)

props - Properties to setup the I2P session

recv - Object that will receive incoming data

v - datagram version 1/2/3

Throws:

IOException

DataFormatException

I2PSessionException

SAMDatagramSession

@Deprecated
public SAMDatagramSession(InputStream destStream,
 Properties props,
 SAMDatagramReceiver recv)
                   throws IOException,
DataFormatException,
I2PSessionException

Deprecated.

unused

Create a new SAM DATAGRAM session. v1/v2 only, DG1 only 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:

IOException

DataFormatException

I2PSessionException

SAMDatagramSession

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

Create a new SAM DATAGRAM session on an existing I2P session. v3 only, DG 1/2/3

Parameters:

v - datagram version 1/2/3

Throws:

IOException

DataFormatException

I2PSessionException

Since:

0.9.25

Method Details

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), PROTO_DATAGRAM2 (19), or PROTO_DATAGRAM3 (20)

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.

Parameters:

proto - ignored, will always use PROTO_DATAGRAM (17), PROTO_DATAGRAM2 (19), or PROTO_DATAGRAM3 (20)

Throws:

DataFormatException

I2PSessionException

Since:

0.9.25

messageReceived

protected void messageReceived(byte[] msg,
 int proto,
 int fromPort,
 int toPort)

Description copied from class: SAMMessageSession

Handle a new received message

Specified by:

messageReceived in class SAMMessageSession

Parameters:

msg - Message payload

shutDown

protected void shutDown()

Description copied from class: SAMMessageSession

Do whatever is needed to shutdown the SAM session

Specified by:

shutDown in class SAMMessageSession