Sane C++ Libraries
C++ Platform Abstraction Libraries
Loading...
Searching...
No Matches
HttpAsyncFileServer.h
1// Copyright (c) Stefano Cristiano
2// SPDX-License-Identifier: MIT
3#pragma once
4#include "../Async/Async.h"
5#include "../AsyncStreams/AsyncRequestStreams.h"
6#include "HttpConnection.h"
7#include "HttpMultipartParser.h"
8
9namespace SC
10{
20struct SC_COMPILER_EXPORT HttpAsyncFileServer
21{
25 struct SC_COMPILER_EXPORT Stream
26 {
27 ReadableFileStream readableFileStream;
28 WritableFileStream writableFileStream;
29 AsyncTaskSequence readableFileStreamTask;
30 AsyncTaskSequence writableFileStreamTask;
31 HttpMultipartParser multipartParser;
32 AsyncFileSend asyncFileSend;
33 FileDescriptor sourceFileDescriptor;
34
36 {
37 HttpAsyncFileServer* server = nullptr;
38 Stream* stream = nullptr;
39 HttpConnection* connection = nullptr;
40
41 FileDescriptor currentFd; // TODO: Reuse the above sourceFileDescriptor
42 StringPath currentFilePath;
43 StringSpan currentFileName;
44 StringSpan currentHeaderName;
45 bool isContentDisposition = false;
46
47 void onData(AsyncBufferView::ID bufferID);
48 } multipartListener;
49
51 {
52 HttpConnection* connection = nullptr;
53 size_t remainingBytes = 0;
54
55 void onData(AsyncBufferView::ID bufferID);
56 void onDrain();
57 } putFileListener;
58 };
59
60 template <int RequestsSize>
61 struct SC_COMPILER_EXPORT StreamQueue : public Stream
62 {
63 static_assert(RequestsSize >= 2, "HttpAsyncFileServer::StreamQueue requires RequestsSize >= 2");
64
66 {
67 readableFileStream.setReadQueue(readQueue);
68 writableFileStream.setWriteQueue(writeQueue);
69 }
70 AsyncReadableStream::Request readQueue[RequestsSize];
71 AsyncWritableStream::Request writeQueue[RequestsSize];
72 };
73
75 Result init(ThreadPool& threadPool, AsyncEventLoop& loop, StringSpan directoryToServe);
76
79
81 void setUseAsyncFileSend(bool value);
82
84 [[nodiscard]] bool getUseAsyncFileSend() const { return useAsyncFileSend; }
85
89
90 private:
91 bool useAsyncFileSend = true;
92 Result putFile(HttpAsyncFileServer::Stream& stream, HttpConnection& connection, StringSpan filePath);
93 Result getFile(HttpAsyncFileServer::Stream& stream, HttpConnection& connection, StringSpan filePath);
94 Result postMultipart(HttpAsyncFileServer::Stream& stream, HttpConnection& connection);
95
96 StringPath directory;
97
98 AsyncEventLoop* eventLoop = nullptr;
99 ThreadPool* threadPool = nullptr;
100 struct Internal;
101};
102
103} // namespace SC
Definition AsyncStreams.h:52
Asynchronous I/O (files, sockets, timers, processes, fs events, threads wake-up) (see Async) AsyncEve...
Definition Async.h:1386
Sends file contents to a socket using zero-copy when available (sendfile, TransmitFile).
Definition Async.h:974
Definition AsyncStreams.h:219
An AsyncSequence using a SC::ThreadPool to execute one or more SC::AsyncRequest in a background threa...
Definition Async.h:1116
Definition AsyncStreams.h:348
[UniqueHandleDeclaration2Snippet]
Definition File.h:122
Definition HttpAsyncFileServer.h:62
Definition HttpAsyncFileServer.h:36
Definition HttpAsyncFileServer.h:51
Support class for HttpAsyncFileServer holding file stream and pipeline.
Definition HttpAsyncFileServer.h:26
Http file server statically serves files from a directory.
Definition HttpAsyncFileServer.h:21
void setUseAsyncFileSend(bool value)
Controls whether to use AsyncFileSend optimization for GET requests (default: true)
Result init(ThreadPool &threadPool, AsyncEventLoop &loop, StringSpan directoryToServe)
Initialize the web server on the given file system directory to serve.
Result close()
Removes any reference to the arguments passed during init.
Result handleRequest(HttpAsyncFileServer::Stream &stream, HttpConnection &connection)
Handles the request, serving the requested file (GET) or creating a new one (PUT/POST) Call this meth...
bool getUseAsyncFileSend() const
Gets whether AsyncFileSend optimization is used for GET requests.
Definition HttpAsyncFileServer.h:84
Http connection abstraction holding both the incoming and outgoing messages in an HTTP transaction.
Definition HttpConnection.h:302
Incremental HTTP multipart/form-data parser.
Definition HttpMultipartParser.h:15
An ascii string used as boolean result. SC_TRY macro forwards errors to caller.
Definition Result.h:13
Pre-sized char array holding enough space to represent a file system path.
Definition StringPath.h:42
An read-only view over a string (to avoid including Strings library when parsing is not needed).
Definition StringSpan.h:37
Simple thread pool that executes tasks in a fixed number of worker threads.
Definition ThreadPool.h:38