src/libfast/filter.h

   1 /*
   2  * Copyright (C) 2008 Martin Willi
   3  * Hochschule fuer Technik Rapperswil
   4  *
   5  * This program is free software; you can redistribute it and/or modify it
   6  * under the terms of the GNU General Public License as published by the
   7  * Free Software Foundation; either version 2 of the License, or (at your
   8  * option) any later version.  See <http://www.fsf.org/copyleft/gpl.txt>.
   9  *
  10  * This program is distributed in the hope that it will be useful, but
  11  * WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY
  12  * or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
  13  * for more details.
  14  */
  15
  16 /*
  17  * @defgroup filter filter
  18  * @{ @ingroup libfast
  19  */
  20
  21 #ifndef FILTER_H_
  22 #define FILTER_H_
  23
  24 #include "request.h"
  25 #include "context.h"
  26 #include "controller.h"
  27
  28 typedef struct filter_t filter_t;
  29
  30 /**
  31  * Constructor function for a filter
  32  *
  33  * @param context               session specific context
  34  * @param param                 user supplied param
  35  */
  36 typedef filter_t *(*filter_constructor_t)(context_t* context, void *param);
  37
  38 /**
  39  * Filter interface, to be implemented by users filters.
  40  */
  41 struct filter_t {
  42
  43         /**
  44          * Called before the controller handles the request.
  45          *
  46          * @param request               HTTP request
  47          * @param p1                    first parameter
  48          * @param p2                    second parameter
  49          * @param p3                    third parameter
  50          * @param p4                    forth parameter
  51          * @param p5                    fifth parameter
  52          * @return                              TRUE to continue request handling
  53          */
  54         bool (*run)(filter_t *this, request_t *request,
  55                                 char *p0, char *p1, char *p2, char *p3, char *p4, char *p5);
  56
  57         /**
  58          * Destroy the filter instance.
  59          */
  60         void (*destroy) (filter_t *this);
  61 };
  62
  63 #endif /* FILTER_H_ @} */