nixo
/
gri3-wm
1
0
Fork 0
Code Issues Pull Requests Releases Wiki Activity

Reword documentation to make clear the difference in enumeration between event and reply types.

This commit is contained in:
Alejandro Angulo 2019-01-31 23:00:00 -08:00
parent 02bb2693f9
commit 85e6742686
1 changed files with 5 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

8
docs/ipc
View File

@ -681,9 +681,11 @@ responded to.
To get informed when certain things happen in i3, clients can subscribe to To get informed when certain things happen in i3, clients can subscribe to
events. Events consist of a name (like "workspace") and an event reply type events. Events consist of a name (like "workspace") and an event reply type
(like I3_IPC_EVENT_WORKSPACE). The events sent by i3 are in the same format (like I3_IPC_EVENT_WORKSPACE). Events sent by i3 follow a format similar to
as replies to specific commands. However, the highest bit of the message type replies but with the highest bit of the message type set to 1 to indicate an
is set to 1 to indicate that this is an event reply instead of a normal reply. event reply instead of a normal reply. Note that event types and reply types
do not follow the same enumeration scheme (e.g. event type 0 corresponds to the
workspace event however reply type 0 corresponds to the COMMAND reply).
Caveat: As soon as you subscribe to an event, it is not guaranteed any longer Caveat: As soon as you subscribe to an event, it is not guaranteed any longer
that the requests to i3 are processed in order. This means, the following that the requests to i3 are processed in order. This means, the following