mirror of https://github.com/warmcat/libwebsockets.git synced 2025-03-16 00:00:07 +01:00

History

Andy Green 9f1d019352 CTest: migrate and deprecate existing selftest scripts Replace the bash selftest plumbing with CTest. To use the selftests, build with -DLWS_WITH_MINIMAL_EXAMPLES=1 and `CTEST_OUTPUT_ON_FAILURE=1 make test` or just `make test`. To disable tests that require internet access, also give -DLWS_CTEST_INTERNET_AVAILABLE=0 Remove travis and appveyor scripts on master. Remove travis and appveyor decals on README.md.		2020-05-11 15:40:13 +01:00
..
CMakeLists.txt	CTest: migrate and deprecate existing selftest scripts	2020-05-11 15:40:13 +01:00
main.c	sul: all timed objects use a single pt sul list	2019-08-09 10:12:09 +01:00
README.md	role: dbus	2018-10-13 08:16:27 +08:00

README.md

lws minimal dbus server

build

Using libdbus requires additional non-default include paths setting, same as is necessary for lws build described in ./lib/roles/dbus/README.md

CMake can guess one path and the library name usually, see the README above for details of how to override for custom libdbus and cross build.

Fedora example:

$ cmake .. -DLWS_DBUS_INCLUDE2="/usr/lib64/dbus-1.0/include"
$ make

Ubuntu example:

$ cmake .. -DLWS_DBUS_INCLUDE2="/usr/lib/x86_64-linux-gnu/dbus-1.0/include"
$ make

usage

Commandline option	Meaning
-d	Debug verbosity in decimal, eg, -d15
--session	Bind to session bus instead of creating private abstract unix socket

By default the minimal server listens using its own abstract unix socket at unix:abstract=org.libwebsockets.test.

You can also run it instead as a participant on the session bus, without its own unix socket, by giving --session.

Examples using the default private abstract unix socket

 $ ./lws-minimal-dbus-server
[2018/10/03 07:08:02:6448] USER: LWS minimal dbus server
[2018/10/03 07:08:02:6693] NOTICE: Creating Vhost 'default' port 0, 1 protocols, IPv6 off
...

You can communicate with the dbus server over its private abstract socket using, eg

$ gdbus introspect --address unix:abstract=org.libwebsockets.test --dest org.libwebsockets.test --object-path /org/libwebsockets/test
node /org/example/TestObject {
  interface org.freedesktop.DBus.Introspectable {
    methods:
      Introspect(out s data);
    signals:
    properties:
  };
  interface org.freedesktop.DBus.Properties {
    methods:
      Get(in  s interface,
...

$ gdbus call --address unix:abstract=org.libwebsockets.test --dest org.libwebsockets.test --object-path /org/libwebsockets/test --method org.libwebsockets.test.Echo HELLO
('HELLO',)

Examples using the DBUS session bus

 $ ./lws-minimal-dbus-server --session
[2018/10/03 07:08:02:6448] USER: LWS minimal dbus server
[2018/10/03 07:08:02:6693] NOTICE: Creating Vhost 'default' port 0, 1 protocols, IPv6 off
...

You can communicate with the dbus server over the session bus using, eg

$ gdbus introspect --session --dest org.libwebsockets.test --object-path /org/libwebsockets/test
node /org/example/TestObject {
  interface org.freedesktop.DBus.Introspectable {
    methods:
      Introspect(out s data);
    signals:
    properties:
  };
  interface org.freedesktop.DBus.Properties {
    methods:
      Get(in  s interface,
...

$ gdbus call --session --dest org.libwebsockets.test --object-path /org/libwebsockets/test --method org.libwebsockets.test.Echo HELLO
('HELLO',)