com.cloudhopper.smpp.impl

Class DefaultSmppClient

java.lang.Object

com.cloudhopper.smpp.impl.DefaultSmppClient

All Implemented Interfaces:

SmppClient

public class DefaultSmppClient
extends Object
implements SmppClient

Default implementation to "bootstrap" client SMPP sessions (create & bind).

Author:

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

Constructor Summary

Constructors

Constructor and Description
DefaultSmppClient() Creates a new default SmppClient.
DefaultSmppClient(ExecutorService executors) Creates a new default SmppClient.
DefaultSmppClient(ExecutorService executors, int expectedSessions) Creates a new default SmppClient.
DefaultSmppClient(ExecutorService executors, int expectedSessions, ScheduledExecutorService monitorExecutor) Creates a new default SmppClient.

Method Summary

Methods

Modifier and Type	Method and Description
SmppSession	bind(SmppSessionConfiguration config)
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.
protected BaseBind	createBindRequest(SmppSessionConfiguration config)
protected org.jboss.netty.channel.Channel	createConnectedChannel(String host, int port, long connectTimeoutMillis)
protected DefaultSmppSession	createSession(org.jboss.netty.channel.Channel channel, SmppSessionConfiguration config, SmppSessionHandler sessionHandler)
void	destroy() Destroy a client by ensuring that all session sockets are closed and all resources are cleaned up.
protected void	doBind(DefaultSmppSession session, SmppSessionConfiguration config, SmppSessionHandler sessionHandler)
protected DefaultSmppSession	doOpen(SmppSessionConfiguration config, SmppSessionHandler sessionHandler)
int	getConnectionSize()

Methods inherited from class java.lang.Object

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

Constructor Detail

DefaultSmppClient

public DefaultSmppClient()

Creates a new default SmppClient. Window monitoring and automatic expiration of requests will be disabled with no monitorExecutors. The maximum number of IO worker threads across any client sessions created with this SmppClient will be Runtime.getRuntime().availableProcessors(). An Executors.newCachedDaemonThreadPool will be used for IO worker threads.

DefaultSmppClient

public DefaultSmppClient(ExecutorService executors)

Creates a new default SmppClient. Window monitoring and automatic expiration of requests will be disabled with no monitorExecutors. The maximum number of IO worker threads across any client sessions created with this SmppClient will be Runtime.getRuntime().availableProcessors().

Parameters:

executor - The executor that IO workers will be executed with. An Executors.newCachedDaemonThreadPool() is recommended. The max threads will never grow more than expectedSessions if NIO sockets are used.

DefaultSmppClient

public DefaultSmppClient(ExecutorService executors,
                 int expectedSessions)

Creates a new default SmppClient. Window monitoring and automatic expiration of requests will be disabled with no monitorExecutors.

Parameters:

executor - The executor that IO workers will be executed with. An Executors.newCachedDaemonThreadPool() is recommended. The max threads will never grow more than expectedSessions if NIO sockets are used.

expectedSessions - The max number of concurrent sessions expected to be active at any time. This number controls the max number of worker threads that the underlying Netty library will use. If processing occurs in a sessionHandler (a blocking op), be VERY careful setting this to the correct number of concurrent sessions you expect.

DefaultSmppClient

public DefaultSmppClient(ExecutorService executors,
                 int expectedSessions,
                 ScheduledExecutorService monitorExecutor)

Creates a new default SmppClient.

Parameters:

executor - The executor that IO workers will be executed with. An Executors.newCachedDaemonThreadPool() is recommended. The max threads will never grow more than expectedSessions if NIO sockets are used.

expectedSessions - The max number of concurrent sessions expected to be active at any time. This number controls the max number of worker threads that the underlying Netty library will use. If processing occurs in a sessionHandler (a blocking op), be VERY careful setting this to the correct number of concurrent sessions you expect.

monitorExecutor - The scheduled executor that all sessions will share to monitor themselves and expire requests. If null monitoring will be disabled.

Method Detail

getConnectionSize

public int getConnectionSize()

destroy

public void destroy()

Description copied from interface: SmppClient

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.

Specified by:

destroy in interface SmppClient

createBindRequest

protected BaseBind createBindRequest(SmppSessionConfiguration config)
                              throws UnrecoverablePduException

Throws:

UnrecoverablePduException

bind

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

Throws:

SmppTimeoutException

SmppChannelException

SmppBindException

UnrecoverablePduException

InterruptedException

bind

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

Description copied from interface: SmppClient

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

Specified by:

bind in interface SmppClient

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.

doBind

protected void doBind(DefaultSmppSession session,
          SmppSessionConfiguration config,
          SmppSessionHandler sessionHandler)
               throws SmppTimeoutException,
                      SmppChannelException,
                      SmppBindException,
                      UnrecoverablePduException,
                      InterruptedException

Throws:

SmppTimeoutException

SmppChannelException

SmppBindException

UnrecoverablePduException

InterruptedException

doOpen

protected DefaultSmppSession doOpen(SmppSessionConfiguration config,
                        SmppSessionHandler sessionHandler)
                             throws SmppTimeoutException,
                                    SmppChannelException,
                                    InterruptedException

Throws:

SmppTimeoutException

SmppChannelException

InterruptedException

createSession

protected DefaultSmppSession createSession(org.jboss.netty.channel.Channel channel,
                               SmppSessionConfiguration config,
                               SmppSessionHandler sessionHandler)
                                    throws SmppTimeoutException,
                                           SmppChannelException,
                                           InterruptedException

Throws:

SmppTimeoutException

SmppChannelException

InterruptedException

createConnectedChannel

protected org.jboss.netty.channel.Channel createConnectedChannel(String host,
                                                     int port,
                                                     long connectTimeoutMillis)
                                                          throws SmppTimeoutException,
                                                                 SmppChannelException,
                                                                 InterruptedException

Throws:

SmppTimeoutException

SmppChannelException

InterruptedException