diff options
author | Francois Gouget <fgouget@codeweavers.com> | 2019-07-11 15:10:14 +0200 |
---|---|---|
committer | Frediano Ziglio <fziglio@redhat.com> | 2019-08-07 10:39:45 +0100 |
commit | 22f1b1297b3e056b50ce3cc0180710797aea270c (patch) | |
tree | 303538b26efd665e9ce7d1fad07ea50c200262b9 | |
parent | 81f56cf07a600ca54f5273024393958974fc7901 (diff) |
protocol: Add some comments to vd_agentd.h
Signed-off-by: Francois Gouget <fgouget@codeweavers.com>
Signed-off-by: Frediano Ziglio <fziglio@redhat.com>
-rw-r--r-- | spice/vd_agent.h | 24 |
1 files changed, 23 insertions, 1 deletions
diff --git a/spice/vd_agent.h b/spice/vd_agent.h index 42ec77a..e4e00a8 100644 --- a/spice/vd_agent.h +++ b/spice/vd_agent.h @@ -62,15 +62,34 @@ typedef struct SPICE_ATTR_PACKED VDAgentMessage { #define VD_AGENT_CLIPBOARD_MAX_SIZE_ENV "SPICE_CLIPBOARD_MAX_SIZE" #endif + +/* + * Messages and types for guest agent. + * These messages are sent through the virtio port "com.redhat.spice.0" + * (agent <-> server) or embedded in "agent_data" SPICE protocol message in + * the "MainChannel" (server <-> client) + */ enum { + /* server -> agent */ VD_AGENT_MOUSE_STATE = 1, + /* client -> agent|server. + * Acknowledged by the agent using VD_AGENT_REPLY. + * See VDAgentMonitorsConfig structure. + */ VD_AGENT_MONITORS_CONFIG, + /* agent -> client. + * See VDAgentReply structure. + */ VD_AGENT_REPLY, /* Set clipboard data (both directions). * Message comes with type and data. * See VDAgentClipboard structure. */ VD_AGENT_CLIPBOARD, + /* client -> agent. + * Acknowledged by Windows agent using VD_AGENT_REPLY. + * See VDAgentDisplayConfig structure. + */ VD_AGENT_DISPLAY_CONFIG, VD_AGENT_ANNOUNCE_CAPABILITIES, /* Asks to listen for clipboard changes (both directions). @@ -254,7 +273,7 @@ typedef struct SPICE_ATTR_PACKED VDAgentDeviceDisplayInfo { uint32_t monitor_id; uint32_t device_display_id; uint32_t device_address_len; - uint8_t device_address[0]; // a zero-terminated string + uint8_t device_address[0]; /* a zero-terminated string */ } VDAgentDeviceDisplayInfo; @@ -270,6 +289,9 @@ typedef struct SPICE_ATTR_PACKED VDAgentGraphicsDeviceInfo { VDAgentDeviceDisplayInfo display_info[0]; } VDAgentGraphicsDeviceInfo; + +/* Capabilities definitions + */ enum { VD_AGENT_CAP_MOUSE_STATE = 0, VD_AGENT_CAP_MONITORS_CONFIG, |