Build messages.
Copyright (c) 2006-2007 Mikael Magnusson, 2014-2016 Jean Parpaillon
Authors: Mikael Magnusson (mikma@users.sourceforge.net
), Jean Parpaillon (jean.parpaillon@free.fr
).
type() = '?TYPE_INVALID' | '?TYPE_METHOD_CALL' | '?TYPE_METHOD_RETURN' | '?TYPE_ERROR' | '?TYPE_SIGNAL'
call/4 | Equivalent to call(Destination, Path, Interface, Member, []). |
call/5 | Build a method call message. |
error/3 | Build an error message. |
find_field/2 | Find a specific field of a message. |
get_field/2 | Get a specific field of a message. |
get_field_value/2 | Get a field value. |
get_serial/1 | Get serial number from message. |
introspect/2 | Build Introspect method call message. |
is_error/2 | Check message is an error and of the given type. |
match/2 | Check message headers matches some values. |
return/3 | Build a return message. |
set_body/3 | Set body of a message. |
set_body/4 | Set body of a message. |
set_serial/2 | Set serial number of a message. |
signal/5 | Equivalent to signal(Destination, Path, Interface, Signal, Args, []). |
signal/6 | Build a signal message. |
type/1 | Get message type. |
call(Destination::dbus_name(), Path::dbus_name(), Interface::dbus_name(), Member::dbus_name() | dbus_method()) -> dbus_message()
Equivalent to call(Destination, Path, Interface, Member, [])
.
call(Destination::dbus_name(), Path::dbus_name(), Interface::dbus_name(), Member::dbus_name() | dbus_method(), Opts::[dbus_option()]) -> dbus_message()
Build a method call message
error(Orig::dbus_message(), ErrName::binary(), ErrText::binary()) -> dbus_message()
Build an error message
find_field(Code::integer(), Dbus_message::dbus_header() | dbus_message()) -> dbus_variant() | undefined
Find a specific field of a message
Returns undefined
if not found
get_field(Code::integer(), Header::#dbus_header{}) -> dbus_variant()
throws {no_such_field, integer()}
Get a specific field of a message.
Throws error if not found.
get_field_value(Code::integer(), Header::dbus_header()) -> term()
throws {no_such_field, integer()}
Get a field value.
Throws error if not found.
get_serial(Dbus_message::dbus_message()) -> integer()
Get serial number from message
introspect(Service::dbus_name(), Path::dbus_name()) -> dbus_message()
Build Introspect
method call message
is_error(Msg::dbus_message(), ErrName::dbus_name()) -> boolean()
Check message is an error and of the given type
match(HeaderMatches::[{integer(), dbus_name() | '_'}], Dbus_message::dbus_message()) -> boolean()
Check message headers matches some values.
'_' means the header exists with any value
return(Orig::dbus_message(), Types::[dbus_type()], Body::term()) -> dbus_message()
Build a return message
set_body(Method::dbus_method(), Body::term(), Message::dbus_message()) -> dbus_message() | {error, dbus_err()}
Set body of a message.
set_body(Signature::binary(), Types::[dbus_type()], Body::term(), Message::dbus_message()) -> dbus_message() | {error, dbus_err()}
Set body of a message.
set_serial(Serial::integer(), Dbus_message::dbus_message()) -> dbus_message()
Set serial number of a message
signal(Destination::dbus_name(), Path::dbus_name(), Interface::dbus_name(), Signal::dbus_signal(), Args::[dbus_arg()]) -> dbus_message()
Equivalent to signal(Destination, Path, Interface, Signal, Args, [])
.
signal(Destination::dbus_name(), Path::dbus_name(), Interface::dbus_name(), Signal::dbus_signal(), Args::[dbus_arg()], Opts::[dbus_option()]) -> dbus_message()
Build a signal message
type(Dbus_message::dbus_message()) -> type()
Get message type