xcb_take_socket: Document sequence wrap requirements
authorUli Schlachter <psychon@znc.in>
Wed, 17 Nov 2010 19:26:11 +0000 (20:26 +0100)
committerJulien Danjou <julien@danjou.info>
Sat, 27 Nov 2010 11:48:27 +0000 (12:48 +0100)
commit8ecd754b168a0352783bf1ba0f0887f7ff479ee8
tree8f03968db94313bbc9d01dd5a078b1146bc88ff6
parent5755582444ad0ba79e661ab3173cc38e9e588d83
xcb_take_socket: Document sequence wrap requirements

If lots of requests are send without one causing a reply, xcb can get confused
about the current sequence number of a reply. Document the requirements of an
external socket owner to avoid this problem.

The return_socket callback for xcb_take_socket() originally was supposed to
return the last sequence number used, but the version committed to libxcb never
actually had this signature. This fixes the function's documentation not to
mention this non-existent return value.

Signed-off-by: Uli Schlachter <psychon@znc.in>
Signed-off-by: Julien Danjou <julien@danjou.info>
src/xcbext.h