fdo-mirrors/libei
1
0
Fork 0
mirror of https://gitlab.freedesktop.org/libinput/libei.git synced 2025-12-29 16:00:09 +01:00
Code Issues Projects Releases Packages Wiki Activity Actions
libei/doc/protocol/libraries/_index.md
Peter Hutterer e8765f3042 doc/proto: add a page describing the libraries 
Now that the API doc is behind a link, let's make it a bit more
prominent to find.
2023-03-09 14:28:30 +10:00

2.8 KiB
Raw Blame History

title draft archetype alwaysopen weight
C libraries false home true 3

The libei project provides several C libraries that abstract the protocol and provide an easy-to-use C API to interact with the respective EI counterpart.

libei - the client library

This library is intended for use by EI clients. This library should be used by processes that need to emulate devices or processes that need to receive input events from logical devices.

The interface mirrors the libinput API. A demo client is available in the libei repository.

The C library API documentation for libei is here.

libeis - the server library

This library is intended for use by EIS implementations. This library should be used by processes that have control over input devices, e.g. Wayland compositors.

The interface mirrors the libinput API. A demo server is available in the libei repository.

The C library API documentation for libeis is here

liboeffis - DBus helper library

This library is a helper library for applications that do not want to or cannot interact with the XDG RemoteDesktop DBus portal directly.

liboeffis will:

  • connect to the DBus session bus and the org.freedesktop.portal.Desktop bus name
  • Start a org.freedesktop.portal.RemoteDesktop session, select the devices and invoke RemoteDesktop.ConnectToEIS()
  • Provide the returned file descriptor to the caller. This fd can be used by libei to initialize a context.
  • Close everything in case of error or disconnection

The below diagram shows the simplified process:

{{< mermaid >}} sequenceDiagram participant libei participant liboeffis participant portal as XDG Desktop Portal participant eis as EIS implementation

liboeffis ->> portal: CreateSession portal ->> eis: CreateSession eis -->> portal: fd portal -->> liboeffis: fd

liboeffis -->> libei: take fd for libei context

libei ->> eis: setup connection libei ->> eis: emulate events {{< /mermaid >}}

liboeffis is intentionally kept simple, any more complex needs should be handled by an application talking to DBus directly.

A demo tool is available in the libei repository.

The C library API documentation for liboeffis is here.