Changeset 80470 in vbox

Timestamp:

Aug 28, 2019 10:56:45 AM (5 years ago)

Author:

vboxsync

Message:

Shared Clipboard/URI: Docs.

Location:

trunk

Files:

trunk/include/VBox/HostServices/VBoxClipboardSvc.h

-              r80469
+              r80470
 /** Sends a list of available formats to the host.
  *  Formely known as VBOX_SHARED_CLIPBOARD_GUEST_FN_REPORT_FORMATS. */
 #define VBOX_SHARED_CLIPBOARD_GUEST_FN_FORMATS_WRITE         2
+#define VBOX_SHARED_CLIPBOARD_GUEST_FN_FORMATS_WRITE          2
 /** Reads data in specified format from the host. */
 #define VBOX_SHARED_CLIPBOARD_GUEST_FN_DATA_READ              3
 …
 #define VBOX_SHARED_CLIPBOARD_GUEST_FN_DATA_WRITE             4
+/** */
+/** Does the actual protocol handshake. If this message is not
+ *  being sent by the guest, the host handles that particular client
+ *  with the legacy protocol (v0).
+ *
+ *  New since protocol v1. */
 #define VBOX_SHARED_CLIPBOARD_GUEST_FN_CONNECT                5
 /** Peeks at the next message, returning immediately.

-              r80469
+              r80470
  * and could only handle simple data (like copied text and so on).
+ *
  * Since VBox 6.0 a newer protocol (v1) has been established to also support
+ * Since VBox 6.1 a newer protocol (v1) has been established to also support
  * file transfers. This protocol does not rely on the old ReportMsg() / ReturnMsg()
  * mechanism anymore and uses a (per-client) message queue instead
  * (see VBOX_SHARED_CLIPBOARD_GUEST_FN_GET_HOST_MSG_OLD vs. VBOX_SHARED_CLIPBOARD_GUEST_FN_GET_HOST_MSG).
+ *
+ * To distinguish the old (legacy) or new(er) protocol, the VBOX_SHARED_CLIPBOARD_GUEST_FN_CONNECT
+ * message has been introduced. If an older guest does not send this message,
+ * protocol v0 will be used by the host by default.
+ *
  * The protocol also support out-of-order messages by using so-called "context IDs",
 …
  * comes next; the guest side has to reply with the same conext ID which was sent by
  * the host request.
+ *
+ * Also see the protocol changelog at VBoxClipboardSvc.h.
+ *
  * @section sec_uri_intro               Transferring files

Note: See TracChangeset for help on using the changeset viewer.