Skip to main content

AlertNotification

Struct AlertNotification 

Source
pub struct AlertNotification {
    pub sequence_number: u32,
    pub source_addr_ton: Ton,
    pub source_addr_npi: Npi,
    pub source_addr: String,
    pub esme_addr_ton: Ton,
    pub esme_addr_npi: Npi,
    pub esme_addr: String,
    pub optional_params: Vec<Tlv>,
}
Expand description

Represents an Alert Notification PDU.

Sent by the SMSC to the ESME to provide information about a message state (e.g., delivered).

Fields§

§sequence_number: u32§source_addr_ton: Ton§source_addr_npi: Npi§source_addr: String§esme_addr_ton: Ton§esme_addr_npi: Npi§esme_addr: String§optional_params: Vec<Tlv>

Implementations§

Source§

impl AlertNotification

Source

pub fn new(sequence_number: u32, source_addr: String, esme_addr: String) -> Self

Create a new Alert Notification.

§Examples
use smpp_codec::pdus::AlertNotification;

let sequence_number: u32 = 1;
let alert = AlertNotification::new(
    sequence_number,
    "source_addr".to_string(),
    "esme_addr".to_string()
);
Examples found in repository?
examples/alert_notification.rs (lines 9-13)
5fn main() {
6    println!("=== SMPP Alert Notification Example ===");
7
8    // 1. Create Alert Notification
9    let mut alert = AlertNotification::new(
10        200, // Sequence number
11        "source_addr".to_string(),
12        "esme_addr".to_string(),
13    )
14    .with_source_addr(Ton::International, Npi::Isdn, "123".to_string())
15    .with_esme_addr(Ton::National, Npi::Telex, "456".to_string());
16
17    // 2. Add optional TLV (e.g., ms_availability_status)
18    // Tag 0x0402 is ms_availability_status
19    let tlv = Tlv::new_u8(0x0402, 1); // 1 = Available
20    alert.add_tlv(tlv);
21
22    println!("Alert Notification: {:?}", alert);
23
24    // 3. Encode
25    let mut buf = Vec::new();
26    alert.encode(&mut buf).unwrap();
27    println!("Encoded {} bytes", buf.len());
28}
Source

pub fn with_source_addr(self, ton: Ton, npi: Npi, addr: String) -> Self

Examples found in repository?
examples/alert_notification.rs (line 14)
5fn main() {
6    println!("=== SMPP Alert Notification Example ===");
7
8    // 1. Create Alert Notification
9    let mut alert = AlertNotification::new(
10        200, // Sequence number
11        "source_addr".to_string(),
12        "esme_addr".to_string(),
13    )
14    .with_source_addr(Ton::International, Npi::Isdn, "123".to_string())
15    .with_esme_addr(Ton::National, Npi::Telex, "456".to_string());
16
17    // 2. Add optional TLV (e.g., ms_availability_status)
18    // Tag 0x0402 is ms_availability_status
19    let tlv = Tlv::new_u8(0x0402, 1); // 1 = Available
20    alert.add_tlv(tlv);
21
22    println!("Alert Notification: {:?}", alert);
23
24    // 3. Encode
25    let mut buf = Vec::new();
26    alert.encode(&mut buf).unwrap();
27    println!("Encoded {} bytes", buf.len());
28}
Source

pub fn with_esme_addr(self, ton: Ton, npi: Npi, addr: String) -> Self

Examples found in repository?
examples/alert_notification.rs (line 15)
5fn main() {
6    println!("=== SMPP Alert Notification Example ===");
7
8    // 1. Create Alert Notification
9    let mut alert = AlertNotification::new(
10        200, // Sequence number
11        "source_addr".to_string(),
12        "esme_addr".to_string(),
13    )
14    .with_source_addr(Ton::International, Npi::Isdn, "123".to_string())
15    .with_esme_addr(Ton::National, Npi::Telex, "456".to_string());
16
17    // 2. Add optional TLV (e.g., ms_availability_status)
18    // Tag 0x0402 is ms_availability_status
19    let tlv = Tlv::new_u8(0x0402, 1); // 1 = Available
20    alert.add_tlv(tlv);
21
22    println!("Alert Notification: {:?}", alert);
23
24    // 3. Encode
25    let mut buf = Vec::new();
26    alert.encode(&mut buf).unwrap();
27    println!("Encoded {} bytes", buf.len());
28}
Source

pub fn add_tlv(&mut self, tlv: Tlv)

Add a generic TLV

Examples found in repository?
examples/alert_notification.rs (line 20)
5fn main() {
6    println!("=== SMPP Alert Notification Example ===");
7
8    // 1. Create Alert Notification
9    let mut alert = AlertNotification::new(
10        200, // Sequence number
11        "source_addr".to_string(),
12        "esme_addr".to_string(),
13    )
14    .with_source_addr(Ton::International, Npi::Isdn, "123".to_string())
15    .with_esme_addr(Ton::National, Npi::Telex, "456".to_string());
16
17    // 2. Add optional TLV (e.g., ms_availability_status)
18    // Tag 0x0402 is ms_availability_status
19    let tlv = Tlv::new_u8(0x0402, 1); // 1 = Available
20    alert.add_tlv(tlv);
21
22    println!("Alert Notification: {:?}", alert);
23
24    // 3. Encode
25    let mut buf = Vec::new();
26    alert.encode(&mut buf).unwrap();
27    println!("Encoded {} bytes", buf.len());
28}
Source

pub fn encode(&self, writer: &mut impl Write) -> Result<(), PduError>

Encode the struct into raw bytes for the network.

§Errors

Returns a PduError if:

  • source_addr exceeds 65 characters.
  • esme_addr exceeds 65 characters.
  • An I/O error occurs while writing.
§Examples
let mut buffer = Vec::new();
alert.encode(&mut buffer).expect("Encoding failed");
Examples found in repository?
examples/alert_notification.rs (line 26)
5fn main() {
6    println!("=== SMPP Alert Notification Example ===");
7
8    // 1. Create Alert Notification
9    let mut alert = AlertNotification::new(
10        200, // Sequence number
11        "source_addr".to_string(),
12        "esme_addr".to_string(),
13    )
14    .with_source_addr(Ton::International, Npi::Isdn, "123".to_string())
15    .with_esme_addr(Ton::National, Npi::Telex, "456".to_string());
16
17    // 2. Add optional TLV (e.g., ms_availability_status)
18    // Tag 0x0402 is ms_availability_status
19    let tlv = Tlv::new_u8(0x0402, 1); // 1 = Available
20    alert.add_tlv(tlv);
21
22    println!("Alert Notification: {:?}", alert);
23
24    // 3. Encode
25    let mut buf = Vec::new();
26    alert.encode(&mut buf).unwrap();
27    println!("Encoded {} bytes", buf.len());
28}
Source

pub fn decode(buffer: &[u8]) -> Result<Self, PduError>

Decode raw bytes from the network into the struct.

§Errors

Returns a PduError if:

  • The buffer is too short.
  • The buffer data is malformed.
§Examples
let decoded = AlertNotification::decode(&buffer).expect("Decoding failed");
assert_eq!(decoded.source_addr, "src");

Trait Implementations§

Source§

impl Clone for AlertNotification

Source§

fn clone(&self) -> AlertNotification

Returns a duplicate of the value. Read more
1.0.0 · Source§

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source. Read more
Source§

impl Debug for AlertNotification

Source§

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter. Read more

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<V, T> VZip<V> for T
where V: MultiLane<T>,

Source§

fn vzip(self) -> V