]> granicus.if.org Git - apache/commitdiff
Make ap_register_output_filter back into a function (*sigh*)
authorNick Kew <niq@apache.org>
Wed, 12 Oct 2005 20:43:25 +0000 (20:43 +0000)
committerNick Kew <niq@apache.org>
Wed, 12 Oct 2005 20:43:25 +0000 (20:43 +0000)
but update its API doc

git-svn-id: https://svn.apache.org/repos/asf/httpd/httpd/trunk@315041 13f79535-47bb-0310-9956-ffa450edef68

include/util_filter.h
server/util_filter.c

index 26a6245df266b03d23f89d14aef0311146e928b5..bb3e1094fb89ce037583975d2274dbcb054147b0 100644 (file)
@@ -328,30 +328,22 @@ AP_DECLARE(ap_filter_rec_t *) ap_register_input_filter(const char *name,
                                           ap_init_filter_func filter_init,
                                           ap_filter_type ftype);
 
-/**
- * This function is used to register an output filter with the system. 
- * After this registration is performed, then a filter may be added 
- * into the filter chain by using ap_add_output_filter() and simply 
- * specifying the name.  It may also be used as a provider under mod_filter.
- * This is (equivalent to) ap_register_output_filter_protocol with
- * proto_flags=0, and is retained for back-compatibility with 2.0 modules.
- *
- * @param name The name to attach to the filter function
- * @param filter_func The filter function to name
- * @param filter_init The function to call before the filter handlers 
- *                    are invoked
- * @param ftype The type of filter function, either ::AP_FTYPE_CONTENT or
- *              ::AP_FTYPE_CONNECTION
- * @see ap_add_output_filter()
- */
+/** @deprecated @see ap_register_output_filter_protocol */
+AP_DECLARE(ap_filter_rec_t *) ap_register_output_filter(const char *name,
+                                            ap_out_filter_func filter_func,
+                                            ap_init_filter_func filter_init,
+                                            ap_filter_type ftype);
+
+/* For httpd-?.? I suggest replacing the above with
 #define ap_register_output_filter(name,ffunc,init,ftype) \
              ap_register_output_filter_protocol(name,ffunc,init,ftype,0)
+*/
 
 /**
  * This function is used to register an output filter with the system. 
  * After this registration is performed, then a filter may be added 
- * into the filter chain by using ap_add_output_filter() and simply 
- * specifying the name.  It may also be used as a provider under mod_filter.
+ * directly to the filter chain by using ap_add_output_filter() and
+ * simply specifying the name, or as a provider under mod_filter.
  *
  * @param name The name to attach to the filter function
  * @param filter_func The filter function to name
@@ -360,6 +352,7 @@ AP_DECLARE(ap_filter_rec_t *) ap_register_input_filter(const char *name,
  * @param ftype The type of filter function, either ::AP_FTYPE_CONTENT or
  *              ::AP_FTYPE_CONNECTION
  * @param proto_flags Protocol flags: logical OR of AP_FILTER_PROTO_* bits
+ * @return the filter rec
  * @see ap_add_output_filter()
  */
 AP_DECLARE(ap_filter_rec_t *) ap_register_output_filter_protocol(
index 0b23edc1d5bc25fc89075920fb72a33b1a965f61..9a59f9160218ebd8f0a48971c3333aea19244580 100644 (file)
@@ -248,6 +248,15 @@ AP_DECLARE(ap_filter_rec_t *) ap_register_input_filter(const char *name,
                            &registered_input_filters);
 }                                                                    
 
+AP_DECLARE(ap_filter_rec_t *) ap_register_output_filter(const char *name,
+                                           ap_out_filter_func filter_func,
+                                           ap_init_filter_func filter_init,
+                                           ap_filter_type ftype)
+{
+    return ap_register_output_filter_protocol(name, filter_func,
+                                              filter_init, ftype, 0);
+}
+
 AP_DECLARE(ap_filter_rec_t *) ap_register_output_filter_protocol(
                                            const char *name,
                                            ap_out_filter_func filter_func,