docs: Add information about serials and timestamps
authorMatthias Clasen <mclasen@redhat.com>
Sat, 30 Mar 2013 18:09:25 +0000 (14:09 -0400)
committerKristian Høgsberg <krh@bitplanet.net>
Tue, 2 Apr 2013 01:43:47 +0000 (21:43 -0400)
Add some information about serials, timestamps and their uses
to the Input section in the protocol overview.

doc/Wayland/en_US/Protocol.xml

index 61dc637..d92cf6f 100644 (file)
       with a pointer grab.
     </para>
     <para>
+      To avoid race conditions, input events that are likely to
+      trigger further requests (such as button presses, key events,
+      pointer motions) carry serial numbers, and requests such as
+      wl_surface.set_popup require that the serial number of the
+      triggering event is specified. The server maintains a
+      monotonically increasing counter for these serial numbers.
+    </para>
+    <para>
+      Input events also carry timestamps with millisecond granularity.
+      Their base is undefined, so they can't be compared against
+      system time (as obtained with clock_gettime or gettimeofday).
+      They can be compared with each other though, and for instance
+      be used to identify sequences of button presses as double
+      or triple clicks.
+    </para>
+    <para>
       See <xref linkend="protocol-spec-interface-wl_seat"/> for the
       protocol description.
     </para>