[Modcplusplus-devel] (johnksterling) mod_cplusplus/include apache_filters.h

[Mod C. C. L. <mod...@so...>]

Mod Cplusplus CVS committal

Author  : johnksterling
Project : mod_cplusplus
Module  : include
Dir     : mod_cplusplus/include



Modified Files:
	apache_filters.h 


Log Message:
add docs to filter api
===================================================================
RCS file: /cvsroot/modcplusplus/mod_cplusplus/include/apache_filters.h,v
retrieving revision 1.7
retrieving revision 1.8
diff -u -3 -r1.7 -r1.8
--- apache_filters.h	19 Jun 2002 14:11:07 -0000	1.7
+++ apache_filters.h	3 Apr 2005 18:58:44 -0000	1.8
@@ -16,14 +16,43 @@
 class MODCPP_API ApacheInputFilter : public ApacheBase
 {
 public:
+    /**
+     * \brief Constructor for your input filter - called when the child thread/process is initiated
+     **/
     ApacheInputFilter() { }
+
+    /**
+     * \brief Constructor for your input filter - called when the child thread/process is cleaned up
+     **/
     virtual ~ApacheInputFilter() { }
+
+    /**
+     * \brief connection_input_filter is called to process data.  This is calleed once per brigade of data
+     *
+     * \param f the filter context
+     * \param b the bucket brigade of data
+     * \param eMode input filtering node (e.g. AP_MODE_GETLINE)
+     * \param eBlock tells the filter wether or not it should block
+     * \param readbytes if the eMode is AP_MODE_READBYTESÊthis tells the module how many bytes
+     **/
     virtual apr_status_t connection_input_filter(ap_filter_t *f, 
                                                  apr_bucket_brigade *b,
                                                  ap_input_mode_t eMode, 
                                                  apr_read_type_e eBlock,
                                                  apr_off_t readbytes)
     { return DECLINED; }
+
+    /**
+     * \brief request_input_filter is called to process data.  This is calleed once per brigade of data
+     * for a request
+     *
+     * \param f the filter context
+     * \param b the bucket brigade of data
+     * \param eMode input filtering node (e.g. AP_MODE_GETLINE)
+     * \param eBlock tells the filter wether or not it should block
+     * \param readbytes if the eMode is AP_MODE_READBYTESÊthis tells the module how many bytes
+     **/
+
     virtual apr_status_t request_input_filter(ap_filter_t *f, 
                                               apr_bucket_brigade *b,
                                               ap_input_mode_t eMode, 
@@ -35,12 +64,32 @@
 class MODCPP_API ApacheOutputFilter : public ApacheBase
 {
 public:
+    /**
+     * \brief Constructor for your output filter - called when the child thread/process is initiated
+     **/
     ApacheOutputFilter() { }
+
+    /**
+     * \brief Destructor for your output filter - called when the child thread/process is cleaned up
+     **/
     virtual ~ApacheOutputFilter() { }
+
+    /**
+     * \brief connection_output_filter is the method thats called for you to handle data
+     *
+     * \param f the filter context
+     * \param b the brigade to filter
+     **/
     virtual int connection_output_filter(ap_filter_t *f, 
                                          apr_bucket_brigade *b)
     { return DECLINED; }
     
+    /**
+     * \brief request_output_filter is the method thats called for you to handle data
+     *
+     * \param f the filter context
+     * \param b the brigade to filter
+     **/
     virtual int request_output_filter(ap_filter_t *f, apr_bucket_brigade *b) 
     { return DECLINED; }
 };