Skip to content

Commit e2d6117

Browse files
authored
Merge pull request #3607 from vacuus/3546-fix-misleading-doc
Clear up confusion between event and reply types.
2 parents 02bb269 + 85e6742 commit e2d6117

File tree

1 file changed

+5
-3
lines changed

1 file changed

+5
-3
lines changed

docs/ipc

Lines changed: 5 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -681,9 +681,11 @@ responded to.
681681

682682
To get informed when certain things happen in i3, clients can subscribe to
683683
events. Events consist of a name (like "workspace") and an event reply type
684-
(like I3_IPC_EVENT_WORKSPACE). The events sent by i3 are in the same format
685-
as replies to specific commands. However, the highest bit of the message type
686-
is set to 1 to indicate that this is an event reply instead of a normal reply.
684+
(like I3_IPC_EVENT_WORKSPACE). Events sent by i3 follow a format similar to
685+
replies but with the highest bit of the message type set to 1 to indicate an
686+
event reply instead of a normal reply. Note that event types and reply types
687+
do not follow the same enumeration scheme (e.g. event type 0 corresponds to the
688+
workspace event however reply type 0 corresponds to the COMMAND reply).
687689

688690
Caveat: As soon as you subscribe to an event, it is not guaranteed any longer
689691
that the requests to i3 are processed in order. This means, the following

0 commit comments

Comments
 (0)