Skip to content

Latest commit

 

History

History
244 lines (147 loc) · 8.32 KB

dbus_message.md

File metadata and controls

244 lines (147 loc) · 8.32 KB

Module dbus_message

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).

Description

See D-Bus Specification

Data Types


type() = '?TYPE_INVALID' | '?TYPE_METHOD_CALL' | '?TYPE_METHOD_RETURN' | '?TYPE_ERROR' | '?TYPE_SIGNAL'

Function Index

call/4Equivalent to call(Destination, Path, Interface, Member, []).
call/5Build a method call message.
error/3Build an error message.
find_field/2Find a specific field of a message.
get_field/2Get a specific field of a message.
get_field_value/2Get a field value.
get_serial/1Get serial number from message.
introspect/2Build Introspect method call message.
is_error/2Check message is an error and of the given type.
match/2Check message headers matches some values.
return/3Build a return message.
set_body/3Set body of a message.
set_body/4Set body of a message.
set_serial/2Set serial number of a message.
signal/5Equivalent to signal(Destination, Path, Interface, Signal, Args, []).
signal/6Build a signal message.
type/1Get message type.

Function Details

call/4


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/5


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/3


error(Orig::dbus_message(), ErrName::binary(), ErrText::binary()) -> dbus_message()

Build an error message

find_field/2


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/2


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/2


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/1


get_serial(Dbus_message::dbus_message()) -> integer()

Get serial number from message

introspect/2


introspect(Service::dbus_name(), Path::dbus_name()) -> dbus_message()

Build Introspect method call message

is_error/2


is_error(Msg::dbus_message(), ErrName::dbus_name()) -> boolean()

Check message is an error and of the given type

match/2


match(HeaderMatches::[{integer(), dbus_name() | '_'}], Dbus_message::dbus_message()) -> boolean()

Check message headers matches some values.

'_' means the header exists with any value

return/3


return(Orig::dbus_message(), Types::[dbus_type()], Body::term()) -> dbus_message()

Build a return message

set_body/3


set_body(Method::dbus_method(), Body::term(), Message::dbus_message()) -> dbus_message() | {error, dbus_err()}

Set body of a message.

set_body/4


set_body(Signature::binary(), Types::[dbus_type()], Body::term(), Message::dbus_message()) -> dbus_message() | {error, dbus_err()}

Set body of a message.

set_serial/2


set_serial(Serial::integer(), Dbus_message::dbus_message()) -> dbus_message()

Set serial number of a message

signal/5


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/6


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/1


type(Dbus_message::dbus_message()) -> type()

Get message type