package obus
Build not checkedInstall
dune-project
Dependency
Authors
Maintainers
Sources
sha256=3bf0aeb00bf90cd4111483b37cefcb39af38ad6db1aeb6949a2fbecc13ff9a90
md5=7dd48f9bde3e069898fa08e9972596b5
Description
Added to opam-repository:
README
OBus
OBus is a pure OCaml implementation of the D-Bus protocol. It aims to provide a clean and easy way for ocaml programmers to access and provide D-Bus services.
OBus is using the cooperative threading library Lwt, which make it very simple to fully exploit the asynchronous nature of D-Bus.
Dependencies
Make sure you have dune installed, and install all the missing dependencies listed in the output of this command:
$ dune external-lib-deps @install --missingInstallation
The recommended way to install obus and its dependencies is via opam: opam install obus.
Manual installation from sources
To build and install obus:
$ dune build @installTests (optionnal)
To build and execute tests:
$ dune runtestUsing the library
OBus install the following packages:
obus: the core library, implementing the D-Bus protocol,obus.ppx: syntax extensions to aid registering OBus exceptions.obus.notification: interface to the freedesktop Notification service,obus.hal: interface to the freedesktop Hal service,obus.upower: interface to the freedesktop UPower service,obus.udisks: interface to the freedesktop UDisks service,obus.policykit: interface to the freedesktop PolicyKit servie.
Using the tools
There are several tools provided in the obus distribution:
obus-dump, to execute a command and dump all messages that goes throug the session and/or system message bus,obus-introspectwhich can recursively introspect a D-Bus service,obus-gen-interface, to convert D-Bus introspection files into ocaml definition modules,obus-gen-clientand obus-gen-server which can generate template for using or implementing D-Bus servies,obus-xml2idland obus-idl2xml to convert xml introspection documents to the obus idl format, and vice versa.
There are manual pages for all this tools.
The caml files generated by obus-gen-client and obus-gen-server are meant to be edited and adapted. In practice introspections files contains only marshaling informations so it is often not sufficient for creating a usable binding.
Here is a simple example of use of the tools:
$ obus-introspect org.freedesktop.Notifications /org/freedesktop/Notifications > notif.xml
$ obus-gen-interface notif.xml
$ obus-gen-client notif.xml
Dependencies (10)
Dev Dependencies
None
Optional Dependencies
None
Used by (3)
-
0install
>= "2.15.2" - mpris
- mpris-clients
Conflicts
None
Build status
Results of building obus with each compiler on check.ci.ocaml.org, run of against opam-repository 78c202b. All results for this package.
Each result links to its build log. To keep crawlers from overloading the site, build logs require a GitHub sign-in (see ocurrent/opam-health-check). On your first log, GitHub asks you to “Authorize opam-health-check”, the OCurrent app that runs these checks; it sees only your public profile, not your repositories. The sign-in lasts 30 days.
This version is not in the latest run; the versions below are.
- good Package successfully built
- partial One of the dependencies failed to build
- bad Package failed to build
- n/a Package is not available in this environment
- internal Internal failure