SAMStreamSink.SinkEventHandler

net.i2p.sam.client.SAMStreamSink.SinkEventHandler

All Implemented Interfaces:: SAMReader.SAMClientEventListener

Direct Known Subclasses:: SAMStreamSink.SinkEventHandler2

Enclosing class:: SAMStreamSink

private class SAMStreamSink.SinkEventHandlerextends SAMEventHandler

Handles session events and writes received messages to files.

Field Summary
Fields
Modifier and Type
Field
Description
protected final OutputStream
_out
Stream to the SAM bridge, used to answer keepalives.
Fields inherited from interface SAMReader.SAMClientEventListener
NAMING_REPLY_INVALID_KEY, NAMING_REPLY_KEY_NOT_FOUND, NAMING_REPLY_OK, SESSION_STATUS_DUPLICATE_DEST, SESSION_STATUS_I2P_ERROR, SESSION_STATUS_INVALID_KEY, SESSION_STATUS_OK, STREAM_CLOSED_CANT_REACH_PEER, STREAM_CLOSED_I2P_ERROR, STREAM_CLOSED_OK, STREAM_CLOSED_PEER_NOT_FOUND, STREAM_CLOSED_TIMEOUT, STREAM_STATUS_CANT_REACH_PEER, STREAM_STATUS_I2P_ERROR, STREAM_STATUS_INVALID_KEY, STREAM_STATUS_OK, STREAM_STATUS_TIMEOUT
Modifier and Type
Field
Description
static final String
NAMING_REPLY_INVALID_KEY
Naming lookup failed because the private key is invalid.
static final String
NAMING_REPLY_KEY_NOT_FOUND
Naming lookup failed because no key matches the requested name.
static final String
NAMING_REPLY_OK
Naming lookup succeeded.
static final String
SESSION_STATUS_DUPLICATE_DEST
Session creation failed because the destination is already in use.
static final String
SESSION_STATUS_I2P_ERROR
SESSION_STATUS_I2P_ERROR.
static final String
SESSION_STATUS_INVALID_KEY
Session creation failed because the supplied private key is invalid.
static final String
SESSION_STATUS_OK
Session creation succeeded.
static final String
STREAM_CLOSED_CANT_REACH_PEER
Stream closed because the peer became unreachable.
static final String
STREAM_CLOSED_I2P_ERROR
STREAM_CLOSED_I2P_ERROR.
static final String
STREAM_CLOSED_OK
Stream closed normally.
static final String
STREAM_CLOSED_PEER_NOT_FOUND
Stream closed because the destination was no longer known to the router.
static final String
STREAM_CLOSED_TIMEOUT
Stream closed because the lease expired.
static final String
STREAM_STATUS_CANT_REACH_PEER
Stream connect failed because the peer could not be reached.
static final String
STREAM_STATUS_I2P_ERROR
STREAM_STATUS_I2P_ERROR.
static final String
STREAM_STATUS_INVALID_KEY
Stream connect failed because the private key is invalid.
static final String
STREAM_STATUS_OK
Stream connect succeeded.
static final String
STREAM_STATUS_TIMEOUT
Stream connect failed because the lease expired before it was established.
Constructor Summary
Constructors
Constructor
Description
SinkEventHandler(I2PAppContext ctx, OutputStream out)
Remember the bridge output stream for the event replies.
Method Summary
All Methods
Modifier and Type
Method
Description
void
datagramReceived(String dest, byte[] data, int offset, int length, int fromPort, int toPort)
Appends the received datagram to the first open sink.
void
pingReceived(String data)
Answers a bridge keepalive with a matching PONG.
void
rawReceived(byte[] data, int offset, int length, int fromPort, int toPort, int protocol)
Appends the received raw datagram to the first open sink.
void
streamClosedReceived(String result, String id, String message)
Closes the sink file and records the connection lifetime.
void
streamConnectedReceived(String dest, String id)
Opens a sink file for a newly connected stream.
void
streamDataReceived(String id, byte[] data, int offset, int length)
Appends the received stream data to the sink file.
Methods inherited from class SAMEventHandler
helloReplyReceived, namingReplyReceived, sessionStatusReceived, streamStatusReceived, unknownMessageReceived, waitForHelloReply, waitForNamingReply, waitForSessionAddReply, waitForSessionCreateReply, waitForStreamStatusReply
Modifier and Type
Method
Description
void
helloReplyReceived(boolean ok, String version)
Records the HELLO outcome and version, then wakes any waiter.
void
namingReplyReceived(String name, String result, String value, String msg)
Files a naming reply under its name, value on success and result otherwise.
void
sessionStatusReceived(String result, String destination, String msg)
May be called twice, first for CREATE and second for ADD.
void
streamStatusReceived(String result, String id, String message)
Records the session status result, then wakes any waiter.
void
unknownMessageReceived(String major, String minor, Properties params)
Logs a message this handler has no handling for.
String
waitForHelloReply()
Wait for the connection to be established, returning the server version if everything went ok.
String
waitForNamingReply(String name)
Return the destination found matching the name, or null if the key was not able to be retrieved.
boolean
waitForSessionAddReply()
Wait for the session to be added, returning true if everything went ok.
boolean
waitForSessionCreateReply()
Wait for the session to be created, returning true if everything went ok.
boolean
waitForStreamStatusReply()
Wait for the stream to be created, returning true if everything went ok.
Methods inherited from class SAMClientEventListenerImpl
destReplyReceived, pongReceived
Modifier and Type
Method
Description
void
destReplyReceived(String publicKey, String privateKey)
Called when a DEST reply arrives.
void
pongReceived(String data)
Called when a PONG reply arrives.
Methods inherited from class Object
clone, equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Details
- _out
  protected final OutputStream _out
  Stream to the SAM bridge, used to answer keepalives.
