smppex
v3.2.1

View Source SMPPEX.Pdu.Factory (smppex v3.2.1)

Module for convenient generation of the most common PDUs.

Link to this section Summary

Types

message()
message_state()

Functions

bind(command_name, opts)
bind(command_name, system_id, password, opts \\ %{})
bind_receiver(system_id, password, opts \\ %{})
bind_receiver_resp(command_status, system_id \\ "")
bind_resp(command_id, command_status, system_id)
bind_transceiver(system_id, password, opts \\ %{})
bind_transceiver_resp(command_status, system_id \\ "")
bind_transmitter(system_id, password, opts \\ %{})
bind_transmitter_resp(command_status, system_id \\ "")
deliver_sm(source, dest, message)
deliver_sm_resp(command_status \\ 0)
delivery_report(message_id, source, dest, message \\ "", message_state \\ :DELIVERED)
delivery_report_for_submit_sm(message_id, submit_sm, message \\ "", message_state \\ :DELIVERED)
enquire_link()
enquire_link_resp(command_status \\ 0)
submit_sm(source, dest, message, registered_delivery \\ 0)
submit_sm_resp(command_status, message_id \\ "")
unbind()
unbind_resp(command_status \\ 0)

Link to this section Types

Link to this type

message()

View Source 
@type message() :: String.t() | {data_coding :: non_neg_integer(), String.t()}
Link to this type

message_state()

View Source 
@type message_state() :: non_neg_integer() | atom()

Link to this section Functions

Link to this function

bind(command_name, opts)

View Source 
@spec bind(atom(), map()) :: SMPPEX.Pdu.t()
Link to this function

bind(command_name, system_id, password, opts \\ %{})

View Source 
@spec bind(atom(), String.t(), String.t(), map()) :: SMPPEX.Pdu.t()
Link to this function

bind_receiver(system_id, password, opts \\ %{})

View Source 
@spec bind_receiver(String.t(), String.t(), map()) :: SMPPEX.Pdu.t()
Link to this function

bind_receiver_resp(command_status, system_id \\ "")

View Source 
@spec bind_receiver_resp(non_neg_integer(), String.t()) :: SMPPEX.Pdu.t()
Link to this function

bind_resp(command_id, command_status, system_id)

View Source 
@spec bind_resp(non_neg_integer(), non_neg_integer(), String.t()) :: SMPPEX.Pdu.t()
Link to this function

bind_transceiver(system_id, password, opts \\ %{})

View Source 
@spec bind_transceiver(String.t(), String.t(), map()) :: SMPPEX.Pdu.t()
Link to this function

bind_transceiver_resp(command_status, system_id \\ "")

View Source 
@spec bind_transceiver_resp(non_neg_integer(), String.t()) :: SMPPEX.Pdu.t()
Link to this function

bind_transmitter(system_id, password, opts \\ %{})

View Source 
@spec bind_transmitter(String.t(), String.t(), map()) :: SMPPEX.Pdu.t()
Link to this function

bind_transmitter_resp(command_status, system_id \\ "")

View Source 
@spec bind_transmitter_resp(non_neg_integer(), String.t()) :: SMPPEX.Pdu.t()
Link to this function

deliver_sm(source, dest, message)

View Source 
@spec deliver_sm(
  SMPPEX.Pdu.addr() | String.t(),
  SMPPEX.Pdu.addr() | String.t(),
  message()
) ::
  SMPPEX.Pdu.t()
Link to this function

deliver_sm_resp(command_status \\ 0)

View Source 
@spec deliver_sm_resp(non_neg_integer()) :: SMPPEX.Pdu.t()
Link to this function

delivery_report(message_id, source, dest, message \\ "", message_state \\ :DELIVERED)

View Source 
@spec delivery_report(
  String.t(),
  SMPPEX.Pdu.addr(),
  SMPPEX.Pdu.addr(),
  String.t(),
  message_state()
) ::
  SMPPEX.Pdu.t()
Link to this function

delivery_report_for_submit_sm(message_id, submit_sm, message \\ "", message_state \\ :DELIVERED)

View Source 
@spec delivery_report_for_submit_sm(
  String.t(),
  SMPPEX.Pdu.t(),
  String.t(),
  message_state()
) ::
  SMPPEX.Pdu.t()
Link to this function

enquire_link()

View Source 
@spec enquire_link() :: SMPPEX.Pdu.t()
Link to this function

submit_sm(source, dest, message, registered_delivery \\ 0)

View Source 
@spec submit_sm(
  SMPPEX.Pdu.addr() | String.t(),
  SMPPEX.Pdu.addr() | String.t(),
  message(),
  non_neg_integer()
) :: SMPPEX.Pdu.t()
Link to this function

submit_sm_resp(command_status, message_id \\ "")

View Source 
@spec submit_sm_resp(non_neg_integer(), String.t()) :: SMPPEX.Pdu.t()
Link to this function

unbind()

View Source 
@spec unbind() :: SMPPEX.Pdu.t()
Link to this function

unbind_resp(command_status \\ 0)

View Source 
@spec unbind_resp(non_neg_integer()) :: SMPPEX.Pdu.t()