Module operation

Copyright © 2003 - 2004 Enrique Marcote Peña

• Description
• Function Index
• Function Details

Version: 1.0, {24 May 2003} 11:56:47.

Authors: Enrique Marcote Peña (mpquique_at_users.sourceforge.net) [web site: http://oserl.sourceforge.net/].

Description

SMPP Operation PDU definitions.

Changes 0.1 -> 0.2

• Implemented get_param/2 and set_param/3, replacements for pdu_syntax:get_value/2 and pdu_syntax:set_value/3 respectively.

• new_pdu/5 function removed. PDU defaults MACROS do no longer exist.

• pack/1, pack_esme/1, pack_smsc/1, unpack/1, unpack_esme/1 and unpack_smsc/1 functions redefined.

Changes 0.2 -> 1.0

• pack_mc/1 is now called pack_smsc/1.
• unpack_mc/1 is now called unpack_smsc/1.

• new_xxx/2 and new_xxx/3 functions removed. See generic functions new/3 and new/4 below.
• request_command_id/1 and response_command_id/1 redefined as macros in smpp_globals.hrl.

Function Index

Function Details

esme_pack/1

esme_pack(Pdu) -> Result

• Pdu = pdu()
• Result = {ok, BinaryPdu} | {error, CommandId, CommandStatus, SequenceNumber}
• BinaryPdu = bin()
• Error = int()
• CommandId = undefined | int()
• CommandStatus = int()
• SequenceNumber = int()

Packs an SMPP PDU dictionary into the corresponding byte stream.

This function is optimized for ESME implementations, thus only handles operations issued by an ESME, any other PDU generates an ?ESME_RINVCMDID error code.

See also: pdu_syntax:pack/2.

esme_unpack/1

esme_unpack(BinaryPdu) -> Result

• BinaryPdu = bin()
• Result = {ok, Pdu} | {error, CommandId, CommandStatus, SequenceNumber}
• Pdu = pdu()
• CommandId = undefined | int()
• CommandStatus = int()
• SequenceNumber = int()

Unpacks a binary SMPP PDU into the corresponding PDU dictionary.

This function is optimized for ESME implementation, thus only capable of unpacking PDUs issued by a SMSC, any other PDU produces an ?ESME_RINVCMDID error code.

See also: pdu_syntax:unpack/2.

from_list/1

from_list(List) -> Pdu

• List = [{ParamName, ParamValue}]
• ParamName = atom()
• ParamValue = term()
• Pdu = pdu()

Converts the Pdu to a list representation.

Notice that command_length is automatically added by packing functions, thus should not be included on the List.

get_param/2

get_param(ParamName, Pdu) -> ParamValue

• ParamName = atom()
• Pdu = pdu()
• ParamValue = term()

Gets the value of a parameter from a PDU dictionary given the parameter name. If the parameter is not defined on the PDU the atom undefined is returned.

merge_params/2

merge_params(ParamList1, ParamList2) -> NewParamList

• ParamList1 = [{ParamName, ParamValue}]
• ParamList2 = [{ParamName, ParamValue}]
• NewParamList = [{ParamName, ParamValue}]
• ParamName = atom()
• ParamValue = term()

Merge two parameter lists. If an parameter appears on both lists, the value from the first list will be taken.

new/3

new(CommandId, SequenceNumber, InitParams) -> Pdu

• CommandId = int()
• SequenceNumber = int()
• InitParams = [{ParamName, ParamValue}]
• ParamName = atom()
• ParamValue = term()
• Pdu = pdu()

Creates a new PDU dictionary of type PdyType with the given InitParams and the default values defined for this PDU.

The command_status is set to ESME_ROK.

See also: new/4.

new/4

new(CommandId, CommandStatus, SequenceNumber, InitParams) -> Pdu

• CommandId = int()
• CommandStatus = int()
• SequenceNumber = int()
• InitParams = [{ParamName, ParamValue}]
• ParamName = atom()
• ParamValue = term()
• Pdu = pdu()

Creates a new PDU dictionary of type PdyType with the given InitParams and the default values defined for this PDU.

The command_status is set to CommandStatus.

See also: new/3.

pack/1

pack(Pdu) -> Result

• Pdu = pdu()
• Result = {ok, BinaryPdu} | {error, CommandId, CommandStatus, SequenceNumber}
• BinaryPdu = bin()
• Error = int()
• CommandId = undefined | int()
• CommandStatus = int()
• SequenceNumber = int()

Packs any SMPP PDU dictionary into the corresponding byte stream. This function handles any operation.

Before using this function consider esme_pack/1 or smsc_pack/1. This generic packing function should only be used on special occasions (implementing a Routing Entity).

See also: esme_pack/1, smsc_pack/1, pdu_syntax:pack/2.

request_failure_code/1

request_failure_code(CommandId) -> CommandStatus

• CommandId = int()
• CommandStatus = int()

Returns the error status code associated to a request failure (Most of the requests have a generic failure code, otherwise ?ESME_RUNKNOWNERR is returned).

set_param/3

set_param(ParamName, ParamValue, Pdu) -> NewPdu

• ParamName = atom()
• ParamValue = term()
• Pdu = pdu()
• NewPdu = pdu()

Sets the value of a parameter on a PDU dictionary given the parameter name, the new PDU dictionary is returned.

smsc_pack/1

smsc_pack(Pdu) -> Result

• Pdu = pdu()
• Result = {ok, BinaryPdu} | {error, CommandId, CommandStatus, SequenceNumber}
• BinaryPdu = bin()
• Error = int()
• CommandId = undefined | int()
• CommandStatus = int()
• SequenceNumber = int()

Packs an SMPP PDU dictionary into the corresponding byte stream.

This function is optimized for SMSC implementations, thus only handles operations issued by an SMSC, any other PDU generates an ?ESME_RINVCMDID error code.

See also: pdu_syntax:pack/2.

smsc_unpack/1

smsc_unpack(BinaryPdu) -> Result

• BinaryPdu = bin()
• Result = {ok, Pdu} | {error, CommandId, CommandStatus, SequenceNumber}
• Pdu = pdu()
• CommandId = undefined | int()
• CommandStatus = int()
• SequenceNumber = int()

Equivalent to unpack(BinaryPdu, ESME_ISSUED_OPERATIONS).

Unpacks a binary SMPP PDU into the corresponding PDU dictionary.

This function is optimized for SMSC implementation, thus only capable of unpacking PDUs issued by an ESME, any other PDU produces an ?ESME_RINVCMDID error code.

See also: unpack/2.

to_list/1

to_list(Pdu) -> List

• Pdu = pdu()
• List = [{ParamName, ParamValue}]
• ParamName = atom()
• ParamValue = term()

Converts the Pdu to a list representation.

Notice that command_length won't be included on the resulting List.

unpack/1

unpack(BinaryPdu) -> Result

• BinaryPdu = bin()
• Result = {ok, Pdu} | {error, CommandId, CommandStatus, SequenceNumber}
• Pdu = pdu()
• CommandId = undefined | int()
• CommandStatus = int()
• SequenceNumber = int()

Unpacks a binary SMPP PDU into the corresponding PDU dictionary. This function handles any operation.

Before using this function consider esme_unpack/1 or smsc_unpack/1. This generic unpacking function should only be used on very special occasions (such us implementing a Routing Entity).

See also: esme_unpack/1, smsc_unpack/1, pdu_syntax:unpack/2.