com.cloudhopper.smpp

Interface SmppSessionHandler

All Superinterfaces:

PduTranscoderContext

All Known Subinterfaces:

SmppSessionListener

All Known Implementing Classes:

DefaultSmppSessionHandler, PollableSmppSessionHandler

public interface SmppSessionHandler
extends PduTranscoderContext

Handles events received on an SmppSession.

Author:

joelauer (twitter: @jjlauer or http://twitter.com/jjlauer)

Method Summary

Methods

Modifier and Type	Method and Description
void	fireChannelUnexpectedlyClosed() Called when the underlying channel of a session has been closed and it wasn't at the request of our side.
void	fireExpectedPduResponseReceived(PduAsyncResponse pduAsyncResponse) Called when a response PDU is received for a previously sent request PDU.
void	firePduRequestExpired(PduRequest pduRequest) Called when a request PDU has not received an associated response within the expiry time.
PduResponse	firePduRequestReceived(PduRequest pduRequest) Called when a request PDU such as a "DeliverSM" has been received on a session.
void	fireRecoverablePduException(RecoverablePduException e) Called when a "recoverable" exception has been thrown downstream in the session's pipeline.
void	fireUnexpectedPduResponseReceived(PduResponse pduResponse) Called when a response PDU is received for a request this session never sent.
void	fireUnknownThrowable(Throwable t) Called when any exception/throwable has been thrown downstream in the session's pipeline that wasn't of the types: UnrecoverablePduException or RecoverablePduException.
void	fireUnrecoverablePduException(UnrecoverablePduException e) Called when an "unrecoverable" exception has been thrown downstream in the session's pipeline.

Methods inherited from interface com.cloudhopper.smpp.transcoder.PduTranscoderContext

lookupResultMessage, lookupTlvTagName

Method Detail

fireChannelUnexpectedlyClosed

void fireChannelUnexpectedlyClosed()

Called when the underlying channel of a session has been closed and it wasn't at the request of our side. This will either indicate the remote system closed the socket OR the connection dropped in-between. If the session's actual "close" method was called, this won't be triggered.

firePduRequestReceived

PduResponse firePduRequestReceived(PduRequest pduRequest)

Called when a request PDU such as a "DeliverSM" has been received on a session. This method provides a simply way to return a response PDU. If a non-null response PDU is returned, this pdu will be sent back on the session's channel. If the response PDU is null, then no response will be sent back and its up to the implementation to send back the response instead.

Parameters:

pduRequest - The request PDU received on this session

Returns:

The response PDU to send back OR null if no response should be returned.

firePduRequestExpired

void firePduRequestExpired(PduRequest pduRequest)

Called when a request PDU has not received an associated response within the expiry time. Usually, this means the request should be retried.

Parameters:

pduRequest - The request PDU received on this session

fireExpectedPduResponseReceived

void fireExpectedPduResponseReceived(PduAsyncResponse pduAsyncResponse)

Called when a response PDU is received for a previously sent request PDU. Only "expected" responses are passed to this method. An "expected" response is a response that matches a previously sent request. Both the original request and the response along with other info is passed to this method.
NOTE: If another thread is "waiting" for a response, that thread will receive it vs. this method. This method will only receive expected responses that were either sent "asynchronously" or received after the originating thread timed out while waiting for a response.

Parameters:

pduAsyncResponse - The "expected" response PDU received on this session

fireUnexpectedPduResponseReceived

void fireUnexpectedPduResponseReceived(PduResponse pduResponse)

Called when a response PDU is received for a request this session never sent. Only "unexpected" responses are passed to this method. An "unexpected" response is a response that does NOT match a previously sent request. That can either happen because it really is an invalid response OR another thread that originated the request "cancelled" it. Cancelling is VERY uncommon so an invalid response is more likely.

Parameters:

pduResponse - The "unexpected" response PDU received on this session

fireUnrecoverablePduException

void fireUnrecoverablePduException(UnrecoverablePduException e)

Called when an "unrecoverable" exception has been thrown downstream in the session's pipeline. The best example is a PDU that has an impossible sequence number. The recommended action is almost always to close the session and attempt to rebind at a later time.

Parameters:

e - The exception

fireRecoverablePduException

void fireRecoverablePduException(RecoverablePduException e)

Called when a "recoverable" exception has been thrown downstream in the session's pipeline. The best example is a PDU that may have been missing some fields such as NULL byte. A "recoverable" exception always includes a "PartialPdu" which always contains enough information to create a "NACK" back. That's the recommended behavior of implementations -- to trigger a GenericNack for PduRequests.

Parameters:

e - The exception

fireUnknownThrowable

void fireUnknownThrowable(Throwable t)

Called when any exception/throwable has been thrown downstream in the session's pipeline that wasn't of the types: UnrecoverablePduException or RecoverablePduException.

Parameters:

e - The exception