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 KXML_POPALL 3
19
.Os
20
.Sh NAME
21
.Nm kxml_popall
22
.Nd close all element scopes for kcgixml
23
.Sh LIBRARY
24
.Lb libkcgixml
25
.Sh SYNOPSIS
26
.In sys/types.h
27
.In stdarg.h
28
.In stdint.h
29
.In kcgi.h
30
.In kcgihxml.h
31
.Ft enum kcgi_err
32
.Fo kxml_popall
33
.Fa "struct kxmlreq *req"
34
.Fc
35
.Sh DESCRIPTION
36
Closes all open element scopes of
37
.Fa req ,
38
initialised with
39
.Xr kxml_open 3 .
40
Scopes are opened with
41
.Xr kxml_push 3
42
or
43
.Xr kxml_pushattrs 3 .
44
If there are no open scopes, this does nothing.
45
.Sh RETURN VALUES
46
Returns an
47
.Ft enum kcgi_err
48
indicating the error state.
49
.Bl -tag -width -Ds
50
.It Dv KCGI_OK
51
Success (not an error).
52
.It Dv KCGI_ENOMEM
53
Internal memory allocation failure.
54
.It Dv KCGI_HUP
55
The output connection has been terminated.
56
For FastCGI connections, the current connection should be released with
57
.Xr khttp_free 3
58
and parse loop reentered.
59
.It Dv KCGI_FORM
60
The connection is still expecting headers with
61
.Xr khttp_head 3 .
62
Indicates that
63
.Xr khttp_body 3
64
did not return with success or was not invoked.
65
For FastCGI connections, the current connection should be released with
66
.Xr khttp_free 3
67
and parse loop reentered.
68
.It Dv KCGI_SYSTEM
69
Internal system error writing to the output stream.
70
.El
71
.Sh EXAMPLES
72
The following outputs a simple XML page.
73
It assumes
74
.Va r
75
is a
76
.Vt struct kreq
77
pointer.
78
For brevity, it does not do any error checking.
79
.Bd -literal -offset indent
80
const char *const elems[] =
81
  { "foo", "bar", "baz" };
82
khttp_head(r, kresps[KRESP_STATUS],
83
  "%s", khttps[KHTTP_200]);
84
khttp_head(r, kresps[KRESP_CONTENT_TYPE],
85
  "%s", kmimetypes[KMIME_TEXT_XML]);
86
khttp_body(r);
87
kxml_open(&req, r, elems, 3);
88
kxml_push(&req, 0); /* foo */
89
kxml_push(&req, 1); /* bar */
90
kxml_push(&req, 2); /* baz */
91
kxml_popall(&req);
92
kxml_close(&req);
93
.Ed
94
.Sh SEE ALSO
95
.Xr kcgixml 3
96
.Sh AUTHORS
97
Written by
98
.An Kristaps Dzonsons Aq Mt kristaps@bsd.lv .
99