mirror of
https://gitlab.freedesktop.org/libinput/libei.git
synced 2026-01-06 14:10:13 +01:00
2ec3ced24c
There's a very limited use for configure messages after client connection. The name is already static after connect anyway, and the ability to drop capabilities after connect would just complicate the EIS implementations unnecessary.
298 lines
6.9 KiB
Protocol Buffer
298 lines
6.9 KiB
Protocol Buffer
syntax = "proto3";
|
|
|
|
/**
|
|
* EI Protocol Specification
|
|
*
|
|
* This protocol is an internal implementation detail and subject to change
|
|
* at any time. This specification is for developers of libei only.
|
|
*
|
|
* ClientMessage → sent from the client to the server
|
|
* ServerMessage → sent from the server to the client
|
|
*
|
|
* A normal sequence consists of:
|
|
* [0. - proxy configures connection, see the section below]
|
|
* 1. - client establishes connection to server
|
|
* 2. - client sends "Connect"
|
|
* 2.a - server replies with "Connected" or
|
|
* 2.b - server replies with "Disconnected" and closes its end of the socket
|
|
* 3. - server sends "AddSeat" (once or multiple times)
|
|
* 4. - client sends "BindSeat" for each seat
|
|
* 5. - server sends "DeviceAdded" for any device on this seat
|
|
* 6. - server sends "DeviceResumed"
|
|
* 7. - client sends "StartEmulating" to notify the server emulation starts
|
|
* 8. - client sends "PointerRelative" or any other event
|
|
* 9. - client sends "StopEmulating" to notify the server emulation starts
|
|
* 10. - client sends "CloseDevice"
|
|
* 11. - client sends "Disconnect" and closes its end of the socket
|
|
*
|
|
* The server may send Disconnect at any time.
|
|
* The server may send SeatRemoved for a device at any time.
|
|
* The server may send DeviceSuspended for any currently resumed device at any time.
|
|
* The server may send DeviceRemoved for a device at any time.
|
|
*
|
|
* Where a connection error occurs, the library (libei or libeis) will
|
|
* unroll the state as seen from the API.
|
|
*
|
|
* Pre-configuring a connection
|
|
* ----------------------------
|
|
*
|
|
* Where a proxy is in place (e.g. a portal), the client connection can be
|
|
* pre-configured to match the permissions model. The proxy opens or obtains a
|
|
* socket to the server, writes the Configure* messages onto that socket and
|
|
* then passes the fd to the client to create a libei context from that.
|
|
*
|
|
* The proxy can force a client name and/or restrict other options. This is
|
|
* invisible to the client, it does not know what restrictions are in place.
|
|
*
|
|
* Configure messages may only be sent before the client connection. Sending
|
|
* Configure messages after a client has connected will be silently ignored.
|
|
*/
|
|
|
|
/* ConfigureName *must* be sent before the Connect event */
|
|
message ConfigureName {
|
|
string name = 1;
|
|
}
|
|
|
|
/* Changes the capability policy and allows or denies specific capabilities */
|
|
message ConfigureCapabilities {
|
|
uint32 allowed_capabilities = 2;
|
|
}
|
|
|
|
message Connect {
|
|
string name = 1;
|
|
bool is_sender = 2;
|
|
}
|
|
|
|
message ConnectDone {
|
|
}
|
|
|
|
message Disconnect {
|
|
}
|
|
|
|
message BindSeat {
|
|
uint32 seatid = 1;
|
|
uint32 capabilities = 2;
|
|
}
|
|
|
|
message CloseDevice {
|
|
uint32 deviceid = 1;
|
|
}
|
|
|
|
message PointerRelative {
|
|
uint32 deviceid = 1;
|
|
double x = 2;
|
|
double y = 3;
|
|
}
|
|
|
|
message PointerAbsolute {
|
|
uint32 deviceid = 1;
|
|
double x = 2;
|
|
double y = 3;
|
|
}
|
|
|
|
message PointerScroll {
|
|
uint32 deviceid = 1;
|
|
double x = 2;
|
|
double y = 3;
|
|
}
|
|
|
|
message PointerScrollDiscrete {
|
|
uint32 deviceid = 1;
|
|
double x = 2;
|
|
double y = 3;
|
|
}
|
|
|
|
message PointerScrollStop {
|
|
uint32 deviceid = 1;
|
|
bool x = 2;
|
|
bool y = 3;
|
|
bool is_cancel = 4;
|
|
}
|
|
|
|
message PointerButton {
|
|
uint32 deviceid = 1;
|
|
uint32 button = 2;
|
|
bool state = 3;
|
|
}
|
|
|
|
message KeyboardKey {
|
|
uint32 deviceid = 1;
|
|
uint32 key = 2;
|
|
bool state = 3;
|
|
}
|
|
|
|
message TouchDown {
|
|
uint32 deviceid = 1;
|
|
uint32 touchid = 2;
|
|
double x = 5;
|
|
double y = 6;
|
|
}
|
|
|
|
message TouchMotion {
|
|
uint32 deviceid = 1;
|
|
uint32 touchid = 2;
|
|
double x = 5;
|
|
double y = 6;
|
|
}
|
|
|
|
message TouchUp {
|
|
uint32 deviceid = 1;
|
|
uint32 touchid = 2;
|
|
}
|
|
|
|
message StartEmulating {
|
|
uint32 deviceid = 1;
|
|
}
|
|
|
|
message StopEmulating {
|
|
uint32 deviceid = 1;
|
|
}
|
|
|
|
message Frame {
|
|
uint32 deviceid = 1;
|
|
uint64 timestamp = 2;
|
|
}
|
|
|
|
message Property {
|
|
string name = 1;
|
|
string value = 2;
|
|
uint32 permissions = 3;
|
|
}
|
|
|
|
message ClientMessage {
|
|
oneof msg {
|
|
/* Client setup and configuration */
|
|
Connect connect = 1;
|
|
ConnectDone connect_done = 2;
|
|
Disconnect disconnect = 3;
|
|
BindSeat bind_seat = 4;
|
|
CloseDevice close_device = 6;
|
|
ConfigureName configure_name = 7;
|
|
ConfigureCapabilities configure_capabilities = 8;
|
|
Property property = 9;
|
|
|
|
/* Events */
|
|
StartEmulating start_emulating = 20;
|
|
StopEmulating stop_emulating = 21;
|
|
PointerRelative pointer_relative = 22;
|
|
PointerAbsolute pointer_absolute = 23;
|
|
PointerScroll pointer_scroll = 24;
|
|
PointerScrollDiscrete pointer_scroll_discrete = 25;
|
|
PointerScrollStop pointer_scroll_stop = 26;
|
|
PointerButton pointer_button = 27;
|
|
KeyboardKey keyboard_key = 28;
|
|
TouchDown touch_down = 29;
|
|
TouchMotion touch_motion = 30;
|
|
TouchUp touch_up = 31;
|
|
Frame frame = 32;
|
|
}
|
|
}
|
|
|
|
message Connected {
|
|
}
|
|
|
|
message Disconnected {
|
|
}
|
|
|
|
message SeatAdded {
|
|
uint32 seatid = 1;
|
|
uint32 capabilities = 2;
|
|
string name = 3;
|
|
}
|
|
|
|
message SeatRemoved {
|
|
uint32 seatid = 1;
|
|
}
|
|
|
|
message DeviceAdded {
|
|
uint32 deviceid = 1;
|
|
uint32 capabilities = 2;
|
|
string name = 6;
|
|
uint32 seatid = 7;
|
|
uint32 type = 8;
|
|
uint32 width = 9;
|
|
uint32 height = 10;
|
|
}
|
|
|
|
message DeviceKeymap {
|
|
uint32 deviceid = 1;
|
|
uint32 keymap_type = 2;
|
|
uint32 keymap_size = 3;
|
|
/* keymap itself is passed as fd */
|
|
}
|
|
|
|
message DeviceRegion {
|
|
uint32 deviceid = 1;
|
|
uint32 offset_x = 2;
|
|
uint32 offset_y = 3;
|
|
uint32 width = 4;
|
|
uint32 height = 5;
|
|
double scale = 6;
|
|
}
|
|
|
|
message DeviceDone {
|
|
uint32 deviceid = 1;
|
|
}
|
|
|
|
message DeviceRemoved {
|
|
uint32 deviceid = 1;
|
|
}
|
|
|
|
message DeviceResumed {
|
|
uint32 deviceid = 1;
|
|
}
|
|
|
|
message DevicePaused {
|
|
uint32 deviceid = 1;
|
|
}
|
|
|
|
message KeyboardModifiers {
|
|
uint32 deviceid = 1;
|
|
uint32 depressed = 2;
|
|
uint32 locked = 3;
|
|
uint32 latched = 4;
|
|
uint32 group = 5;
|
|
}
|
|
|
|
message ServerMessage {
|
|
oneof msg {
|
|
/* Server setup and configuration */
|
|
Connected connected = 2;
|
|
Disconnected disconnected = 3;
|
|
SeatAdded seat_added = 4;
|
|
SeatRemoved seat_removed = 5;
|
|
DeviceAdded device_added = 6;
|
|
DeviceRegion device_region = 7;
|
|
DeviceKeymap device_keymap = 8;
|
|
DeviceDone device_done = 9;
|
|
DeviceRemoved device_removed = 10;
|
|
DeviceResumed device_resumed = 11;
|
|
DevicePaused device_paused = 12;
|
|
KeyboardModifiers keyboard_modifiers = 13;
|
|
Property property = 14;
|
|
|
|
/* Events */
|
|
StartEmulating start_emulating = 20;
|
|
StopEmulating stop_emulating = 21;
|
|
PointerRelative pointer_relative = 22;
|
|
PointerAbsolute pointer_absolute = 23;
|
|
PointerScroll pointer_scroll = 24;
|
|
PointerScrollDiscrete pointer_scroll_discrete = 25;
|
|
PointerScrollStop pointer_scroll_stop = 26;
|
|
PointerButton pointer_button = 27;
|
|
KeyboardKey keyboard_key = 28;
|
|
TouchDown touch_down = 29;
|
|
TouchMotion touch_motion = 30;
|
|
TouchUp touch_up = 31;
|
|
Frame frame = 32;
|
|
}
|
|
}
|
|
|
|
/* Protobuf-C only works correctly if the length of the next message is
|
|
* known, so we need to prefix *every* message with our packed size.
|
|
* This message is used by server and client but it's an implementation
|
|
* detail, not a part of the actual protocol.
|
|
*/
|
|
message Packet {
|
|
fixed32 length = 1;
|
|
}
|