X-Git-Url: https://git.sur5r.net/?a=blobdiff_plain;f=docs%2Fipc.html;h=350483e33f37c8463906ac6da522aa4867504de3;hb=88d9e82dc03f7e7abc585ee5f6752b23171ad834;hp=34a55eaf82ac70a6b11b9509f6e6be4b59b23250;hpb=35a098edee8962606ab385d82cab4ebce5243b40;p=i3%2Fi3.github.io diff --git a/docs/ipc.html b/docs/ipc.html index 34a55ea..350483e 100644 --- a/docs/ipc.html +++ b/docs/ipc.html @@ -171,6 +171,12 @@ cellspacing="0" cellpadding="4">

CONFIG

Returns the last loaded i3 config.

+ +

10

+

SEND_TICK

+

TICK

+

Sends a tick event with the specified payload.

+ @@ -295,6 +301,14 @@ GET_CONFIG (9) Reply to the GET_CONFIG message.

+
+TICK (10) +
+
+

+ Reply to the SEND_TICK message. +

+
@@ -1186,6 +1200,19 @@ which is a string containing the config file as loaded by i3 most recently.

< 
{ "config": "font pango:monospace 8\nbindsym Mod4+q exit\n" }
+
+

3.12. TICK reply

+

The reply is a map containing the "success" member. After the reply was +received, the tick event has been written to all IPC connections which subscribe +to tick events. UNIX sockets are usually buffered, but you can be certain that +once you receive the tick event you just triggered, you must have received all +events generated prior to the SEND_TICK message (happened-before relation).

+

Example:

+
+
+
{ "success": true }
+
+
@@ -1282,6 +1309,16 @@ shutdown (6) Sent when the ipc shuts down because of a restart or exit by user command

+
+tick (7) +
+
+

+ Sent when the ipc client subscribes to the tick event (with "first": + true) or when any ipc client sends a SEND_TICK message (with "first": + false). +

+

Example:

@@ -1520,6 +1557,27 @@ because of a user action such as a restart or exit command. Th }
+
+

4.10. tick event

+

This event is triggered by a subscription to tick events or by a SEND_TICK +message.

+

Example (upon subscription):

+
+
+
{
+ "first": true,
+ "payload": ""
+}
+
+

Example (upon SEND_TICK with a payload of arbitrary string):

+
+
+
{
+ "first": false,
+ "payload": "arbitrary string"
+}
+
+
@@ -1568,6 +1626,11 @@ Go https://github.com/mdirkse/i3ipc-go

+
  • +

    +https://github.com/i3/go-i3 +

    +
    • @@ -1618,11 +1681,6 @@ Python

  • -https://github.com/Ceryn/i3msg-python -

    -
    • -
  • -

    https://github.com/whitelynx/i3ipc (not maintained)

    • @@ -1785,6 +1843,8 @@ From here on out, send/receive all messages using the detected byte order.

    +

    Find an example implementation of this technique in +https://github.com/i3/go-i3/blob/master/byteorder.go