summaryrefslogtreecommitdiff
path: root/examples/Content_Server/AMI_Observer/Push_Iterator_Handler.h
diff options
context:
space:
mode:
Diffstat (limited to 'examples/Content_Server/AMI_Observer/Push_Iterator_Handler.h')
-rw-r--r--examples/Content_Server/AMI_Observer/Push_Iterator_Handler.h63
1 files changed, 31 insertions, 32 deletions
diff --git a/examples/Content_Server/AMI_Observer/Push_Iterator_Handler.h b/examples/Content_Server/AMI_Observer/Push_Iterator_Handler.h
index 5e973a68824..3d4bbe18053 100644
--- a/examples/Content_Server/AMI_Observer/Push_Iterator_Handler.h
+++ b/examples/Content_Server/AMI_Observer/Push_Iterator_Handler.h
@@ -1,21 +1,18 @@
// -*- C++ -*-
-// $Id$
-
-// ============================================================================
-//
-// = LIBRARY
-// AMI_Observer
-//
-// = FILENAME
-// Push_Iterator_Handler.h
-//
-// = DESCRIPTION
-// Header file for the AMI_Iterator_FactoryHandler implementation.
-//
-// = AUTHOR
-// Ossama Othman <ossama@uci.edu>
-//
-// ============================================================================
+
+//=============================================================================
+/**
+ * @file Push_Iterator_Handler.h
+ *
+ * $Id$
+ *
+ * Header file for the AMI_Iterator_FactoryHandler implementation.
+ *
+ *
+ * @author Ossama Othman <ossama@uci.edu>
+ */
+//=============================================================================
+
#ifndef PUSH_ITERATOR_HANDLER_H
#define PUSH_ITERATOR_HANDLER_H
@@ -52,49 +49,51 @@ class Push_Iterator_Handler
// use for this <Push_Iterator_Handler> object, and it is
// deactivated.
+ /// Dummy friend class declaration to quiet down a warning.
friend class Push_Iterator_Handler_Friend;
- // Dummy friend class declaration to quiet down a warning.
public:
+ /// Constructor that creates a content iterator corresponding to the
+ /// name of the file being retrieved from the web server.
Push_Iterator_Handler (void);
- // Constructor that creates a content iterator corresponding to the
- // name of the file being retrieved from the web server.
+ /**
+ * Activate and run this Reply Handler. The contents (not the
+ * pointer itself) of the <request_count> parameter will be
+ * incremented when file retrieval begins, and decremented when file
+ * retrieval completes.
+ */
void run (int *request_count,
const char *pathname,
Web_Server::Iterator_Factory_ptr factory);
- // Activate and run this Reply Handler. The contents (not the
- // pointer itself) of the <request_count> parameter will be
- // incremented when file retrieval begins, and decremented when file
- // retrieval completes.
private:
+ /// Destructor (private to ensure that Iterator_Handler is allocated
+ /// on the heap).
~Push_Iterator_Handler (void);
- // Destructor (private to ensure that Iterator_Handler is allocated
- // on the heap).
+ /// AMI callback that is invoked when a response from the
+ /// corresponding server method is received.
virtual void register_callback
(const Web_Server::Metadata_Type &metadata);
- // AMI callback that is invoked when a response from the
- // corresponding server method is received.
virtual void register_callback_excep
(::Messaging::ExceptionHolder *)
{}
+ /// Deactivate this handler.
void deactivate (void);
- // Deactivate this handler.
private:
+ /// The servant that accepts data pushed from the content server.
Callback_i *callback_servant_;
- // The servant that accepts data pushed from the content server.
+ /// Reference to the callback object the server sends data to.
Web_Server::Callback_var callback_;
- // Reference to the callback object the server sends data to.
+ /// Reference to this Reply Handler's self.
Web_Server::AMI_Iterator_FactoryHandler_var ami_handler_;
- // Reference to this Reply Handler's self.
};
#endif /* PUSH_ITERATOR_HANDLER_H */