tests/web-server.h

   1 /* nbdkit
   2  * Copyright (C) 2018 Red Hat Inc.
   3  *
   4  * Redistribution and use in source and binary forms, with or without
   5  * modification, are permitted provided that the following conditions are
   6  * met:
   7  *
   8  * * Redistributions of source code must retain the above copyright
   9  * notice, this list of conditions and the following disclaimer.
  10  *
  11  * * Redistributions in binary form must reproduce the above copyright
  12  * notice, this list of conditions and the following disclaimer in the
  13  * documentation and/or other materials provided with the distribution.
  14  *
  15  * * Neither the name of Red Hat nor the names of its contributors may be
  16  * used to endorse or promote products derived from this software without
  17  * specific prior written permission.
  18  *
  19  * THIS SOFTWARE IS PROVIDED BY RED HAT AND CONTRIBUTORS ''AS IS'' AND
  20  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO,
  21  * THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A
  22  * PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL RED HAT OR
  23  * CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
  24  * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
  25  * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF
  26  * USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
  27  * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
  28  * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
  29  * OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  30  * SUCH DAMAGE.
  31  */
  32
  33 /* This implements a basic web server supporting range requests.  Note
  34  * that its only purpose is to answer queries from libcurl over a Unix
  35  * domain socket.  Any use outside that extremely narrow one will
  36  * probably not work.
  37  *
  38  * It is also not written with security in mind and therefore should
  39  * only be used for testing over a hidden socket.  In the context of
  40  * the nbdkit tests this assumption is sound.
  41  */
  42
  43 #ifndef NBDKIT_WEB_SERVER_H
  44 #define NBDKIT_WEB_SERVER_H
  45
  46 /* Starts a web server in a background thread.  The web server will
  47  * serve 'filename' (only) - the URL in requests is ignored.
  48  *
  49  * Returns the name of the private Unix domain socket which can be
  50  * used to connect to this web server (using Curl's UNIX_SOCKET_PATH
  51  * feature).
  52  *
  53  * The thread will run until the program exits.  The Unix socket is
  54  * cleaned up automatically on exit.  Note that the returned string
  55  * must NOT be freed by the main program.
  56  *
  57  * The optional check_request function is called when the request is
  58  * received (note: not in the main thread) and can be used to perform
  59  * checks for example that particular headers were sent.
  60  */
  61 typedef void (*check_request_t) (const char *request);
  62 extern const char *web_server (const char *filename,
  63                                check_request_t check_request)
  64   __attribute__((__nonnull__ (1)));
  65
  66 #endif /* NBDKIT_WEB_SERVER_H */