protocol: Add some documentation for inval_all_pixmaps message

This message is not straight forward to grasp.
Not clear by the name why we need to wait other channels messages
before resetting the image cache.

Signed-off-by: Frediano Ziglio <fziglio@redhat.com>
Acked-by: Jonathon Jongsma <jjongsma@redhat.com>
This commit is contained in:
Frediano Ziglio 2018-03-07 11:13:34 +00:00
parent 8096b1206b
commit 2eaef9c16d

View File

@ -736,6 +736,13 @@ channel DisplayChannel : BaseChannel {
ResourceID resources[count] @end;
} @ctype(SpiceResourceList) inval_list;
/* This message is used to invalidate the complete image cache
* on the client.
* Due to synchronization for GLZ images we must make sure
* that messages related to cached images on other channels
* are processed so we send a list of channels with respective
* message serials to wait for.
*/
message {
uint8 wait_count;
WaitForChannel wait_list[wait_count] @end;