2021-02-11 12:57:52 +03:00
|
|
|
.\" $NetBSD: libbozohttpd.3,v 1.5 2021/02/11 09:57:53 mrg Exp $
|
2010-05-10 07:30:04 +04:00
|
|
|
.\"
|
|
|
|
|
.\" $eterna: libbozohttpd.3,v 1.2 2010/05/10 02:48:23 mrg Exp $
|
|
|
|
|
.\"
|
|
|
|
|
.\" Copyright (c) 2009 The NetBSD Foundation, Inc.
|
|
|
|
|
.\" All rights reserved.
|
|
|
|
|
.\"
|
|
|
|
|
.\" This manual page is derived from software contributed to The
|
|
|
|
|
.\" NetBSD Foundation by Alistair Crooks (agc@NetBSD.org)
|
|
|
|
|
.\"
|
|
|
|
|
.\" Redistribution and use in source and binary forms, with or without
|
|
|
|
|
.\" modification, are permitted provided that the following conditions
|
|
|
|
|
.\" are met:
|
|
|
|
|
.\" 1. Redistributions of source code must retain the above copyright
|
|
|
|
|
.\" notice, this list of conditions and the following disclaimer.
|
|
|
|
|
.\" 2. Redistributions in binary form must reproduce the above copyright
|
|
|
|
|
.\" notice, this list of conditions and the following disclaimer in the
|
|
|
|
|
.\" documentation and/or other materials provided with the distribution.
|
|
|
|
|
.\"
|
|
|
|
|
.\" THIS SOFTWARE IS PROVIDED BY THE NETBSD FOUNDATION, INC. AND CONTRIBUTORS
|
|
|
|
|
.\" ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
|
|
|
|
|
.\" TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
|
|
|
|
|
.\" PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE FOUNDATION OR CONTRIBUTORS
|
|
|
|
|
.\" BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
|
|
|
|
|
.\" CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
|
|
|
|
|
.\" SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
|
|
|
|
|
.\" INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
|
|
|
|
|
.\" CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
|
|
|
|
|
.\" ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
|
|
|
|
|
.\" POSSIBILITY OF SUCH DAMAGE.
|
|
|
|
|
.\"
|
2021-02-11 12:57:52 +03:00
|
|
|
.Dd February 11, 2021
|
2010-05-10 07:30:04 +04:00
|
|
|
.Dt LIBBOZOHTTPD 3
|
|
|
|
|
.Os
|
|
|
|
|
.Sh NAME
|
|
|
|
|
.Nm libbozohttpd
|
|
|
|
|
.Nd embedded web server library
|
|
|
|
|
.Sh LIBRARY
|
|
|
|
|
.Lb libbozohttpd
|
|
|
|
|
.Sh SYNOPSIS
|
|
|
|
|
.In bozohttpd.h
|
|
|
|
|
.Ft int
|
|
|
|
|
.Fo bozo_set_pref
|
2017-02-04 04:32:54 +03:00
|
|
|
.Fa "bozohttpd_t *httpd" "bozoprefs_t *prefs" "char *name" "char *value"
|
2010-05-10 07:30:04 +04:00
|
|
|
.Fc
|
|
|
|
|
.Ft char *
|
|
|
|
|
.Fo bozo_get_pref
|
|
|
|
|
.Fa "bozoprefs_t *prefs" "char *name"
|
|
|
|
|
.Fc
|
|
|
|
|
.Ft int
|
|
|
|
|
.Fo bozo_set_defaults
|
|
|
|
|
.Fa "bozohttpd_t *httpd" "bozoprefs_t *prefs"
|
|
|
|
|
.Fc
|
|
|
|
|
.Ft void
|
|
|
|
|
.Fo bozo_setup
|
|
|
|
|
.Fa "bozohttpd_t *httpd" "bozoprefs_t *prefs" "const char *vhost" "char *slash"
|
|
|
|
|
.Fc
|
|
|
|
|
.Ft bozo_httpreq_t *
|
|
|
|
|
.Fo bozo_read_request
|
|
|
|
|
.Fa "bozohttpd_t *httpd"
|
|
|
|
|
.Fc
|
|
|
|
|
.Ft void
|
|
|
|
|
.Fo bozo_process_request
|
|
|
|
|
.Fa "bozo_httpreq_t *"
|
|
|
|
|
.Fc
|
|
|
|
|
.Ft void
|
|
|
|
|
.Fo bozo_clean_request
|
|
|
|
|
.Fa "bozo_httpreq_t *"
|
|
|
|
|
.Fc
|
2021-02-11 12:57:52 +03:00
|
|
|
.Ft void
|
|
|
|
|
.Fo bozo_cleanup
|
|
|
|
|
.Fa "bozohttpd_t *httpd" "bozoprefs_t *prefs"
|
|
|
|
|
.Fc
|
2010-05-10 07:30:04 +04:00
|
|
|
.Sh DESCRIPTION
|
|
|
|
|
.Nm
|
|
|
|
|
is a library interface to the
|
|
|
|
|
.Xr bozohttpd 8
|
|
|
|
|
web server.
|
|
|
|
|
The
|
|
|
|
|
.Nm
|
|
|
|
|
library can be used to embed a webserver
|
|
|
|
|
in your applications.
|
|
|
|
|
.Pp
|
|
|
|
|
Normal operation sees the
|
|
|
|
|
.Nm
|
|
|
|
|
process be initialised using the
|
|
|
|
|
.Fn bozo_set_defaults
|
|
|
|
|
function, which will set up the default port
|
|
|
|
|
and other internal settings, allocating
|
|
|
|
|
any necessary space as needed.
|
|
|
|
|
The
|
|
|
|
|
.Fn bozo_set_defaults
|
|
|
|
|
function returns 1 on sucess, 0 on failure.
|
|
|
|
|
.Pp
|
|
|
|
|
The
|
|
|
|
|
.Fn bozo_setup
|
|
|
|
|
function is used to specify the virtual host name
|
|
|
|
|
for the web server.
|
|
|
|
|
A NULL host name will mean that
|
|
|
|
|
.Nm
|
|
|
|
|
will use the local value for the host name,
|
|
|
|
|
as returned by
|
|
|
|
|
.Xr gethostname 3 .
|
|
|
|
|
This virtual hostname should be a fully qualified domain name.
|
|
|
|
|
The final argument to
|
|
|
|
|
.Fn bozo_setup
|
|
|
|
|
is the name of the directory to serve as the root
|
|
|
|
|
directory of the web server tree.
|
|
|
|
|
.Pp
|
|
|
|
|
Once the server has been set up, it serves
|
|
|
|
|
requests by using the
|
|
|
|
|
.Fn bozo_read_request
|
|
|
|
|
function, which returns a pointer to a request structure,
|
|
|
|
|
and
|
|
|
|
|
.Fn bozo_process_request ,
|
|
|
|
|
which deals with the request, and answers the client.
|
|
|
|
|
The request space is de-allocated
|
|
|
|
|
using the
|
|
|
|
|
.Fn bozo_clean_request
|
|
|
|
|
function.
|
|
|
|
|
.Pp
|
|
|
|
|
Preferences are set
|
|
|
|
|
using the function
|
|
|
|
|
.Fn bozo_set_pref
|
|
|
|
|
function
|
|
|
|
|
and queried using the two
|
|
|
|
|
.Fn bozo_get_pref
|
|
|
|
|
function.
|
|
|
|
|
This is the main interface for selecting options, and for
|
|
|
|
|
setting preferences.
|
2021-02-11 12:57:52 +03:00
|
|
|
The memory allocated by
|
|
|
|
|
.Fn bozo_setup
|
|
|
|
|
for both the httpd structure and the preferences will be freed.
|
2010-05-10 07:30:04 +04:00
|
|
|
.Sh SEE ALSO
|
|
|
|
|
.Xr gethostname 3 ,
|
|
|
|
|
.Xr ssl 3 ,
|
|
|
|
|
.Xr services 5 ,
|
|
|
|
|
.Xr httpd 8
|
|
|
|
|
.Sh HISTORY
|
|
|
|
|
The
|
|
|
|
|
.Nm
|
|
|
|
|
library first appeared in
|
|
|
|
|
.Nx 6.0 .
|
|
|
|
|
.Sh AUTHORS
|
2013-07-21 01:39:55 +04:00
|
|
|
.An Matthew R. Green Aq Mt mrg@eterna.com.au
|
|
|
|
|
.An Alistair Crooks Aq Mt agc@NetBSD.org
|
2010-05-10 07:30:04 +04:00
|
|
|
wrote this high-level interface.
|
|
|
|
|
.Pp
|
|
|
|
|
This manual page was written by
|
|
|
|
|
.An Alistair Crooks .
|
