ksgi

1
.\" Copyright (c) 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_PUTC 3
17
.Os
18
.Sh NAME
19
.Nm kcgi_writer_putc
20
.Nd write into a writer
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 "enum kcgi_err"
29
.Fo kcgi_writer_putc
30
.Fa "struct kcgi_writer *writer"
31
.Fa "char c"
32
.Fc
33
.Sh DESCRIPTION
34
The
35
.Fn kcgi_writer_putc
36
function writes character
37
.Fa c
38
to a
39
.Fa writer
40
channel opened by
41
.Xr kcgi_writer_get 3 .
42
This allows writing after
43
.Xr kcgi_writer_disable 3 ,
44
unlike
45
.Xr khttp_write 3 .
46
.Fn kcgi_writer_putc
47
is backed by
48
.Xr kcgi_writer_write 3 .
49
.Sh RETURN VALUES
50
Returns an
51
.Ft enum kcgi_err
52
indicating the error state.
53
.Bl -tag -width -Ds
54
.It Dv KCGI_OK
55
Success (not an error).
56
.It Dv KCGI_ENOMEM
57
Internal memory allocation failure.
58
.It Dv KCGI_HUP
59
The output connection has been terminated.
60
For FastCGI connections, the current connection should be released with
61
.Xr khttp_free 3
62
and parse loop reentered.
63
.It Dv KCGI_FORM
64
The connection is still expecting headers with
65
.Xr khttp_head 3 .
66
Indicates that
67
.Xr khttp_body 3
68
did not return with success or was not invoked.
69
For FastCGI connections, the current connection should be released with
70
.Xr khttp_free 3
71
and parse loop reentered.
72
.It Dv KCGI_SYSTEM
73
Internal system error writing to the output stream.
74
.El
75
.Sh SEE ALSO
76
.Xr kcgi_writer_disable 3 ,
77
.Xr kcgi_writer_get 3
78
.Sh AUTHORS
79
This function was written by
80
.An Kristaps Dzonsons Aq Mt kristaps@bsd.lv .
81