summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorFrediano Ziglio <fziglio@redhat.com>2020-03-18 10:06:33 +0000
committerFrediano Ziglio <fziglio@redhat.com>2020-03-26 09:31:02 +0000
commitedd2bb714306a72aeb9930d8d3d333ebb1bd0d6d (patch)
treeaa8ff68bac05a59533eb10993cde2bacffaf6a2c
parent0ceb92087e9bfa347cecb9c5c0f200b44c35e392 (diff)
vd_agent: Add some documentation
Signed-off-by: Frediano Ziglio <fziglio@redhat.com> Acked-by: Victor Toso <victortoso@redhat.com>
-rw-r--r--spice/vd_agent.h13
1 files changed, 12 insertions, 1 deletions
diff --git a/spice/vd_agent.h b/spice/vd_agent.h
index 3c4b89a..9342558 100644
--- a/spice/vd_agent.h
+++ b/spice/vd_agent.h
@@ -64,7 +64,9 @@ typedef struct SPICE_ATTR_PACKED VDAgentMessage {
* the "MainChannel" (server <-> client)
*/
enum {
- /* server -> agent */
+ /* server -> agent
+ * See VDAgentMouseState structure.
+ */
VD_AGENT_MOUSE_STATE = 1,
/* client -> agent|server.
* Acknowledged by the agent using VD_AGENT_REPLY.
@@ -85,6 +87,7 @@ enum {
* See VDAgentDisplayConfig structure.
*/
VD_AGENT_DISPLAY_CONFIG,
+ /* See VDAgentAnnounceCapabilities structure. */
VD_AGENT_ANNOUNCE_CAPABILITIES,
/* Asks to listen for clipboard changes (both directions).
* Remote should empty clipboard and wait for one
@@ -97,13 +100,21 @@ enum {
* See VDAgentClipboardRequest structure.
*/
VD_AGENT_CLIPBOARD_REQUEST,
+ /* See VDAgentClipboardRelease structure. */
VD_AGENT_CLIPBOARD_RELEASE,
+ /* See VDAgentFileXferStartMessage structure. */
VD_AGENT_FILE_XFER_START,
+ /* See VDAgentFileXferStatusMessage structure. */
VD_AGENT_FILE_XFER_STATUS,
+ /* See VDAgentFileXferDataMessage structure. */
VD_AGENT_FILE_XFER_DATA,
+ /* Empty message */
VD_AGENT_CLIENT_DISCONNECTED,
+ /* See VDAgentMaxClipboard structure. */
VD_AGENT_MAX_CLIPBOARD,
+ /* See VDAgentAudioVolumeSync structure. */
VD_AGENT_AUDIO_VOLUME_SYNC,
+ /* See VDAgentGraphicsDeviceInfo structure. */
VD_AGENT_GRAPHICS_DEVICE_INFO,
VD_AGENT_END_MESSAGE,
};