ksgi

1
.\" Copyright (c) 2017 Kristaps Dzonsons <kristaps@bsd.lv>
2
.\"
3
.\" Permission to use, copy, modify, and distribute this software for any
4
.\" purpose with or without fee is hereby granted, provided that the above
5
.\" copyright notice and this permission notice appear in all copies.
6
.\"
7
.\" THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
8
.\" WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
9
.\" MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
10
.\" ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
11
.\" WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
12
.\" ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
13
.\" OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
14
.\"
15
.Dd $Mdocdate$
16
.Dt KCGI_WRITER_GET 3
17
.Os
18
.Sh NAME
19
.Nm kcgi_writer_get
20
.Nd open a writer allocation
21
.Sh LIBRARY
22
.Lb libkcgi
23
.Sh SYNOPSIS
24
.In sys/types.h
25
.In stdarg.h
26
.In stdint.h
27
.In kcgi.h
28
.Ft "struct kcgi_writer *"
29
.Fo kcgi_writer_get
30
.Fa "struct kreq *req"
31
.Fa "int type"
32
.Fc
33
.Sh DESCRIPTION
34
The
35
.Fn kcgi_writer_get
36
function opens a writer from request
37
.Fa r
38
for subsequent use by the
39
.Xr kcgi_writer_write 3
40
family.
41
The
42
.Fa type
43
argument is reserved for future use and should be set to zero.
44
It may only be used prior to
45
.Xr kcgi_writer_disable 3 ,
46
otherwise it will cause a program abort.
47
.Sh RETURN VALUES
48
Returns a writer or
49
.Dv NULL
50
if allocation fails.
51
.Sh SEE ALSO
52
.Xr kcgi_writer_disable 3 ,
53
.Xr kcgi_writer_write 3
54
.Sh AUTHORS
55
This function was written by
56
.An Kristaps Dzonsons Aq Mt kristaps@bsd.lv .
57