Changeset 36321 in vbox for trunk/src/VBox/Additions

Timestamp:

Mar 21, 2011 10:42:55 AM (14 years ago)

Author:

vboxsync

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

70647

Message:

VBoxServicePipeBuf.*: nits.

Location:

trunk/src/VBox/Additions/common/VBoxService

Files:

• VBoxServicePipeBuf.cpp (modified) (10 diffs)
• VBoxServicePipeBuf.h (modified) (3 diffs)

trunk/src/VBox/Additions/common/VBoxService/VBoxServicePipeBuf.cpp

@@ -1 @@
-/* $Id: */
+/* $Id$ */
 /** @file
  * VBoxServicePipeBuf - Pipe buffering.
@@ -5 +5 @@
 
 /*
- * Copyright (C) 2011 Oracle Corporation
+ * Copyright (C) 2010-2011 Oracle Corporation
  *
  * This file is part of VirtualBox Open Source Edition (OSE), as
@@ -39 +39 @@
 int VBoxServicePipeBufInit(PVBOXSERVICECTRLEXECPIPEBUF pBuf, bool fNeedNotificationPipe)
 {
-    AssertPtrReturn(pBuf, VERR_INVALID_PARAMETER);
+    AssertPtrReturn(pBuf, VERR_INVALID_POINTER);
 
     /** @todo Add allocation size as function parameter! */
