KLone APIs | Modules | Data Structures | File List | Data Fields | Globals

request.h

Go to the documentation of this file.
00001 /*
00002  * Copyright (c) 2005, 2006 by KoanLogic s.r.l. <http://www.koanlogic.com>
00003  * All rights reserved.
00004  *
00005  * This file is part of KLone, and as such it is subject to the license stated
00006  * in the LICENSE file which you have received as part of this distribution.
00007  *
00008  * $Id: request.h,v 1.22 2009/10/23 14:08:28 tho Exp $
00009  */
00010 
00011 #ifndef _KLONE_REQUEST_H_
00012 #define _KLONE_REQUEST_H_
00013 
00014 #include <sys/types.h>
00015 #include <time.h>
00016 #include <u/libu.h>
00017 #include <klone/header.h>
00018 #include <klone/io.h>
00019 #include <klone/http.h>
00020 #include <klone/vars.h>
00021 #include <klone/addr.h>
00022 #include <klone/vhost.h>
00023 
00024 #ifdef __cplusplus
00025 extern "C" {
00026 #endif
00027 
00028 struct request_s;
00029 typedef struct request_s request_t;
00030 
00031 int request_create(http_t *h, request_t **prq);
00032 int request_free(request_t *rq);
00033 int request_bind(request_t *rq, io_t *);
00034 int request_parse_header(request_t *rq, 
00035         int (*is_valid_url)(void*, const char *, size_t),
00036         void* arg);
00037 int request_parse_data(request_t *rq);
00038 
00039 io_t* request_io(request_t *rq);
00040 http_t* request_get_http(request_t *rq);
00041 kaddr_t* request_get_addr(request_t *rq);
00042 kaddr_t* request_get_peer_addr(request_t *rq);
00043 header_t* request_get_header(request_t *rq);
00044 field_t* request_get_field(request_t *rq, const char *name);
00045 const char* request_get_field_value(request_t *rq, const char *name);
00046 const char *request_get_client_request(request_t *rq);
00047 const char *request_get_uri(request_t *rq);
00048 const char* request_get_protocol(request_t *rq);
00049 const char *request_get_filename(request_t *rq);
00050 const char *request_get_resolved_filename(request_t *rq);
00051 const char *request_get_query_string(request_t *rq);
00052 const char *request_get_path_info(request_t *rq);
00053 const char *request_get_resolved_path_info(request_t *rq);
00054 int request_get_method(request_t *rq);
00055 ssize_t request_get_content_length(request_t *rq);
00056 time_t request_get_if_modified_since(request_t *rq);
00057 int request_is_encoding_accepted(request_t *rq, const char *encoding);
00058 
00059 int request_set_field(request_t *rq, const char *name, const char *value);
00060 int request_set_client_request(request_t *rq, const char *ln);
00061 int request_set_uri(request_t *rq, const char *uri,
00062         int (*is_valid_uri)(void*, const char *, size_t),
00063         void* arg);
00064 int request_set_filename(request_t *rq, const char *filename);
00065 int request_set_method(request_t *rq, const char *method);
00066 int request_set_path_info(request_t *rq, const char *path_info);
00067 int request_set_query_string(request_t *rq, const char *query);
00068 int request_set_resolved_filename(request_t *rq, const char *resolved);
00069 int request_set_resolved_path_info(request_t *rq, const char *resolved);
00070 int request_set_addr(request_t *rq, kaddr_t *addr);
00071 int request_set_peer_addr(request_t *rq, kaddr_t *addr);
00072 void request_set_cgi(request_t *rq, int cgi);
00073 void request_clear_uri(request_t *rq);
00074 
00075 int request_print(request_t *rq);
00076 
00077 enum { MIME_TYPE_BUFSZ = 256 };
00078 
00079 vars_t *request_get_uploads(request_t *rq);
00080 int request_get_uploaded_file(request_t *rq, const char *name, size_t idx, 
00081     char local_filename[U_FILENAME_MAX], char client_filename[U_FILENAME_MAX], 
00082     char mime_type[MIME_TYPE_BUFSZ], size_t *file_size);
00083 
00084 vars_t *request_get_args(request_t *rq);
00085 const char *request_get_arg(request_t *rq, const char *name);
00086 
00087 vars_t *request_get_getargs(request_t *rq);
00088 const char *request_get_getarg(request_t *rq, const char *name);
00089 
00090 vars_t *request_get_postargs(request_t *rq);
00091 const char *request_get_postarg(request_t *rq, const char *name);
00092 
00093 vars_t *request_get_cookies(request_t *rq);
00094 const char *request_get_cookie(request_t *rq, const char *name);
00095 
00096 vhost_t *request_get_vhost(request_t *rq);
00097 int request_set_vhost(request_t *rq, vhost_t *vhost);
00098 
00099 /* internal */
00100 struct supplier_s;
00101 void request_set_sup_info(request_t *, struct supplier_s*, void *, time_t);
00102 void request_get_sup_info(request_t *, struct supplier_s **, void **, time_t *);
00103 
00104 #ifdef __cplusplus
00105 }
00106 #endif 
00107 
00108 #endif