Index of values

Returns whether a connection is active.

add_interfaces obj ifaces adds suport for the interfaces described by ifaces to the given object.

Add a matching rule on a message bus.

addresses server returns all the addresses the server is listenning on.

after prefix path if path = prefix @ p return Some p, and None if not

anonymous connection make an anonymous peer

Application name used for notification.

arg key address returns the value of argument key, if any

arg_cons (name, typ) arguments adds the argument (name, type) to the beginning of arguments

Returns the names of a list of arguments

Returns the underlying sequence converter of a list of arguments.

args Projection

arguments ~arg_types ~arg_names creates a list of arguments.

Raises OBus_string.Invalid_string if the given string failed to validate

attach obus_object custom_obejct attaches custom_object to obus_object.

Launch server-side authentication on the given stream.

Launch client-side authentication on the given stream.

Types extraction

call proxy ~interface ~member ~i_args ~o_args args calls the given method on the given proxy and wait for the reply.

call meth proxy args calls the method meth on the object pointed by proxy, and wait for the reply.

call_no_reply is the same as OBus_proxy.call except that it does not wait for a reply

call_no_reply meth proxy args is the same as OBus_method.call except that it does not wait for a reply

call_with_context is like OBus_proxy.call except that is also returns the context of the method return

call_with_context meth proxy args is like OBus_method.call except that is also returns the context of the method return

can_send_*_type connection typ returns whether values of the given type can be sent through the given connection.

Returns the capabilities of the transport

List of all capabilities

cast exn returns the D-Bus name and message of the given exception.

Returns the list of filters for the given arguments filter.

Close the notification now

Close a connection.

close_reader reader closes the given reader.

close_writer writer closes the given writer.

Same as Pervasives.compare.

Same as Pervasives.compare.

Same as Pervasives.compare.

Same as Pervasives.compare.

compare_rules r1 r2 compares the two matching rules r1 and r2

The computer device

connect ?switch sd connects the signal descriptor sd and returns the event which occurs when the given D-Bus signal is received.

connection proxy = OBus_peer.connection (peer proxy)

connection projection

Returns the connection part of a context

The org.freedesktop.DBus.GLib.CSymbol annotation

daemon () returns the peer object for the upower daemon

daemon () returns the peer object for the udisks daemon

daemon () returns the peer object for the network manager daemon

Decode the given standard interface into an extended one by decoding annotations

All false

The default addresses for the session bus

The default addresses for the system bus

The org.freedesktop.DBus.Deprecated annotation

If the application has a desktop entry, it can be specified here

destinatino context returns the peer to which the message were sent

destroy obj removes obj from all connection it is exported on

dynamic ~connection ~prefix ~handler defines a dynamic node in the tree of object.

emit signal obj ?peer args emit signal from obj.

emit obj ~interface ~member ?peer typ args emits a signal.

The org.freedesktop.DBus.Property.EmitsChangedSignal annotation

Empty path

Encode the given interface into a standard one by using annotations

error_message error returns a human-readabe error message

Escape an arbitrary string into a valid element

Function which exit the program as follow:

export connection obj exports obj on connection.

export ?switch connection rule registers rule on the message bus.

exports obj is a signal holding the list of connnections on which the object is exproted.

find property map looks up for the given property in set and maps it to a value of type 'a.

find_value name map returns the value associated to name in set.

Same as OBus_property.find_value but also returns the context in which the property was received.

Same as OBus_property.find but also returns the context in which the property was received.

flags context returns the flags of the message that was received

Generate a new uuid

generate () generate a new unique path

Read the contents of a property.

get obj returns the data attached to the given object

In a method call handler, this returns the context of the method call.

get connection key returns the data associated to key in connection, if any.

get_all_no_cache proxy interface reads the value of all properties without using the cache.

Retreive server capabilities, see specification for details

Returns the set of all properties that belong to the given group.

Return the id of the machine the peer is running on

Return the connection unique name of the given service.

get_peer bus name return the peer owning the bus name name.

get_proxy bus name path resolve name with OBus_bus.get_peer and return a proxy for the object with path path on this service

Retreive server informations

Same as OBus_property.get but also returns the context

group ?monitor proxy interface creates a group for all readable properties of the given interface.

Returns the address guid, if any

Translate a D-Bus name into an haskell-style lower-identifier:

Translate a D-Bus name into an haskell-style upper-identifier:

hello connection sends an hello message to the message bus, which returns the unique connection name of the connection.

Filters applied on incomming messages

Try to read an xml document as an introspection document.

introspect proxy introspects the given proxy

introspect obj returns the introspection of all interfaces implemented by obj

The org.freedesktop.DBus.Introspectable interface

invalid_reply ~method_call ~expected_signature ~method_return returns an OBus_message.Invalid_reply exception with a informative description of the error.

Tell wether a bus name is a unique connection name or not.

The key used for storing the context.

List services that can be activated.

List names currently running on the message bus

Return the connection unique names of applications waiting for a name

Loopback transport, each message sent is received on the same transport

Creates a connection with a loopback transport

UUID of the machine we are running on

make ?switch ~recv ~send ~support_unxi_fd ~shutdown () creates a new transport from the given functions.

make signal proxy creates a signal descriptor.

make ?switch ?capabilities ?mechanisms ?addresses ?allow_anonymous f Creates a server which will listen on all of the given addresses.

make ?switch bus name creates a resolver which will monitor the name name on bus.

Creates a proxy from the given peer and path

