ksgi

1
.\"	$Id$
2
.\"
3
.\" Copyright (c) 2015 Kristaps Dzonsons <kristaps@bsd.lv>
4
.\"
5
.\" Permission to use, copy, modify, and distribute this software for any
6
.\" purpose with or without fee is hereby granted, provided that the above
7
.\" copyright notice and this permission notice appear in all copies.
8
.\"
9
.\" THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
10
.\" WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
11
.\" MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
12
.\" ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
13
.\" WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
14
.\" ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
15
.\" OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
16
.\"
17
.Dd $Mdocdate$
18
.Dt KHTTP_FCGI_PARSE 3
19
.Os
20
.Sh NAME
21
.Nm khttp_fcgi_parse
22
.Nd parse a FastCGI instance for kcgi
23
.Sh LIBRARY
24
.Lb libkcgi
25
.Sh SYNOPSIS
26
.In sys/types.h
27
.In stdarg.h
28
.In stdint.h
29
.In kcgi.h
30
.Ft "enum kcgi_err"
31
.Fo khttp_fcgi_parse
32
.Fa "struct kfcgi *fcgi"
33
.Fa "struct kreq *req"
34
.Fc
35
.Sh DESCRIPTION
36
The
37
.Fn khttp_fcgi_parse
38
function parses and validates a single FastCGI request.
39
They may be invoked as many times as necessary, but must follow a call
40
to
41
.Xr khttp_fcgi_init 3
42
and be followed by
43
.Xr khttp_fcgi_free 3 .
44
.Pp
45
The
46
.Fa req
47
object filled in by
48
.Fn khttp_fcgi_parse
49
must be matched by
50
.Xr khttp_free 3
51
if and only if the return value is
52
.Dv KCGI_OK .
53
Otherwise, resources are internally freed.
54
.Sh RETURN VALUES
55
These are the same as in
56
.Xr khttp_parse 3 ,
57
except the
58
.Dv KCGI_EXIT
59
return code indicates that no more requests will arrive and the
60
application should exit.
61
.Sh SEE ALSO
62
.Xr kcgi 3 ,
63
.Xr khttp_fcgi_init 3 ,
64
.Xr khttp_free 3 ,
65
.Xr khttp_parse 3
66
.Sh AUTHORS
67
The
68
.Fn khttp_fcgi_parse
69
function was written by
70
.An Kristaps Dzonsons Aq Mt kristaps@bsd.lv .
71