smpp-codec 0.2.1

[!WARNING] Disclaimer:Portions of this codebase were generated by Google's Gemini AI. While efforts have been made to ensure correctness, users should review and test the code thoroughly before using it in production environments.

Features

• PDU Support: Supports all PDU's as per SMPP v5.0 specifications.
• TLV Support: Includes a comprehensive list of Tag-Length-Value (TLV) optional parameters.
• Dependency: Built with standard library + rand.

Compatibility

The minimum supported Rust version (MSRV) is 1.63.0.

Usage

Add this to your Cargo.toml:

[dependencies]

smpp-codec = 0.2.1

Or

[dependencies]

smpp-codec = { git = "https://github.com/J93d/smpp-codec.git" }

Examples:

Binding as Transceiver

use smpp_codec::common::{BindMode, Ton, Npi};
use smpp_codec::pdus::BindRequest;

fn main() {
    let bind_req = BindRequest::new(
        1, // Sequence Number
        BindMode::Transceiver,
        "my_system_id".to_string(),
        "password".to_string(),
    ).with_address_range(Ton::International, Npi::Isdn, "12345".to_string());

    let mut buffer = Vec::new();
    match bind_req.encode(&mut buffer) {
        Ok(_) => {
            bind_req.encode(&mut buffer);    
            // Send `buffer` over TCP stream...
        }
        Err(e) => {
            eprintln!("Failed to encode: {:?}", e);
        }
    }
}

Submit Short Message

use smpp_codec::pdus::{SubmitSmRequest, MessageSplitter, SplitMode, EncodingType};

fn main() {
    let text = "Hello, world!".to_string();
    
    // 1. Split message (handles encoding and valid chunking)
    let (parts, data_coding) = MessageSplitter::split(
        text,
        EncodingType::Gsm7Bit, 
        SplitMode::Udh // Use UDH for concatenation
    ).expect("Failed to split message");

    // Iterate over parts and send each PDU
    for (i, part) in parts.into_iter().enumerate() {
        let mut submit_req = SubmitSmRequest::new(
            (i + 2) as u32, // Sequence Number
            "source_addr".to_string(),
            "dest_addr".to_string(),
            part,
        );
        submit_req.data_coding = data_coding; // Important: Set correct encoding!

        let mut buffer = Vec::new();
        submit_req.encode(&mut buffer).expect("Failed to encode PDU");
        // Send buffer...
    }
}

Deliver Short Message

use smpp_codec::pdus::{DeliverSmRequest, MessageSplitter, SplitMode, EncodingType};

fn main() {
    let text = "Incoming message...".to_string();
    
    // Split message
    let (parts, data_coding) = MessageSplitter::split(
        text,
        EncodingType::Gsm7Bit, 
        SplitMode::Udh 
    ).expect("Failed to split message");
    
    let parts_len = parts.len();

    for (i, part) in parts.into_iter().enumerate() {
        let mut deliver_req = DeliverSmRequest::new(
            (i + 100) as u32,
            "sender".to_string(),
            "shortcode".to_string(),
            part,
        );
        deliver_req.data_coding = data_coding;

        // CRITICAL: Set UDHI bit (0x40) if using UDH
        if parts_len > 1 {
            deliver_req.esm_class |= 0x40;
        }

        let mut buffer = Vec::new();
        deliver_req.encode(&mut buffer).expect("Failed to encode PDU");
        // Send buffer...
    }
}

Unbind

use smpp_codec::pdus::UnbindRequest;

fn main() {
    let unbind_req = UnbindRequest::new(3); // Sequence Number

    let mut buffer = Vec::new();
    unbind_req.encode(&mut buffer).expect("Failed to encode PDU");
}

Benchmark (cargo test --test benchmarks --release -- --nocapture)

License

This project is licensed under the Apache-2.0 license.