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_POP 3
19
.Os
20
.Sh NAME
21
.Nm kxml_pop
22
.Nd close an element scope 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_pop
33
.Fa "struct kxmlreq *req"
34
.Fc
35
.Sh DESCRIPTION
36
Closes a single element scope 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
.Pp
45
It is an error to pop from an empty scope stack.
46
.Sh RETURN VALUES
47
Returns an
48
.Ft enum kcgi_err
49
indicating the error state.
50
.Bl -tag -width -Ds
51
.It Dv KCGI_OK
52
Success (not an error).
53
.It Dv KCGI_ENOMEM
54
Internal memory allocation failure.
55
.It Dv KCGI_HUP
56
The output connection has been terminated.
57
For FastCGI connections, the current connection should be released with
58
.Xr khttp_free 3
59
and parse loop reentered.
60
.It Dv KCGI_FORM
61
The connection is still expecting headers with
62
.Xr khttp_head 3 .
63
Indicates that
64
.Xr khttp_body 3
65
did not return with success or was not invoked.
66
For FastCGI connections, the current connection should be released with
67
.Xr khttp_free 3
68
and parse loop reentered.
69
.It Dv KCGI_SYSTEM
70
Internal system error writing to the output stream.
71
.It Dv KCGI_WRITER
72
There are no open scopes to pop.
73
.El
74
.Sh EXAMPLES
75
The following outputs a simple XML page.
76
It assumes
77
.Va r
78
is a
79
.Vt struct kreq
80
pointer.
81
For brevity, it does not do any error checking.
82
.Bd -literal -offset indent
83
const char *const elems[] =
84
  { "foo", "bar", "baz" };
85
khttp_head(r, kresps[KRESP_STATUS],
86
  "%s", khttps[KHTTP_200]);
87
khttp_head(r, kresps[KRESP_CONTENT_TYPE],
88
  "%s", kmimetypes[KMIME_TEXT_XML]);
89
khttp_body(r);
90
kxml_open(&req, r, elems, 3);
91
kxml_push(&req, 0); /* foo */
92
kxml_puts(&req, "Hello, world");
93
kxml_pop(&req);
94
kxml_push(&req, 1, "baz", "xyzzy"); /* bar */
95
kxml_puts(&req, "Hello, world");
96
kxml_pop(&req);
97
kxml_close(&req);
98
.Ed
99
.Sh SEE ALSO
100
.Xr kcgixml 3
101
.Sh AUTHORS
102
Written by
103
.An Kristaps Dzonsons Aq Mt kristaps@bsd.lv .
104