ksgi

1
.\"	$Id$
2
.\"
3
.\" Copyright (c) 2020 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 KCGI_BUF_PUTC 3
19
.Os
20
.Sh NAME
21
.Nm kcgi_buf_puts
22
.Nd put a character into a kcgi buffer
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 kcgi_buf_putc
32
.Fa "struct kcgi_buf *buf"
33
.Fa "char c"
34
.Fc
35
.Sh DESCRIPTION
36
Appends a character
37
.Fa c
38
to a buffer
39
.Fa buf .
40
Buffers must be initialised to zero with
41
.Xr memset 3
42
prior to first use.
43
.Sh RETURN VALUES
44
Returns an
45
.Ft enum kcgi_err
46
indicating the error state.
47
.Bl -tag -width -Ds
48
.It Dv KCGI_OK
49
Success (not an error).
50
.It Dv KCGI_ENOMEM
51
Internal memory allocation failure.
52
.It Dv KCGI_HUP
53
The output connection has been terminated.
54
For FastCGI connections, the current connection should be released with
55
.Xr khttp_free 3
56
and parse loop reentered.
57
.It Dv KCGI_FORM
58
The connection is still expecting headers with
59
.Xr khttp_head 3 .
60
Indicates that
61
.Xr khttp_body 3
62
did not return with success or was not invoked.
63
For FastCGI connections, the current connection should be released with
64
.Xr khttp_free 3
65
and parse loop reentered.
66
.It Dv KCGI_SYSTEM
67
Internal system error writing to the output stream.
68
.El
69
.Sh EXAMPLES
70
The following creates a simple NUL-terminated buffer and outputs its
71
contents.
72
It does not perform any error checking.
73
.Bd -literal -offset indent
74
struct kcgi_buf buf;
75

76
memset(&buf, 0, sizeof(struct kcgi_buf));
77
kcgi_buf_putc(&buf, 'f');
78
kcgi_buf_putc(&buf, 'o');
79
kcgi_buf_putc(&buf, 'o');
80
puts(buf.buf); /* Emits "foo" */
81
free(buf.buf);
82
.Ed
83
.Sh SEE ALSO
84
.Xr kcgi_buf_printf 3 ,
85
.Xr kcgi_buf_putc 3 ,
86
.Xr kcgi_buf_write 3
87
.Sh AUTHORS
88
Written by
89
.An Kristaps Dzonsons Aq Mt kristaps@bsd.lv .
90