Public Member Functions | Static Public Member Functions

fawkes::WebRequestDispatcher Class Reference

Web request dispatcher. More...

#include "request_dispatcher.h"

List of all members.

Public Member Functions

 WebRequestDispatcher (WebPageHeaderGenerator *headergen=0, WebPageFooterGenerator *footergen=0)
 Constructor.
void add_processor (const char *url_prefix, WebRequestProcessor *processor)
 Add a request processor.
void remove_processor (const char *url_prefix)
 Remove a request processor.
int queue_static_reply (struct MHD_Connection *connection, StaticWebReply *sreply)
 Queue a static web reply.
int process_request (struct MHD_Connection *connection, const char *url, const char *method, const char *version, const char *upload_data, size_t *upload_data_size, void **session_data)
 Process request callback for libmicrohttpd.

Static Public Member Functions

static int process_request_cb (void *callback_data, struct MHD_Connection *connection, const char *url, const char *method, const char *version, const char *upload_data, size_t *upload_data_size, void **session_data)
 Process request callback for libmicrohttpd.

Detailed Description

Web request dispatcher.

Takes web request received via a webserver run by libmicrohttpd and dispatches pages to registered WebRequestProcessor instances or gives a 404 error if no processor was registered for the given base url.

Author:
Tim Niemueller

Definition at line 42 of file request_dispatcher.h.


Constructor & Destructor Documentation

fawkes::WebRequestDispatcher::WebRequestDispatcher ( WebPageHeaderGenerator headergen = 0,
WebPageFooterGenerator footergen = 0 
)

Constructor.

Parameters:
headergen page header generator
footergen page footer generator

Definition at line 54 of file request_dispatcher.cpp.


Member Function Documentation

void fawkes::WebRequestDispatcher::add_processor ( const char *  url_prefix,
WebRequestProcessor processor 
)

Add a request processor.

Parameters:
url_prefix baseurl this processor should handle
processor processor for baseurl

Definition at line 273 of file request_dispatcher.cpp.

int fawkes::WebRequestDispatcher::process_request ( struct MHD_Connection *  connection,
const char *  url,
const char *  method,
const char *  version,
const char *  upload_data,
size_t *  upload_data_size,
void **  session_data 
)

Process request callback for libmicrohttpd.

Parameters:
connection libmicrohttpd connection instance
url URL, may contain escape sequences
method HTTP method
version HTTP version
upload_data uploaded data
upload_data_size size of upload_data parameter
session_data session data pointer
Returns:
appropriate return code for libmicrohttpd

Definition at line 171 of file request_dispatcher.cpp.

References fawkes::DynamicWebReply::chunk_size(), fawkes::WebRequestProcessor::handles_session_data(), fawkes::hex_unescape(), fawkes::WebReply::HTTP_INTERNAL_SERVER_ERROR, fawkes::WebReply::HTTP_NOT_FOUND, fawkes::WebRequestProcessor::process_request(), queue_static_reply(), and fawkes::DynamicWebReply::size().

Referenced by process_request_cb().

int fawkes::WebRequestDispatcher::process_request_cb ( void *  callback_data,
struct MHD_Connection *  connection,
const char *  url,
const char *  method,
const char *  version,
const char *  upload_data,
size_t *  upload_data_size,
void **  session_data 
) [static]

Process request callback for libmicrohttpd.

Parameters:
callback_data instance of WebRequestDispatcher to call
connection libmicrohttpd connection instance
url URL, may contain escape sequences
method HTTP method
version HTTP version
upload_data uploaded data
upload_data_size size of upload_data parameter
session_data session data pointer
Returns:
appropriate return code for libmicrohttpd

Definition at line 74 of file request_dispatcher.cpp.

References process_request().

Referenced by fawkes::WebServer::WebServer().

int fawkes::WebRequestDispatcher::queue_static_reply ( struct MHD_Connection *  connection,
StaticWebReply sreply 
)

Queue a static web reply.

Parameters:
connection libmicrohttpd connection to queue response to
sreply static web reply to queue
Returns:
suitable libmicrohttpd return code

Definition at line 127 of file request_dispatcher.cpp.

References fawkes::StaticWebReply::body(), fawkes::StaticWebReply::body_length(), fawkes::WebReply::code(), fawkes::WebReply::headers(), fawkes::StaticWebReply::pack(), and fawkes::WebPageReply::pack().

Referenced by process_request().

void fawkes::WebRequestDispatcher::remove_processor ( const char *  url_prefix  ) 

Remove a request processor.

Parameters:
url_prefix baseurl the processor handled

Definition at line 288 of file request_dispatcher.cpp.


The documentation for this class was generated from the following files: