PollableSmppSessionHandler (ch-smpp 5.0.6 API)

java.lang.Object
- com.cloudhopper.smpp.impl.PollableSmppSessionHandler

All Implemented Interfaces:

SmppSessionHandler, PduTranscoderContext
```
public class PollableSmppSessionHandler
extends Object
implements SmppSessionHandler
```
Implementation of an SMPP session handler that internally puts every event into a queue. Callers can then poll for these events rather than asynchronously processing them. Essentially turns an event driven SmppSession into a polling version. Mostly used in many of this framework's unit tests.

Author:

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

Constructor Summary

Constructors
Constructor and Description

PollableSmppSessionHandler()

Constructors
Constructor and Description
`PollableSmppSessionHandler()`

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.
`int`	`getClosedCount()`
`BlockingQueue<PduAsyncResponse>`	`getReceivedExpectedPduResponses()`
`BlockingQueue<PduRequest>`	`getReceivedPduRequests()`
`BlockingQueue<PduResponse>`	`getReceivedUnexpectedPduResponses()`
`BlockingQueue<Throwable>`	`getThrowables()`
`String`	`lookupResultMessage(int commandStatus)` Lookup a "command_status" value and returns a String that represents a result message (description) of what the value means.
`String`	`lookupTlvTagName(short tag)` Lookup a name for the tag of a TLV and returns a String that represents a name for it.

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

- Constructor Detail
  - PollableSmppSessionHandler
```
public PollableSmppSessionHandler()
```
- Method Detail
  - getReceivedPduRequests
```
public BlockingQueue<PduRequest> getReceivedPduRequests()
```
  - getReceivedExpectedPduResponses
```
public BlockingQueue<PduAsyncResponse> getReceivedExpectedPduResponses()
```
  - getReceivedUnexpectedPduResponses
```
public BlockingQueue<PduResponse> getReceivedUnexpectedPduResponses()
```
  - getThrowables
```
public BlockingQueue<Throwable> getThrowables()
```
  - getClosedCount
```
public int getClosedCount()
```
  - lookupResultMessage
```
public String lookupResultMessage(int commandStatus)
```
    Description copied from interface: PduTranscoderContext
    
    Lookup a "command_status" value and returns a String that represents a result message (description) of what the value means. A way to add helpful debugging information into logfiles or management interfaces. This value is printed out via the toString() method for a PDU response.
    
    Specified by:
    
    lookupResultMessage in interface PduTranscoderContext
    
    Parameters:
    commandStatus - The command_status field to lookup
    
    Returns:
    A String representing a short description of what the command_status value represents. For example, a command_status of 0 usually means "OK"
  - lookupTlvTagName
```
public String lookupTlvTagName(short tag)
```
    Description copied from interface: PduTranscoderContext
    
    Lookup a name for the tag of a TLV and returns a String that represents a name for it. A way to add helpful debugging information into logfiles or management interfaces.
    
    Specified by:
    
    lookupTlvTagName in interface PduTranscoderContext
    
    Parameters:
    tag - The TLV's tag value to lookup
    
    Returns:
    A String representing a short name of what the tag value represents. For example, a tag of 0x001E usually means "receipted_message_id"
  - firePduRequestReceived
```
public PduResponse firePduRequestReceived(PduRequest pduRequest)
```
    Description copied from interface: SmppSessionHandler
    
    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.
    
    Specified by:
    
    firePduRequestReceived in interface SmppSessionHandler
    
    Parameters:
    pduRequest - The request PDU received on this session
    
    Returns:
    The response PDU to send back OR null if no response should be returned.
  - fireExpectedPduResponseReceived
```
public void fireExpectedPduResponseReceived(PduAsyncResponse pduAsyncResponse)
```
    Description copied from interface: SmppSessionHandler
    
    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.
    
    Specified by:
    
    fireExpectedPduResponseReceived in interface SmppSessionHandler
    
    Parameters:
    pduAsyncResponse - The "expected" response PDU received on this session
  - fireUnexpectedPduResponseReceived
```
public void fireUnexpectedPduResponseReceived(PduResponse pduResponse)
```
    Description copied from interface: SmppSessionHandler
    
    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.
    
    Specified by:
    
    fireUnexpectedPduResponseReceived in interface SmppSessionHandler
    
    Parameters:
    pduResponse - The "unexpected" response PDU received on this session
  - fireUnrecoverablePduException
```
public void fireUnrecoverablePduException(UnrecoverablePduException e)
```
    Description copied from interface: SmppSessionHandler
    
    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.
    
    Specified by:
    
    fireUnrecoverablePduException in interface SmppSessionHandler
    
    Parameters:
    e - The exception
  - fireRecoverablePduException
```
public void fireRecoverablePduException(RecoverablePduException e)
```
    Description copied from interface: SmppSessionHandler
    
    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.
    
    Specified by:
    
    fireRecoverablePduException in interface SmppSessionHandler
    
    Parameters:
    e - The exception
  - fireUnknownThrowable
```
public void fireUnknownThrowable(Throwable t)
```
    Description copied from interface: SmppSessionHandler
    
    Called when any exception/throwable has been thrown downstream in the session's pipeline that wasn't of the types: UnrecoverablePduException or RecoverablePduException.
    
    Specified by:
    
    fireUnknownThrowable in interface SmppSessionHandler
  - fireChannelUnexpectedlyClosed
```
public void fireChannelUnexpectedlyClosed()
```
    Description copied from interface: SmppSessionHandler
    
    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.
    
    Specified by:
    
    fireChannelUnexpectedlyClosed in interface SmppSessionHandler
  - firePduRequestExpired
```
public void firePduRequestExpired(PduRequest pduRequest)
```
    Description copied from interface: SmppSessionHandler
    
    Called when a request PDU has not received an associated response within the expiry time. Usually, this means the request should be retried.
    
    Specified by:
    
    firePduRequestExpired in interface SmppSessionHandler
    
    Parameters:
    pduRequest - The request PDU received on this session

Class PollableSmppSessionHandler

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

PollableSmppSessionHandler

Method Detail

getReceivedPduRequests

getReceivedExpectedPduResponses

getReceivedUnexpectedPduResponses

getThrowables

getClosedCount

lookupResultMessage

lookupTlvTagName

firePduRequestReceived

fireExpectedPduResponseReceived

fireUnexpectedPduResponseReceived

fireUnrecoverablePduException

fireRecoverablePduException

fireUnknownThrowable

fireChannelUnexpectedlyClosed

firePduRequestExpired