SaneCppLibraries/HttpWebServer_8h_source.html

// Copyright (c) Stefano Cristiano

// SPDX-License-Identifier: MIT

#pragma once

#include "../Strings/String.h"

#include "HttpServer.h"


namespace SC

{

struct SC_COMPILER_EXPORT HttpWebServer;

}


struct SC::HttpWebServer

{

    Result init(StringView directoryToServe);


    Result stopAsync();


    void serveFile(HttpRequest& request, HttpResponse& response);


  private:

    String directory;


    struct Internal;

};


SC_COMPILER_EXPORT
#define SC_COMPILER_EXPORT
Macro for symbol visibility in non-MSVC compilers.
Definition Compiler.h:78

SC::HttpRequest
Http request received from a client.
Definition HttpServer.h:48

SC::HttpResponse
Http response that will be sent to a client.
Definition HttpServer.h:77

SC::HttpWebServer
Http web server helps statically serves files from a directory.
Definition HttpWebServer.h:21

SC::HttpWebServer::serveFile
void serveFile(HttpRequest &request, HttpResponse &response)
Serve the file requested by this Http Client on its channel Call this method in response to HttpServe...

SC::HttpWebServer::stopAsync
Result stopAsync()
Release all resources allocated by this web server.

SC::HttpWebServer::init
Result init(StringView directoryToServe)
Initialize the web server on the given file system directory to serve.

SC::Result
An ascii string used as boolean result. SC_TRY macro forwards errors to caller.
Definition Result.h:12

SC::StringView
Non-owning view over a range of characters with UTF Encoding.
Definition StringView.h:47

SC::String
A non-modifiable owning string with associated encoding.
Definition String.h:29