Module param_syntax

SMPP Parameter Syntax Library.

Copyright © 2003 - 2004 Enrique Marcote Peña

Version: 0.1, {21 Mar 2003} 11:56:47.

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

Description

SMPP Parameter Syntax Library.

Functions for the SMPP parameter syntax manipulation.

As a guideline and to help debugging, this preliminary version includes references to the specific section numbers on [SMPP 5.0]. These comments are likely to disappear on further versions.

Changes 0.1 -> 0.2

[17 Feb 2004]

References

[SMPP 5.0]
Short Message Peer-to-Peer Protocol Specification. Version 5.0. SMS Forum.

Function Index

chop_tlv/1Returns the leading Tlv and the Rest of a Binary.
decode/2Decodes a Value from a Binary using a ParameterType specifier.
encode/2Encodes a Value using a ParameterType specifier.
get_name/1Gets the name from a parameter type declaration.

Function Details

chop_tlv/1

chop_tlv(Binary) -> {ok, Tlv, Rest} | {error, Binary}

Returns the leading Tlv and the Rest of a Binary.

decode/2

decode(Binary, ParamType) -> {ok, Value, Rest} | {error, Error}

Decodes a Value from a Binary using a ParameterType specifier. Please refer to the functions decode_std/2 and decode_tlv/2 for further details.

See also: decode_std/2, decode_tlv/2.

encode/2

encode(Value, ParamType) -> {ok, Binary} | {error, Error}

Encodes a Value using a ParameterType specifier. Please refer to the functions encode_std/2 and encode_tlv/2 for further details.

See also: encode_std/2, encode_tlv/2.

get_name/1

get_name(ParamType) -> Name

Gets the name from a parameter type declaration.