dbus_marshaller.md

Module dbus_marshaller

• Description
• Function Index
• Function Details

D-Bus binary format (un)marshaling.

Copyright (c) 2006-2007 Mikael Magnusson, 2014-2106 Jean Parpaillon

Authors: Mikael Magnusson (mikma@users.sourceforge.net), Jean Parpaillon (jean.parpaillon@free.fr).

Description

See D-Bus Specification.

Function Index

marshal_list/2	Encode objects, given a signature.
marshal_message/1	Encode a message.
marshal_signature/1	Encode a signature.
unmarshal_data/1	Decode messages.
unmarshal_signature/1	Decode a signature.

Function Details

marshal_list/2

marshal_list(Types::dbus_signature(), Value::term()) -> iolist()

Encode objects, given a signature

marshal_message/1

marshal_message(Dbus_message::dbus_message()) -> iolist()

Encode a message

marshal_signature/1

marshal_signature(R::dbus_signature()) -> iolist()

Encode a signature

unmarshal_data/1

unmarshal_data(Data::binary()) -> {ok, Msgs::[dbus_message()], Rest::binary()} | more

Decode messages

Returns:

• {ok, [dbus_message()], binary()}: if binary describe a complete list of messages, eventually with remaining binary.
• more: if no complete message could be decoded.

unmarshal_signature/1

unmarshal_signature(Bin::binary()) -> {ok, dbus_signature()} | more

Decode a signature

Returns more if no complete signature could be decoded.