smpp

README

go-smpp

A complete implementation of SMPP v5 protocol, written in golang.

Key features

• Message encoding auto-detection
• Multipart SMS automatic splitting and concatenating

Supported encodings:

• GSM 7Bit
• ASCII
• Latin-1
• Cyrillic
• Hebrew
• Shift-JIS
• ISO-2022-JP
• EUC-JP
• EUC-KR
• UCS-2

Caveats

• Please read the SMPP Specification Version 5 first. pdu is not limited to any value range.
• If you do not like the default conn.go implementation, you can easily replace it.
• Device-specific Caveats

Command line tools

1. smpp-receiver
   SMPP Simple Receiver tool

2. smpp-repl
   SMPP Simple Test tool

Example

1. Connect to the Remote (SMPP server)

   parent, err := net.Dial("tcp", "m2m-device:2775")
   if err != nil {
       panic(err)
   }
   conn = smpp.NewConn(context.Background(), parent)
   conn.WriteTimeout = n * time.Second // set write timeout (optional, default 15 minutes)
   conn.ReadTimeout =  n * time.Second // set read timeout  (optional, default 15 minutes)
   go conn.Watch()                     // start watchdog
   

2. Handshake

   resp, err := conn.Submit(context.Background(), &pdu.BindTransceiver{
       SystemID:   "your system id",
       Password:   "your password",
       SystemType: "your system type",
       Version:    pdu.SMPPVersion50,
   })
   if err != nil {
       panic(err)
   }
   r := resp.(*pdu.BindTransceiverResp)
   if r.Header.CommandStatus == 0 {
       // start keep-alive
       go conn.EnquireLink(time.Minute, time.Minute)
   }
   

3. Send Message

   packet := &pdu.SubmitSM{
       SourceAddr: pdu.Address{TON: 1, NPI: 1, No: "00919821"},
       DestAddr:   pdu.Address{TON: 1, NPI: 1, No: "99919821"},
   }
   err := packet.Message.Compose("Hello World!")
   if err != nil {
       panic(err)
   }
   resp, err := conn.Submit(context.Background(), packet)
   if err != nil {
       panic(err)
   }
   resp // submit_sm_resp returns
   

4. Event loop for receiving messages

   for {
       packet := <-conn.PDU()
       // reply a responsable packet
       if p, ok := packet.(pdu.Responsable); ok {
           err := conn.Send(p.Resp())
           if err != nil {
               fmt.Println(err)
           }
       }
   }
   

LICENSE

This piece of software is released under the MIT license.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

Documentation

Index

• Variables
• func WatchListener(listener net.Listener, on func(*Conn)) (err error)
• type Conn
  • func NewConn(ctx context.Context, parent net.Conn) *Conn
  • func (c *Conn) Close() (err error)
  • func (c *Conn) EnquireLink(tick time.Duration, timeout time.Duration)
  • func (c *Conn) PDU() <-chan interface{}
  • func (c *Conn) Send(packet interface{}) (err error)
  • func (c *Conn) Submit(ctx context.Context, packet Responsable) (resp interface{}, err error)
  • func (c *Conn) Watch()

Variables

var (
	ErrConnectionClosed = errors.New("smpp: connection closed")
)

Functions

func WatchListener

func WatchListener(listener net.Listener, on func(*Conn)) (err error)

Types

type Conn

type Conn struct {
	NextSequence func() int32
	ReadTimeout  time.Duration
	WriteTimeout time.Duration
	// contains filtered or unexported fields
}

func NewConn

func NewConn(ctx context.Context, parent net.Conn) *Conn

func (*Conn) Close

func (c *Conn) Close() (err error)

func (*Conn) EnquireLink

func (c *Conn) EnquireLink(tick time.Duration, timeout time.Duration)

func (*Conn) PDU

func (c *Conn) PDU() <-chan interface{}

func (*Conn) Send

func (c *Conn) Send(packet interface{}) (err error)

func (*Conn) Submit

func (c *Conn) Submit(ctx context.Context, packet Responsable) (resp interface{}, err error)

func (*Conn) Watch

func (c *Conn) Watch()