Changeset 43462 in vbox for trunk/include

Timestamp:

Sep 28, 2012 10:46:41 AM (12 years ago)

Author:

vboxsync

svn:sync-xref-src-repo-rev:

80995

Message:

HGCM Host Channel service: implemented a generic Query function.

Location:

trunk/include/VBox

Files:

• HostServices/VBoxHostChannel.h (modified) (4 diffs)
• VBoxGuestLib.h (modified) (1 diff)

trunk/include/VBox/HostServices/VBoxHostChannel.h

@@ -45 +45 @@
 #define VBOX_HOST_CHANNEL_FN_SEND         3 /* Send data to the host. */
 #define VBOX_HOST_CHANNEL_FN_RECV         4 /* Receive data from the host. */
-#define VBOX_HOST_CHANNEL_FN_CONTROL      5 /* Generic data exchange. */
+#define VBOX_HOST_CHANNEL_FN_CONTROL      5 /* Generic data exchange using a channel instance. */
 #define VBOX_HOST_CHANNEL_FN_EVENT_WAIT   6 /* Blocking wait for a host event. */
 #define VBOX_HOST_CHANNEL_FN_EVENT_CANCEL 7 /* Cancel the blocking wait. */
+#define VBOX_HOST_CHANNEL_FN_QUERY        8 /* Generic data exchange using a channel name. */
 
 /*
@@ -56 +57 @@
 #define VBOX_HOST_CHANNEL_EVENT_RECV         2    /* Data is available for receiving. */
 #define VBOX_HOST_CHANNEL_EVENT_USER         1000 /* Base of channel specific events. */
+
+/*
+ * The common control code ids for the VBOX_HOST_CHANNEL_FN_[CONTROL|QUERY]
+ */
+#define VBOX_HOST_CHANNEL_CTRL_EXISTS     0    /* Whether the channel instance or provider exists. */
+#define VBOX_HOST_CHANNEL_CTRL_USER       1000 /* Base of channel specific events. */
 
 #pragma pack(1)
@@ -122 +129 @@
     VBoxGuestHGCMCallInfo hdr;
 } VBoxHostChannelEventCancel;
+
+typedef struct VBoxHostChannelQuery
+{
+    VBoxGuestHGCMCallInfo hdr;
+    HGCMFunctionParameter name;   /* IN linear ptr: Channel name utf8 nul terminated. */
+    HGCMFunctionParameter code;   /* IN uint32_t: The control code. */
+    HGCMFunctionParameter parm;   /* IN linear pointer: Parameters of the function. */
+    HGCMFunctionParameter data;   /* OUT linear pointer: Buffer for results. */
+    HGCMFunctionParameter sizeDataReturned; /* OUT uint32_t: Bytes returned in the 'data' buffer. */
+} VBoxHostChannelQuery;
 
 
@@ -180 +197 @@
                                                    uint32_t *pcbReceived, uint32_t *pcbRemaining));
 
-    /* The guest talks to the provider of the channel. */
+    /* The guest talks to the provider of the channel.
+     * @param pvChannel The channel instance. NULL if the target is the provider, rather than a channel.
+     */
     DECLR3CALLBACKMEMBER(int, HostChannelControl, (void *pvChannel, uint32_t u32Code,
                                                    const void *pvParm, uint32_t cbParm,

trunk/include/VBox/VBoxGuestLib.h

@@ -737 +737 @@
                                             uint32_t *pu32SizeReturned);
 VBGLR3DECL(int)  VbglR3HostChannelEventCancel(uint32_t u32ChannelHandle, uint32_t u32HGCMClientId);
+VBGLR3DECL(int)  VbglR3HostChannelQuery(const char *pszName, uint32_t u32HGCMClientId, uint32_t u32Code,
+                                        void *pvParm, uint32_t cbParm, void *pvData, uint32_t cbData,
+                                        uint32_t *pu32SizeDataReturned);
 
 #endif /* IN_RING3 */