Changeset 2681 for branches/blt4/packages/vizservers/vtkvis/ResponseQueue.h

Timestamp:

Nov 15, 2011 11:56:51 AM (12 years ago)

Author:

gah

Message:

 

File:

• branches/blt4/packages/vizservers/vtkvis/ResponseQueue.h (modified) (8 diffs)

branches/blt4/packages/vizservers/vtkvis/ResponseQueue.h

@@ -17 +17 @@
 namespace VtkVis {
 
+/**
+ * \brief Holds data for a response to be sent to client
+ */
 class Response
 {
@@ -40 +43 @@
     virtual ~Response()
     {
-        if (_length > 0) {
-            if (_allocType == DYNAMIC) {
-                free(_mesg);
-            }
+        if ((_length > 0) && (_mesg != NULL) && (_allocType == DYNAMIC)) {
+            free(_mesg);
         }
     }
 
+    /// Get the ResponseType
     ResponseType type()
     {
@@ -52 +54 @@
     }
 
+    /// Get the Response data
     unsigned char *message()
     {
@@ -57 +60 @@
     }
 
+    /// Get the number of bytes in the Response data
     size_t length()
     {
@@ -62 +66 @@
     }
 
+    /// Set the message/data making up the Response
+    /**
+     * If the AllocationType is DYNAMIC, the message data will be free()d
+     * by the destructor.  If the AllocationType is VOLATILE, a copy of 
+     * the message data will be made.
+     *
+     * \param[in] mesg The Response data, can be a command and/or binary data
+     * \param[in] length The number of bytes in mesg
+     * \param[in] type Specify how the memory was allocated for mesg
+     */ 
     void setMessage(unsigned char *mesg, size_t length, AllocationType type)
     {
@@ -86 +100 @@
 };
 
+/**
+ * \brief Queue to hold pending Responses to be sent to the client
+ *
+ * A semaphore and mutex are used to control access to the 
+ * queue by a reader and writer thread
+ */
 class ResponseQueue
 {
@@ -93 +113 @@
     virtual ~ResponseQueue();
 
+    /// A place to store a data pointer.  Not used internally.
+    /* XXX: This probably doesn't belong here */
     void *clientData()
     {
@@ -98 +120 @@
     }
 
+    /// Add a response to the end of the queue
     void enqueue(Response *response);
 
+    /// Remove a response from the front of the queue
     Response *dequeue();