xnu-2782.20.48.tar.gz

[apple/xnu.git] / iokit / IOKit / IOSharedDataQueue.h

diff --git a/iokit/IOKit/IOSharedDataQueue.h b/iokit/IOKit/IOSharedDataQueue.h
index a31cfc965bbace9680f1e5b06ee3a4c911d5290b..09c5dc17e41f010ef64f21ff9af6197b741c8e2b 100644 (file)
--- a/iokit/IOKit/IOSharedDataQueue.h
+++ b/iokit/IOKit/IOSharedDataQueue.h
@@ -33,8 +33,12 @@
 #undef dequeue
 #endif
 
+#define DISABLE_DATAQUEUE_WARNING /* IODataQueue is deprecated, please use IOSharedDataQueue instead */
+
 #include <IOKit/IODataQueue.h>
 
+#undef DISABLE_DATAQUEUE_WARNING
+
 typedef struct _IODataQueueEntry IODataQueueEntry;
 
 /*!
@@ -62,7 +66,21 @@ class IOSharedDataQueue : public IODataQueue
 protected:
     virtual void free();
 
+    /*!
+     * @function getQueueSize
+     * @abstract Returns the size of the data queue.
+     * @discussion Use this method to access the size of the data queue. Do not access the value of size directly, as it can get modified from userspace and is not reliable. 
+     * @result Returns the size of the data queue, or zero in case of failure.
+     */
     UInt32 getQueueSize();
+
+    /*!
+     * @function setQueueSize
+     * @abstract Stores the value of the size of the data queue.
+     * @discussion Use this method to store the value of the size of the data queue. Do not access the value of size directly, as it can get modified from userspace and is not reliable.
+     * @param size The size of the data queue.  
+     * @result Returns true in case of success, false otherwise.
+     */
     Boolean setQueueSize(UInt32 size);
 
 public: