com.cloudhopper.smpp

Interface SmppClient

All Known Implementing Classes:

DefaultSmppClient

public interface SmppClient

Interface representing an SmppClient.

Author:

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

Method Summary

Methods

Modifier and Type	Method and Description
SmppSession	bind(SmppSessionConfiguration config, SmppSessionHandler sessionHandler) Binds a client to a remote SMPP endpoint by opening the socket, sending a bind request, and waiting for a bind response.
void	destroy() Destroy a client by ensuring that all session sockets are closed and all resources are cleaned up.

Method Detail

bind

SmppSession bind(SmppSessionConfiguration config,
               SmppSessionHandler sessionHandler)
                 throws SmppTimeoutException,
                        SmppChannelException,
                        SmppBindException,
                        UnrecoverablePduException,
                        InterruptedException

Binds a client to a remote SMPP endpoint by opening the socket, sending a bind request, and waiting for a bind response.

Parameters:

config - The client session configuration

sessionHandler - The session handler

Returns:

If the bind is successful will be the new session

Throws:

SmppTimeoutException - Thrown if either the underlying TCP/IP connection cannot connect within the "connectTimeout" or we can connect but don't receive a response back to the bind request within the "bindTimeout".

SmppChannelException - Thrown if there is an error with the underlying TCP/IP connection such as a bad host name or the remote server's port is not accepting connections.

SmppBindException - Thrown only in the case where the "bind" request was successfully sent to the remote system and we actually got back a "bind" response that rejected the bind attempt.

UnrecoverablePduException - Thrown in the case where we were able to connect and send our "bind" request, but we got back data that was not failed parsing into a PDU.

InterruptedException - Thrown if the calling thread is interrupted while we are attempting the bind.

destroy

void destroy()

Destroy a client by ensuring that all session sockets are closed and all resources are cleaned up. This method should the last method called before discarding or losing a reference to a client. Since this method cleans up all resources, make sure that any data you need to access is accessed before calling this method. After calling this method it is not guaranteed that any other method will correctly work.