Martin Willi
c295d0eb4b
removed buggy request parsing code, use ClearSilvers CGI kit instead fixed CHILD_SA listing in manager (needs better design) using secure XML communication through unix sockets removed images with questionable (non-GPL) license
85 lines
2.1 KiB
C
85 lines
2.1 KiB
C
/**
|
|
* @file controller.h
|
|
*
|
|
* @brief Interface controller_t.
|
|
*
|
|
*/
|
|
|
|
/*
|
|
* Copyright (C) 2007 Martin Willi
|
|
* Hochschule fuer Technik Rapperswil
|
|
*
|
|
* This program is free software; you can redistribute it and/or modify it
|
|
* under the terms of the GNU General Public License as published by the
|
|
* Free Software Foundation; either version 2 of the License, or (at your
|
|
* option) any later version. See <http://www.fsf.org/copyleft/gpl.txt>.
|
|
*
|
|
* This program is distributed in the hope that it will be useful, but
|
|
* WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY
|
|
* or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
|
|
* for more details.
|
|
*/
|
|
|
|
#ifndef CONTROLLER_H_
|
|
#define CONTROLLER_H_
|
|
|
|
#include "request.h"
|
|
#include "context.h"
|
|
|
|
typedef struct controller_t controller_t;
|
|
|
|
/**
|
|
* @brief Controller action handle function
|
|
*
|
|
* @param request http request
|
|
* @param response http response
|
|
*/
|
|
typedef void *(*controller_handler_t)(controller_t *this, request_t *request);
|
|
|
|
/**
|
|
* @brief Constructor function for a controller
|
|
*
|
|
* @param context session specific context
|
|
* @param param user supplied param
|
|
*/
|
|
typedef controller_t *(*controller_constructor_t)(context_t* context, void *param);
|
|
|
|
/**
|
|
* @brief Controller interface, to be implemented by users controllers.
|
|
*
|
|
*/
|
|
struct controller_t {
|
|
|
|
/**
|
|
* @brief Get the name of the controller.
|
|
*
|
|
* @return name of the controller
|
|
*/
|
|
char* (*get_name)(controller_t *this);
|
|
|
|
/**
|
|
* @brief Handle a HTTP request for that controller.
|
|
*
|
|
* Request URLs are parsed in the form
|
|
* controller_name/p1/p2/p3/p4/p5 with a maximum of 5 parameters. Each
|
|
* parameter not found in the request URL is set to NULL.
|
|
*
|
|
* @param request HTTP request
|
|
* @param p1 first parameter
|
|
* @param p2 second parameter
|
|
* @param p3 third parameter
|
|
* @param p4 forth parameter
|
|
* @param p5 fifth parameter
|
|
* @return
|
|
*/
|
|
void (*handle)(controller_t *this, request_t *request,
|
|
char *a1, char *a2, char *a3, char *a4, char *a5);
|
|
|
|
/**
|
|
* @brief Destroy the controller instance.
|
|
*/
|
|
void (*destroy) (controller_t *this);
|
|
};
|
|
|
|
#endif /* CONTROLLER_H_ */
|