File: request_8h-source.html

package info (click to toggle)
klone 1.1.1.dfsg1-1
  • links: PTS
  • area: main
  • in suites: etch, etch-m68k
  • size: 6,480 kB
  • ctags: 4,238
  • sloc: ansic: 16,288; makefile: 384; sh: 351
file content (112 lines) | stat: -rw-r--r-- 12,276 bytes parent folder | download
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html><head><meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1">
<title>KLone: request.h Source File</title>
<link href="kl.css" rel="stylesheet" type="text/css">
</head><body>
<!-- Generated by Doxygen 1.3.9.1 -->
<div class="qindex"><a class="qindex" href="index.html">Main&nbsp;Page</a> | <a class="qindex" href="modules.html">Modules</a> | <a class="qindex" href="annotated.html">Data&nbsp;Structures</a> | <a class="qindex" href="dirs.html">Directories</a> | <a class="qindex" href="files.html">File&nbsp;List</a> | <a class="qindex" href="functions.html">Data&nbsp;Fields</a> | <a class="qindex" href="globals.html">Globals</a></div>
<div class="nav">
<a class="el" href="dir_000002.html">klone</a></div>
<h1>request.h</h1><a href="request_8h.html">Go to the documentation of this file.</a><div class="fragment"><pre class="fragment">00001 <span class="comment">/*</span>
00002 <span class="comment"> * Copyright (c) 2005, 2006 by KoanLogic s.r.l. &lt;http://www.koanlogic.com&gt;</span>
00003 <span class="comment"> * All rights reserved.</span>
00004 <span class="comment"> *</span>
00005 <span class="comment"> * This file is part of KLone, and as such it is subject to the license stated</span>
00006 <span class="comment"> * in the LICENSE file which you have received as part of this distribution.</span>
00007 <span class="comment"> *</span>
00008 <span class="comment"> * $Id: request.h,v 1.12 2006/04/06 14:02:22 tat Exp $</span>
00009 <span class="comment"> */</span>
00010 
00011 <span class="preprocessor">#ifndef _KLONE_REQUEST_H_</span>
00012 <span class="preprocessor"></span><span class="preprocessor">#define _KLONE_REQUEST_H_</span>
00013 <span class="preprocessor"></span>
00014 <span class="preprocessor">#include &lt;sys/types.h&gt;</span>
00015 <span class="preprocessor">#include &lt;<a class="code" href="header_8h.html">klone/header.h</a>&gt;</span>
00016 <span class="preprocessor">#include &lt;<a class="code" href="io_8h.html">klone/io.h</a>&gt;</span>
00017 <span class="preprocessor">#include &lt;<a class="code" href="http_8h.html">klone/http.h</a>&gt;</span>
00018 <span class="preprocessor">#include &lt;<a class="code" href="vars_8h.html">klone/vars.h</a>&gt;</span>
00019 <span class="preprocessor">#include &lt;<a class="code" href="addr_8h.html">klone/addr.h</a>&gt;</span>
00020 
00021 <span class="preprocessor">#ifdef __cplusplus</span>
00022 <span class="preprocessor"></span><span class="keyword">extern</span> <span class="stringliteral">"C"</span> {
00023 <span class="preprocessor">#endif</span>
00024 <span class="preprocessor"></span>
00025 <span class="keyword">struct </span>request_s;
<a name="l00026"></a><a class="code" href="request_8h.html#a0">00026</a> <span class="keyword">typedef</span> <span class="keyword">struct </span>request_s <a class="code" href="request_8h.html#a0">request_t</a>;
00027 
00028 <span class="keywordtype">int</span> <a class="code" href="group__request__t.html#ga54">request_create</a>(<a class="code" href="structhttp__s.html">http_t</a> *h, request_t **prq);
00029 <span class="keywordtype">int</span> <a class="code" href="group__request__t.html#ga56">request_free</a>(request_t *rq);
00030 <span class="keywordtype">int</span> <a class="code" href="group__request__t.html#ga16">request_bind</a>(request_t *rq, <a class="code" href="structio__s.html">io_t</a> *);
00031 <span class="keywordtype">int</span> <a class="code" href="group__request__t.html#ga48">request_parse_header</a>(request_t *rq, 
00032         <span class="keywordtype">int</span> (*is_valid_url)(<span class="keywordtype">void</span>*, <span class="keyword">const</span> <span class="keywordtype">char</span> *, size_t),
00033         <span class="keywordtype">void</span>* arg);
00034 <span class="keywordtype">int</span> <a class="code" href="group__request__t.html#ga47">request_parse_data</a>(request_t *rq);
00035 
00036 <a class="code" href="structio__s.html">io_t</a>* <a class="code" href="group__request__t.html#ga1">request_io</a>(request_t *rq);
00037 <a class="code" href="structhttp__s.html">http_t</a>* <a class="code" href="group__request__t.html#ga15">request_get_http</a>(request_t *rq);
00038 <a class="code" href="structaddr__s.html">addr_t</a>* <a class="code" href="group__request__t.html#ga59">request_get_addr</a>(request_t *rq);
00039 <a class="code" href="structaddr__s.html">addr_t</a>* <a class="code" href="group__request__t.html#ga60">request_get_peer_addr</a>(request_t *rq);
00040 <a class="code" href="structheader__t.html">header_t</a>* <a class="code" href="group__request__t.html#ga61">request_get_header</a>(request_t *rq);
00041 <a class="code" href="structfield__s.html">field_t</a>* <a class="code" href="group__request__t.html#ga62">request_get_field</a>(request_t *rq, <span class="keyword">const</span> <span class="keywordtype">char</span> *name);
00042 <span class="keyword">const</span> <span class="keywordtype">char</span>* <a class="code" href="group__request__t.html#ga63">request_get_field_value</a>(request_t *rq, <span class="keyword">const</span> <span class="keywordtype">char</span> *name);
00043 <span class="keyword">const</span> <span class="keywordtype">char</span> *<a class="code" href="group__request__t.html#ga7">request_get_uri</a>(request_t *rq);
00044 <span class="keyword">const</span> <span class="keywordtype">char</span> *<a class="code" href="group__request__t.html#ga8">request_get_filename</a>(request_t *rq);
00045 <span class="keyword">const</span> <span class="keywordtype">char</span> *<a class="code" href="group__request__t.html#ga50">request_get_resolved_filename</a>(request_t *rq);
00046 <span class="keyword">const</span> <span class="keywordtype">char</span> *<a class="code" href="group__request__t.html#ga10">request_get_query_string</a>(request_t *rq);
00047 <span class="keyword">const</span> <span class="keywordtype">char</span> *<a class="code" href="group__request__t.html#ga11">request_get_path_info</a>(request_t *rq);
00048 <span class="keyword">const</span> <span class="keywordtype">char</span> *<a class="code" href="group__request__t.html#ga51">request_get_resolved_path_info</a>(request_t *rq);
00049 <span class="keywordtype">int</span> <a class="code" href="group__request__t.html#ga49">request_get_method</a>(request_t *rq);
00050 ssize_t <a class="code" href="group__request__t.html#ga29">request_get_content_length</a>(request_t *rq);
00051 time_t <a class="code" href="group__request__t.html#ga13">request_get_if_modified_since</a>(request_t *rq);
00052 <span class="keywordtype">int</span> <a class="code" href="group__request__t.html#ga0">request_is_encoding_accepted</a>(request_t *rq, <span class="keyword">const</span> <span class="keywordtype">char</span> *encoding);
00053 <span class="keywordtype">int</span> <a class="code" href="group__request__t.html#ga6">request_set_field</a>(request_t *rq, <span class="keyword">const</span> <span class="keywordtype">char</span> *name, <span class="keyword">const</span> <span class="keywordtype">char</span> *value);
00054 <span class="keywordtype">int</span> <a class="code" href="group__request__t.html#ga21">request_set_uri</a>(request_t *rq, <span class="keyword">const</span> <span class="keywordtype">char</span> *uri,
00055         <span class="keywordtype">int</span> (*is_valid_uri)(<span class="keywordtype">void</span>*, <span class="keyword">const</span> <span class="keywordtype">char</span> *, size_t),
00056         <span class="keywordtype">void</span>* arg);
00057 <span class="keywordtype">int</span> <a class="code" href="group__request__t.html#ga9">request_set_filename</a>(request_t *rq, <span class="keyword">const</span> <span class="keywordtype">char</span> *filename);
00058 <span class="keywordtype">int</span> <a class="code" href="group__request__t.html#ga23">request_set_method</a>(request_t *rq, <span class="keyword">const</span> <span class="keywordtype">char</span> *method);
00059 <span class="keywordtype">int</span> <a class="code" href="group__request__t.html#ga19">request_set_path_info</a>(request_t *rq, <span class="keyword">const</span> <span class="keywordtype">char</span> *path_info);
00060 <span class="keywordtype">int</span> <a class="code" href="group__request__t.html#ga17">request_set_query_string</a>(request_t *rq, <span class="keyword">const</span> <span class="keywordtype">char</span> *query);
00061 <span class="keywordtype">int</span> <a class="code" href="group__request__t.html#ga14">request_set_resolved_filename</a>(request_t *rq, <span class="keyword">const</span> <span class="keywordtype">char</span> *resolved);
00062 <span class="keywordtype">int</span> <a class="code" href="group__request__t.html#ga20">request_set_resolved_path_info</a>(request_t *rq, <span class="keyword">const</span> <span class="keywordtype">char</span> *resolved);
00063 <span class="keywordtype">int</span> <a class="code" href="group__request__t.html#ga57">request_set_addr</a>(request_t *rq, <a class="code" href="structaddr__s.html">addr_t</a> *addr);
00064 <span class="keywordtype">int</span> <a class="code" href="group__request__t.html#ga58">request_set_peer_addr</a>(request_t *rq, <a class="code" href="structaddr__s.html">addr_t</a> *addr);
00065 <span class="keywordtype">void</span> <a class="code" href="group__request__t.html#ga28">request_set_cgi</a>(request_t *rq, <span class="keywordtype">int</span> cgi);
00066 <span class="keywordtype">void</span> <a class="code" href="group__request__t.html#ga18">request_clear_uri</a>(request_t *rq);
00067 <span class="keywordtype">int</span> <a class="code" href="group__request__t.html#ga52">request_print</a>(request_t *rq);
00068 
00069 <span class="keyword">enum</span> { <a class="code" href="request_8h.html#a44a1">MIME_TYPE_BUFSZ</a> = 256 };
00070 
00071 <a class="code" href="vars_8h.html#a0">vars_t</a> *<a class="code" href="group__request__t.html#ga40">request_get_uploads</a>(request_t *rq);
00072 <span class="keywordtype">int</span> <a class="code" href="request_8h.html#a38">request_get_uploaded_file</a>(request_t *rq, <span class="keyword">const</span> <span class="keywordtype">char</span> *name, size_t idx, 
00073     <span class="keywordtype">char</span> local_filename[U_PATH_MAX], <span class="keywordtype">char</span> client_filename[U_PATH_MAX], 
00074     <span class="keywordtype">char</span> mime_type[MIME_TYPE_BUFSZ], size_t *file_size);
00075 <span class="keywordtype">int</span> <a class="code" href="request_8h.html#a39">request_get_uploaded_filev</a>(request_t *rq, <a class="code" href="structvar__s.html">var_t</a> *v,
00076     <span class="keywordtype">char</span> local_filename[U_PATH_MAX], <span class="keywordtype">char</span> client_filename[U_PATH_MAX], 
00077     <span class="keywordtype">char</span> mime_type[MIME_TYPE_BUFSZ], size_t *file_size);
00078 
00079 
00080 <a class="code" href="vars_8h.html#a0">vars_t</a> *<a class="code" href="group__request__t.html#ga4">request_get_args</a>(request_t *rq);
00081 <span class="keyword">const</span> <span class="keywordtype">char</span> *<a class="code" href="group__request__t.html#ga5">request_get_arg</a>(request_t *rq, <span class="keyword">const</span> <span class="keywordtype">char</span> *name);
00082 
00083 <a class="code" href="vars_8h.html#a0">vars_t</a> *<a class="code" href="group__request__t.html#ga2">request_get_cookies</a>(request_t *rq);
00084 <span class="keyword">const</span> <span class="keywordtype">char</span> *<a class="code" href="group__request__t.html#ga3">request_get_cookie</a>(request_t *rq, <span class="keyword">const</span> <span class="keywordtype">char</span> *name);
00085 
00086 
00087 <span class="preprocessor">#ifdef __cplusplus</span>
00088 <span class="preprocessor"></span>}
00089 <span class="preprocessor">#endif </span>
00090 <span class="preprocessor"></span>
00091 <span class="preprocessor">#endif</span>
</pre></div><hr>
<div> 
  <div style="text-align:left">
    <a href="http://www.koanlogic.com/kl/cont/gb/html/products.html">&larr;Products</a>
  </div>
  <div style="text-align:center;">
    &copy; 2005-2006 - <a href="http://www.koanlogic.com">KoanLogic S.r.l.</a> - All rights reserved
  </div>
</div>

</body>
</html>