Module iso8583_erl

iso8583_erl module.

Copyright © Nuku Ameyibor <nayibor@startmail.com>

Description

iso8583_erl module.
this module is the api for library

Function Index

create_bitmap/2for creating the bitmap of a message.
get_bitmap_subs/3for getting the bitmap,mti,Data fields of an iso message.
get_bitmap_type/1gets the bitmap type from a specification.
get_field/2this is for getting a particular field in an iso message back.
get_size/2for getting the size of a bitmap or an iolist of fields.
get_size_send/2
get_spec_field/2gets the specification for a particular field.
load_specification/1creats a specification which contains the various data elements and their specifications from a spec file.
pack/2for packing messages into an iolist format.
process_data_element/4for processing the message given the bitmap and the binary containing the data elements.
set_field/3for setting the fields for an iso message.
set_field_list/1for setting a list of fields.
set_mti/2for setting the a single field for an iso message.
unpack/2for unpacking messages into a map object.

Function Details

create_bitmap/2

create_bitmap(Type_bitmap::binary | hex, Bitmap_final_bit::binary()) -> binary() | list()

for creating the bitmap of a message

get_bitmap_subs/3

get_bitmap_subs(Bitmap_type::atom(), Bin_message::binary(), Specification::map()) -> tuple()

for getting the bitmap,mti,Data fields of an iso message

get_bitmap_type/1

get_bitmap_type(Specification::map()) -> hex | binary

gets the bitmap type from a specification

get_field/2

get_field(Fld_num::pos_integer() | binary(), Iso_Map::map()) -> {ok, term()} | error

this is for getting a particular field in an iso message back

get_size/2

get_size(Type, Value) -> integer()

for getting the size of a bitmap or an iolist of fields

get_size_send/2

get_size_send(Fields_iolist::iolist(), Length_max_size::non_neg_integer()) -> list()

get_spec_field/2

get_spec_field(Field::non_neg_integer(), Specification::map()) -> tuple()

gets the specification for a particular field

load_specification/1

load_specification(Filename::string() | binary()) -> map()

creats a specification which contains the various data elements and their specifications from a spec file

pack/2

pack(Map_pack, Specification) -> list() | {error, term()}

for packing messages into an iolist format

process_data_element/4

process_data_element(Bitmap::binary(), Index_start::integer(), Data_binary::binary(), Specification::map()) -> map()

for processing the message given the bitmap and the binary containing the data elements

set_field/3

set_field(Iso_Map::map(), Fld_num::pos_integer(), Fld_val::term()) -> {ok, map()} | {error, term()}

for setting the fields for an iso message

set_field_list/1

set_field_list(List::list()) -> map()

for setting a list of fields

set_mti/2

set_mti(Iso_Map::map(), Fld_val::term()) -> {ok, map()} | {error, term()}

for setting the a single field for an iso message

unpack/2

unpack(IsoMessage, Specification) -> map() | {error, any()}

for unpacking messages into a map object


Generated by EDoc