handler_example.h

   1 /* -*- Mode: C; tab-width: 8; indent-tabs-mode: t; c-basic-offset: 8 -*- */
   2
   3 /* Cherokee
   4  *
   5  * Authors:
   6  *      Alvaro Lopez Ortega <alvaro@alobbs.com>
   7  *      Stefan de Konink <stefan@konink.de>
   8  *
   9  * Copyright (C) 2001-2008 Alvaro Lopez Ortega
  10  *
  11  * This program is free software; you can redistribute it and/or
  12  * modify it under the terms of version 2 of the GNU General Public
  13  * License as published by the Free Software Foundation.
  14  *
  15  * This program is distributed in the hope that it will be useful,
  16  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  17  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  18  * GNU General Public License for more details.
  19  *
  20  * You should have received a copy of the GNU General Public License
  21  * along with this program; if not, write to the Free Software
  22  * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307
  23  * USA
  24  */
  25
  26 #ifndef CHEROKEE_HANDLER_EXAMPLE_H
  27 #define CHEROKEE_HANDLER_EXAMPLE_H
  28
  29 /*
  30 #include "common.h"
  31 #include "buffer.h"
  32 #include "handler.h"
  33 #include "connection.h"
  34 #include "plugin_loader.h"
  35 */
  36
  37 #include <cherokee/cherokee.h>
  38
  39 /* Data types
  40  */
  41 typedef struct {
  42         cherokee_module_props_t  base;
  43
  44     /* Configuration parameters */
  45         cherokee_boolean_t       example_config;
  46 } cherokee_handler_example_props_t;
  47
  48 typedef struct {
  49     /* Shared structures */
  50         cherokee_handler_t       handler;
  51
  52     /* A buffer is your output 'to be' */
  53         cherokee_buffer_t        buffer;
  54
  55     enum {
  56         send_page,
  57         send_yourmother /* not advised but possible */
  58     } action; /* this could implement a state machine */
  59 } cherokee_handler_example_t;
  60
  61 #define HDL_EXAMPLE(x)       ((cherokee_handler_example_t *)(x))
  62 #define PROP_EXAMPLE(x)      ((cherokee_handler_example_props_t *)(x))
  63 #define HDL_EXAMPLE_PROPS(x) (PROP_EXAMPLE(MODULE(x)->props))
  64
  65
  66 /* Library init function
  67  */
  68 void  PLUGIN_INIT_NAME(example)      (cherokee_plugin_loader_t *loader);
  69 ret_t cherokee_handler_example_new   (cherokee_handler_t **hdl, cherokee_connection_t *cnt, cherokee_module_props_t *props);
  70
  71 /* virtual methods implementation
  72  */
  73 ret_t cherokee_handler_example_init        (cherokee_handler_example_t *hdl);
  74 ret_t cherokee_handler_example_free        (cherokee_handler_example_t *hdl);
  75 ret_t cherokee_handler_example_step        (cherokee_handler_example_t *hdl, cherokee_buffer_t *buffer);
  76 ret_t cherokee_handler_example_add_headers (cherokee_handler_example_t *hdl, cherokee_buffer_t *buffer);
  77
  78 #endif /* CHEROKEE_HANDLER_EXAMPLE_H */