include/metaproxy/filter.hpp

   1 /* This file is part of Metaproxy.
   2    Copyright (C) 2005-2012 Index Data
   3
   4 Metaproxy is free software; you can redistribute it and/or modify it under
   5 the terms of the GNU General Public License as published by the Free
   6 Software Foundation; either version 2, or (at your option) any later
   7 version.
   8
   9 Metaproxy is distributed in the hope that it will be useful, but WITHOUT ANY
  10 WARRANTY; without even the implied warranty of MERCHANTABILITY or
  11 FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
  12 for more details.
  13
  14 You should have received a copy of the GNU General Public License
  15 along with this program; if not, write to the Free Software
  16 Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301  USA
  17 */
  18
  19 #ifndef FILTER_HPP
  20 #define FILTER_HPP
  21
  22 #include <string>
  23 #include <stdexcept>
  24 #include <libxml/tree.h>
  25 #include "xmlutil.hpp"
  26
  27 namespace metaproxy_1 {
  28
  29     class Package;
  30
  31     namespace filter {
  32         class Base {
  33         public:
  34             virtual ~Base(){};
  35
  36             ///sends Package off to next Filter, returns altered Package
  37             virtual void process(Package & package) const = 0;
  38
  39             /// configuration during filter load
  40             virtual void configure(const xmlNode * ptr, bool test_only,
  41                                    const char *path) = 0;
  42
  43             virtual void start() const;
  44
  45             virtual void stop() const;
  46         };
  47
  48         class FilterException : public std::runtime_error {
  49         public:
  50             FilterException(const std::string message)
  51                 : std::runtime_error("FilterException: " + message){
  52             };
  53         };
  54     }
  55 }
  56
  57 struct metaproxy_1_filter_struct {
  58     int ver;
  59     const char *type;
  60     metaproxy_1::filter::Base* (*creator)();
  61 };
  62
  63 #endif
  64 /*
  65  * Local variables:
  66  * c-basic-offset: 4
  67  * c-file-style: "Stroustrup"
  68  * indent-tabs-mode: nil
  69  * End:
  70  * vim: shiftwidth=4 tabstop=8 expandtab
  71  */
  72