Constructor Details
- SinkEventHandler
  public SinkEventHandler(I2PAppContext ctx, OutputStream out)
  Remember the bridge output stream for the event replies.
  Parameters:
  ctx - the application context for the event handler
  out - the bridge output stream, used to answer keepalives
Method Details
- streamClosedReceived
  public void streamClosedReceived(String result, String id, String message)
  Closes the sink file and records the connection lifetime.
  Specified by:
  streamClosedReceived in interface SAMReader.SAMClientEventListener
  Overrides:
  streamClosedReceived in class SAMClientEventListenerImpl
  Parameters:
  result - the close status, one of the STREAM_CLOSED_* constants
  id - the stream ID of the stream that was closed
  message - the human-readable explanation supplied by the bridge
- streamDataReceived
  public void streamDataReceived(String id, byte[] data, int offset, int length)
  Appends the received stream data to the sink file.
  Specified by:
  streamDataReceived in interface SAMReader.SAMClientEventListener
  Overrides:
  streamDataReceived in class SAMClientEventListenerImpl
  Parameters:
  id - the stream ID the data arrived on
  data - the buffer holding the payload
  offset - the index within data where the payload starts
  length - the number of payload bytes valid from offset
- streamConnectedReceived
  public void streamConnectedReceived(String dest, String id)
  Opens a sink file for a newly connected stream.
  Specified by:
  streamConnectedReceived in interface SAMReader.SAMClientEventListener
  Overrides:
  streamConnectedReceived in class SAMClientEventListenerImpl
  Parameters:
  dest - the base64 destination the stream is connected to
  id - the stream ID assigned by the SAM bridge
- pingReceived
  public void pingReceived(String data)
  Answers a bridge keepalive with a matching PONG.
  Specified by:
  pingReceived in interface SAMReader.SAMClientEventListener
  Overrides:
  pingReceived in class SAMClientEventListenerImpl
  Parameters:
  data - the payload echoed back, limited to the first token of the line
- datagramReceived
  public void datagramReceived(String dest, byte[] data, int offset, int length, int fromPort, int toPort)
  Appends the received datagram to the first open sink.
  Specified by:
  datagramReceived in interface SAMReader.SAMClientEventListener
  Overrides:
  datagramReceived in class SAMClientEventListenerImpl
  Parameters:
  dest - the base64 destination that sent the datagram
  data - the buffer holding the datagram body
  offset - the index within data where the body starts
  length - the number of body bytes valid from offset
  fromPort - the source port in host byte order
  toPort - the destination port in host byte order
- rawReceived
  public void rawReceived(byte[] data, int offset, int length, int fromPort, int toPort, int protocol)
  Appends the received raw datagram to the first open sink.
  Specified by:
  rawReceived in interface SAMReader.SAMClientEventListener
  Overrides:
  rawReceived in class SAMClientEventListenerImpl
  Parameters:
  data - the buffer holding the raw datagram body
  offset - the index within data where the body starts
  length - the number of body bytes valid from offset
  fromPort - the source port in host byte order
  toPort - the destination port in host byte order
  protocol - the IP protocol number, or I2PSession.PROTO_DATAGRAM_RAW when unreported

Field Summary

Fields inherited from interface SAMReader.SAMClientEventListener

Constructor Summary

Method Summary

Methods inherited from class SAMEventHandler

Methods inherited from class SAMClientEventListenerImpl

Methods inherited from class Object

Field Details

_out

Constructor Details

SinkEventHandler

Method Details

streamClosedReceived

streamDataReceived

streamConnectedReceived

pingReceived

datagramReceived

rawReceived