mirror of
https://github.com/bdnugget/kcgi.git
synced 2026-11-07 05:47:27 +00:00
91 lines
2.4 KiB
Plaintext
91 lines
2.4 KiB
Plaintext
.\" $Id$
|
|
.\"
|
|
.\" Copyright (c) 2020 Kristaps Dzonsons <kristaps@bsd.lv>
|
|
.\"
|
|
.\" Permission to use, copy, modify, and distribute this software for any
|
|
.\" purpose with or without fee is hereby granted, provided that the above
|
|
.\" copyright notice and this permission notice appear in all copies.
|
|
.\"
|
|
.\" THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
|
|
.\" WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
|
|
.\" MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
|
|
.\" ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
|
|
.\" WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
|
|
.\" ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
|
|
.\" OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
|
|
.\"
|
|
.Dd $Mdocdate$
|
|
.Dt KCGI_BUF_PRINTF 3
|
|
.Os
|
|
.Sh NAME
|
|
.Nm kcgi_buf_printf
|
|
.Nd put variable content into a kcgi buffer
|
|
.Sh LIBRARY
|
|
.Lb libkcgi
|
|
.Sh SYNOPSIS
|
|
.In sys/types.h
|
|
.In stdarg.h
|
|
.In stdint.h
|
|
.In kcgi.h
|
|
.Ft enum kcgi_err
|
|
.Fo kcgi_buf_puts
|
|
.Fa "struct kcgi_buf *buf"
|
|
.Fa "const char *fmt"
|
|
.Fa "..."
|
|
.Fc
|
|
.Sh DESCRIPTION
|
|
Appends output according to the given
|
|
.Fa fmt
|
|
to a buffer
|
|
.Fa buf .
|
|
The format is as for
|
|
.Xr printf 3 .
|
|
Buffers must be initialised to zero with
|
|
.Xr memset 3
|
|
prior to first use.
|
|
.Sh RETURN VALUES
|
|
Returns an
|
|
.Ft enum kcgi_err
|
|
indicating the error state.
|
|
.Bl -tag -width -Ds
|
|
.It Dv KCGI_OK
|
|
Success (not an error).
|
|
.It Dv KCGI_ENOMEM
|
|
Internal memory allocation failure.
|
|
.It Dv KCGI_HUP
|
|
The output connection has been terminated.
|
|
For FastCGI connections, the current connection should be released with
|
|
.Xr khttp_free 3
|
|
and parse loop reentered.
|
|
.It Dv KCGI_FORM
|
|
The connection is still expecting headers with
|
|
.Xr khttp_head 3 .
|
|
Indicates that
|
|
.Xr khttp_body 3
|
|
did not return with success or was not invoked.
|
|
For FastCGI connections, the current connection should be released with
|
|
.Xr khttp_free 3
|
|
and parse loop reentered.
|
|
.It Dv KCGI_SYSTEM
|
|
Internal system error writing to the output stream.
|
|
.El
|
|
.Sh EXAMPLES
|
|
The following creates a simple NUL-terminated buffer and outputs its
|
|
contents.
|
|
It does not perform any error checking.
|
|
.Bd -literal -offset indent
|
|
struct kcgi_buf buf;
|
|
|
|
memset(&buf, 0, sizeof(struct kcgi_buf));
|
|
kcgi_buf_printf(&buf, "number %d", 1);
|
|
puts(buf.buf); /* Emits "number 1" */
|
|
free(buf.buf);
|
|
.Ed
|
|
.Sh SEE ALSO
|
|
.Xr kcgi_buf_putc 3 ,
|
|
.Xr kcgi_buf_puts 3 ,
|
|
.Xr kcgi_buf_write 3
|
|
.Sh AUTHORS
|
|
Written by
|
|
.An Kristaps Dzonsons Aq Mt kristaps@bsd.lv .
|