@@ -85 +85 @@
                            uint8_t *pbBuffer, uint32_t cbBuffer, uint32_t *pcbToRead)
 {
-    AssertPtrReturn(pBuf, VERR_INVALID_PARAMETER);
-    AssertPtrReturn(pbBuffer, VERR_INVALID_PARAMETER);
+    AssertPtrReturn(pBuf, VERR_INVALID_POINTER);
+    AssertPtrReturn(pbBuffer, VERR_INVALID_POINTER);
     AssertReturn(cbBuffer, VERR_INVALID_PARAMETER);
-    AssertPtrReturn(pcbToRead, VERR_INVALID_PARAMETER);
+    AssertPtrReturn(pcbToRead, VERR_INVALID_POINTER);
 
     int rc = RTCritSectEnter(&pBuf->CritSect);
@@ -133 +133 @@
                                  uint32_t *pcbWritten)
 {
-    AssertPtrReturn(pBuf, VERR_INVALID_PARAMETER);
+    AssertPtrReturn(pBuf, VERR_INVALID_POINTER);
 
     int rc = RTCritSectEnter(&pBuf->CritSect);
     if (RT_SUCCESS(rc))
     {
-        AssertPtrReturn(pbData, VERR_INVALID_PARAMETER);
+        AssertPtrReturn(pbData, VERR_INVALID_POINTER);
         if (pBuf->fEnabled)
         {
@@ -236 +236 @@
                                   size_t *pcbWritten, size_t *pcbLeft)
 {
-    AssertPtrReturn(pBuf, VERR_INVALID_PARAMETER);
-    AssertPtrReturn(pcbWritten, VERR_INVALID_PARAMETER);
+    AssertPtrReturn(pBuf, VERR_INVALID_POINTER);
+    AssertPtrReturn(pcbWritten, VERR_INVALID_POINTER);
 
     int rc = RTCritSectEnter(&pBuf->CritSect);
@@ -314 +314 @@
 bool VBoxServicePipeBufIsEnabled(PVBOXSERVICECTRLEXECPIPEBUF pBuf)
 {
-    AssertPtrReturn(pBuf, VERR_INVALID_PARAMETER);
+    AssertPtrReturn(pBuf, VERR_INVALID_POINTER);
 
     bool fEnabled = false;
@@ -338 +338 @@
 bool VBoxServicePipeBufIsClosing(PVBOXSERVICECTRLEXECPIPEBUF pBuf)
 {
-    AssertPtrReturn(pBuf, VERR_INVALID_PARAMETER);
+    AssertPtrReturn(pBuf, VERR_INVALID_POINTER);
 
     bool fClosing = false;
@@ -360 +360 @@
 int VBoxServicePipeBufSetStatus(PVBOXSERVICECTRLEXECPIPEBUF pBuf, bool fEnabled)
 {
-    AssertPtrReturn(pBuf, VERR_INVALID_PARAMETER);
+    AssertPtrReturn(pBuf, VERR_INVALID_POINTER);
 
     int rc = RTCritSectEnter(&pBuf->CritSect);
@@ -391 +391 @@
 /**
  * Deletes a pipe buffer.
- * Note: Not thread safe -- only call this when nobody is relying on the
- *       data anymore!
+ *
+ * @note    Not thread safe -- only call this when nobody is relying on the
+ *          data anymore!
  *
  * @param   pBuf            The pipe buffer.

trunk/src/VBox/Additions/common/VBoxService/VBoxServicePipeBuf.h

@@ -1 @@
-/* $Id: */
+/* $Id$ */
 /** @file
  * VBoxServicePipeBuf - Pipe buffering.
@@ -5 +5 @@
 
 /*
- * Copyright (C) 2011 Oracle Corporation
+ * Copyright (C) 2010-2011 Oracle Corporation
  *
  * This file is part of VirtualBox Open Source Edition (OSE), as
@@ -21 +21 @@
 #include "VBoxServiceInternal.h"
 
-int VBoxServicePipeBufInit(PVBOXSERVICECTRLEXECPIPEBUF pBuf, bool fNeedNotificationPipe);
-int VBoxServicePipeBufRead(PVBOXSERVICECTRLEXECPIPEBUF pBuf,
-                                  uint8_t *pbBuffer, uint32_t cbBuffer, uint32_t *pcbToRead);
-int VBoxServicePipeBufWriteToBuf(PVBOXSERVICECTRLEXECPIPEBUF pBuf,
-                                 uint8_t *pbData, uint32_t cbData, bool fPendingClose, uint32_t *pcbWritten);
-int VBoxServicePipeBufWriteToPipe(PVBOXSERVICECTRLEXECPIPEBUF pBuf, RTPIPE hPipe,
-                                  size_t *pcbWritten, size_t *pcbLeft);
+int  VBoxServicePipeBufInit(PVBOXSERVICECTRLEXECPIPEBUF pBuf, bool fNeedNotificationPipe);
+int  VBoxServicePipeBufRead(PVBOXSERVICECTRLEXECPIPEBUF pBuf,
+                            uint8_t *pbBuffer, uint32_t cbBuffer, uint32_t *pcbToRead);
+int  VBoxServicePipeBufWriteToBuf(PVBOXSERVICECTRLEXECPIPEBUF pBuf,
+                                  uint8_t *pbData, uint32_t cbData, bool fPendingClose, uint32_t *pcbWritten);
+int  VBoxServicePipeBufWriteToPipe(PVBOXSERVICECTRLEXECPIPEBUF pBuf, RTPIPE hPipe,
+                                   size_t *pcbWritten, size_t *pcbLeft);
 bool VBoxServicePipeBufIsEnabled(PVBOXSERVICECTRLEXECPIPEBUF pBuf);
 bool VBoxServicePipeBufIsClosing(PVBOXSERVICECTRLEXECPIPEBUF pBuf);
-int VBoxServicePipeBufSetStatus(PVBOXSERVICECTRLEXECPIPEBUF pBuf, bool fEnabled);
-int VBoxServicePipeBufWaitForEvent(PVBOXSERVICECTRLEXECPIPEBUF pBuf, RTMSINTERVAL cMillies);
+int  VBoxServicePipeBufSetStatus(PVBOXSERVICECTRLEXECPIPEBUF pBuf, bool fEnabled);
+int  VBoxServicePipeBufWaitForEvent(PVBOXSERVICECTRLEXECPIPEBUF pBuf, RTMSINTERVAL cMillies);
 void VBoxServicePipeBufDestroy(PVBOXSERVICECTRLEXECPIPEBUF pBuf);
 
-#endif  /* ___VBoxServicePipeBuf_h */
+#endif  /* !___VBoxServicePipeBuf_h */