This repository was archived by the owner on Dec 29, 2023. It is now read-only.
forked from fhessel/esp32_https_server
-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy pathHTTPBodyParser.hpp
More file actions
62 lines (50 loc) · 1.91 KB
/
HTTPBodyParser.hpp
File metadata and controls
62 lines (50 loc) · 1.91 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
#ifndef SRC_HTTPBODYPARSER_HPP_
#define SRC_HTTPBODYPARSER_HPP_
#include <Arduino.h>
#include <string>
#include "HTTPRequest.hpp"
namespace httpsserver {
/**
* Superclass for various body parser implementations that can be used to
* interpret http-specific bodies (like x-www-form-urlencoded or multipart/form-data)
*
* To allow for arbitrary body length, the interface of the body parser provides access
* to one underlying "field" at a time. A field may be a value of the urlencoded string
* or a part of a multipart message.
*
* Using next() proceeds to the next field.
*/
class HTTPBodyParser {
public:
HTTPBodyParser(HTTPRequest * req): _request(req) {};
/**
* Proceeds to the next field of the body
*
* If a field has not been read completely, the remaining content is discarded.
*
* Returns true iff proceeding to the next field succeeded (ie there was a next field)
*/
virtual bool nextField() = 0;
/** Returns the name of the current field */
virtual std::string getFieldName() = 0;
/**
* Returns the mime type of the current field.
*
* Note: This value is set by the client. It can be altered maliciously. Do NOT rely on it
* for anything that affects the security of your device or other clients connected to it!
*
* Not every BodyParser might provide this value, usually it's set to something like text/plain then
*/
virtual std::string getFieldMimeType() = 0;
/** Returns the total length of the field */
virtual size_t getLength() = 0;
/** Returns the remaining length of the field. 0 means the field has been read completely */
virtual size_t getRemainingLength() = 0;
/** Reads a maximum of bufferSize bytes into buffer and returns the actual amount of bytes that have been read */
virtual size_t read(byte* buffer, size_t bufferSize) = 0;
protected:
/** The underlying request */
HTTPRequest * _request;
};
} // namespace httpserver
#endif