make ?monitor property proxy returns the property object for this proxy.

make connection name make a named peer

make ?owner ?common ?interfaces path creates a new D-Bus object with path path.

make exn message creates an exception from an error name and an error message.

Creates a context from the given connection and message

Creates an address

make_any signal peer creates a signal descriptor for receiving signals from any object of peer.

Creates an arguments filter from a list of filters.

Creates message flags.

make_interface ~name ?annotations ?methods ?signals ?properties () creates a new interface

make_lowlevel is the same as OBus_server.make except that f receives only the transport, and no connection is created for this transport.

Creates a stream for authentication.

The Hal manager

Simplified version of OBus_signal.map_event.

map_event f sd transforms with f the event that is created when sd is connected.

map_of_list context values returns the map corresponding to the given values and context.

Maps a read-only property.

Maps a read-only property, passing the conntext to the mapping function

map property f g maps property with f and g

Same as OBus_property.map except that the context is also passed to mapping functions.

Maps a write-only property.

Same as OBus_signal.map but the mapping function also receive the context.

match_message rule message returns wether message is matched by rule

match_values filters values returns whether values are matched by the given list of argument filters.

Maximum lenght accepted for lines of the authentication protocol.

Maximum size of a message.

Maximum length of a name (=255).

mech_exec projection

mech_exec projection

mech_name projection

mech_name projection

message_of_string buf fds returns a message from a string.

Calls a method using the given parameters, and waits for its reply.

Same as OBus_connection.method_call but do not expect a reply

Same as OBus_connection.method_call, but also returns the reply message so you can extract informations from it.

method_info desc handler creates a method-call member.

Monitor for properties of upower interfaces.

Monitor for properties of udisk interfaces.

Monitor for properties of Network Manager interfaces.

monitor ?switch property returns the signal holding the current contents of property.

monitor_group ?switch group monitors all properties of the given group.

connection proxy = OBus_peer.name (peer proxy)

name projection

The D-Bus name if this error

name exn returns the D-Bus error name under which this exception is registered.

Returns the unique name of the connection.

Same as OBus_connection.name.

name projection

Return true if the service is currently running, i.e.

This signal is emited each time the owner of a name (unique connection name or service name) change.

names bus is the signal holding the set of all names we currently own.

new_key () generates a new key.

no_auto_start projection

The org.freedesktop.DBus.Method.NoReply annotation

no_reply_expected projection

Exception raised by services when trying to perform an action for which we do not have authorization from PolicyKit

Open a notification.

obtain_authorization ~action_id ~xid ~pid tries to obtain authorization for action_id.

The org.ocamlcore.forge.obus.Enum annotation

The org.ocamlcore.forge.obus.Flag annotation

The org.ocamlcore.forge.obus.IType annotation

The org.ocamlcore.forge.obus.OType annotation

The org.ocamlcore.forge.obus.Type annotation

The name of the D-Bus error which is generated for uncaught ocaml exceptions that have not been registered

Translate a D-Bus name into an ocaml-style lower-identifier:

Translate a D-Bus name into an ocaml-style upper-identifier:

of_addresses ?switch ?capabilities ?mechanisms addresses tries to:

of_addresses ?switch ?shared addresses try to get a working D-Bus connection from a list of addresses.

Establish a connection with a message bus.

Create a uuid from a string.

Create an object path from a string.

of_string str parse str and return the list of addresses defined in it.

Create a D-Bus connection on the given transport.

Function called when one or more properties of the given object change.

Filters appllied on outgoing messages

Create an xml from an introspection document

owner obj returns the owner of the object, if any

parse stream parses the given stream.

Helper to parse the contents of a file

Returns the path of a proxy

path obj returns the path of the object

Returns the peer pointed by a proxy

Ping a peer, and return the peer which really respond to the ping.

print pp interfaces prints the given interfaces on pp in the obus idl format

Print a message on a formatter

Helper to print to a file

print_set pp map prints all the properties of map.

The org.freedesktop.DBus.Properties interface

Tries to convert the given variant into a property

property_r_info desc get defines a read-only property.

property_rw_info desc get set defines a readable and writable property.

property_w_info desc set defines a write-only property.

The version of the D-Bus protocol implemented by the library

read_message ic deserializes a message from a channel.

Read a message with its file descriptors from the given reader

Access mode for readable properties

Access mode for readable and writable properties

reader unix_socket creates a reader from a unix socket

recv tr receives one message from the given transport

Register the given connection to a message bus.

remove connection obj removes obj from connection.

remove_by_path connection path removes the object with path path on connection.

remove_interaces obj ifaces removes informations about the given interfaces from obj.

Same as OBus_object.remove_interfaces by takes only the interface names as argument.

Remove a match rule from the message bus.

Request a name to the bus.

resolve env term resolves symbols of term using env, and returns the extended type it denotes.

Waits for a notification to be closed then returns:

Create a matching rule.

Parse a string representation of a matching rule.

send tr msg sends msg over the transport tr.

send_message connection message send a message without expecting a reply.

Same as OBus_connection.send_message but do not generate a serial for the message.

Same as OBus_connection.send_message_with_reply but do not generate a serial for the message.

send_message_with_reply connection message Send a message and return a thread which wait for the reply (which is a method return or an error)

sender context returns the peer who sends the message

Closes all file descriptors of the given value

Duplicates all file descriptors of the given value

Returns the serial of the message

session ?switch () returns a connection to the user session message bus.

The list of addresses for session bus

Write the contents of a property