cytechmobile/cloudhopper-smpp

Efficient, scalable, and flexible Java implementation of the Short Messaging Peer to Peer Protocol (SMPP)

Download

Step 1. Add the JitPack repository to your build file

Add it in your root settings.gradle at the end of repositories:

	dependencyResolutionManagement {
		repositoriesMode.set(RepositoriesMode.FAIL_ON_PROJECT_REPOS)
		repositories {
			mavenCentral()
			maven { url 'https://jitpack.io' }
		}
	}

Add it in your settings.gradle.kts at the end of repositories:

	dependencyResolutionManagement {
		repositoriesMode.set(RepositoriesMode.FAIL_ON_PROJECT_REPOS)
		repositories {
			mavenCentral()
			maven { url = uri("https://jitpack.io") }
		}
	}

Add to pom.xml

	<repositories>
		<repository>
		    <id>jitpack.io</id>
		    <url>https://jitpack.io</url>
		</repository>
	</repositories>

Add it in your build.sbt at the end of resolvers:

 
    resolvers += "jitpack" at "https://jitpack.io"

Add it in your project.clj at the end of repositories:

 
    :repositories [["jitpack" "https://jitpack.io"]]

Step 2. Add the dependency

	dependencies {
		implementation 'com.github.cytechmobile:cloudhopper-smpp:7.2.0'
	}

	dependencies {
		implementation("com.github.cytechmobile:cloudhopper-smpp:7.2.0")
	}

	<dependency>
	    <groupId>com.github.cytechmobile</groupId>
	    <artifactId>cloudhopper-smpp</artifactId>
	    <version>7.2.0</version>
	</dependency>


                            
    libraryDependencies += "com.github.cytechmobile" % "cloudhopper-smpp" % "7.2.0"


                            
    :dependencies [[com.github.cytechmobile/cloudhopper-smpp "7.2.0"]]

Readme

Cloudhopper SMPP (forked from Twitter)

News

Oct 2017

Since development on netty4 branch is not following up latest releases, this project is forked here with a focus on the netty 4 release.

Nov 2016

While Fizzed, Inc. took over from Twitter for a while, there is now an apparent lack of commits on the original repository for almost a year and PR pending reviews for more than 6 months. The project was forked here and will be updated regularly as it is being used in Restcomm SMSC

Nov 2015

While Twitter still relies exclusively on ch-smpp for its global SMS infrastructure, Twitter stopped supporting this opensource project as of October 2015. Fizzed, Inc. was the only company maintaining it, so any new support & development will occur here in its new home.

Overview

Efficient, scalable, rock-solid, and flexible Java implementation of the Short Messaging Peer to Peer Protocol (SMPP).

Real-world used library by Twitter across nearly every SMSC vendor and mobile operator around the world. We've seen almost every variance in the SMPP protocol and this library handles it flawlessly.
Rigorous unit testing
Support for SMPP protocol:
- Version 3.3
- Version 3.4
- Most of version 5.0
Uses non-blocking (NIO) sockets (via underlying Netty dependency, one thread can support 1 or more SMPP sessions)
Can support thousands of binds/connections using minimal resources and threads
Supports both client and server modes of the SMPP protocol (yes you can write your own SMPP server using this library as well as be a client to one)
Supports synchronous request mode (send request and block until response received)
Supports asynchronous request mode (send request, get a future response, and then decide when you'd like to wait/get a response)
Advanced support for SMPP "windowing":
- Configurable window size per session
- Waiting for a window slot to open up
- Get a list of unacknowledged/in-flight PDUs if session disconnects
SSL/TLS support for clients and servers
Configurable support for expiry of unacknowledged PDUs
Configurable counter metrics per client-session, server-session, or server.
Support for sniffing/logging/discarding of PDUs before normal processing

The library has been tested and certified with hundreds of mobile operators and suppliers around the world. It's effective at being flexible with SMPP specifications that aren't truly compliant.

Background and Contributors

This library was originally developed by Cloudhopper, Inc. in 2008. Cloudhopper was acquired by Twitter in April 2010. The main author of this library, Joe Lauer, left Twitter in April 2013 to found Fizzed, Inc. As of Nov 2015, Fizzed, Inc is the official maintainer of the library. If you're looking for commercial support, please contact Fizzed.

Joe Lauer (Twitter: @jjlauer)
Garth (Twitter: @trg)

Installation

Library is available via maven central

<dependency>
  <groupId>com.fizzed</groupId>
  <artifactId>ch-smpp</artifactId>
  <version>5.0.9</version>
</dependency>

Demo Code / Tutorials

There are numerous examples of how to use various parts of this library:

src/test/java/com/cloudhopper/smpp/demo/

To run some of the samples, there is a Makefile to simplify the syntax required by Maven:

make client
make server
make performance-client
make simulator
make rebind
make parser
make dlr
make ssl-client
make ssl-server
make persist-client
make server-echo

On Windows, the examples can run with nmake instead of make.

The easiest way to get started is to try out our server and client or ssl-server and ssl-client examples. Open up two shells. In the first shell, run:

make server

In the second shell, run:

make client

You'll see the client bind to the server and a few different type of requests exchanged back and forth.

You can also try make persist-client instead of make client which demonstrates a persistent SMPP connection.

make server-echo will echo back any MT as an MO. This makes it easier to test handling of MO messages.

User Contributed Demos

A more complete persistent client demo:

(https://github.com/krasa/cloudhopper-smpp/tree/persistent-connection/src/test/java/com/cloudhopper/smpp/demo/persist)

A tutorial in Russian:

https://github.com/wizardjedi/my-spring-learning/wiki/Twitter-cloudhopper

Please let us know if you have other tutorials worth mentioning!

License

This work is licensed under the Apache License, Version 2.0. See LICENSE for details.