httpsserver::HTTPURLEncodedBodyParser Class Reference

Inheritance diagram for httpsserver::HTTPURLEncodedBodyParser:

Collaboration diagram for httpsserver::HTTPURLEncodedBodyParser:

Public Member Functions
	HTTPURLEncodedBodyParser (HTTPRequest *req)
virtual bool	nextField ()
virtual std::string	getFieldName ()
virtual std::string	getFieldFilename ()
virtual std::string	getFieldMimeType ()
virtual bool	endOfField ()
virtual size_t	read (byte *buffer, size_t bufferSize)
Public Member Functions inherited from httpsserver::HTTPBodyParser
	HTTPBodyParser (HTTPRequest *req)

Protected Attributes
char *	bodyBuffer
char *	bodyPtr
size_t	bodyLength
std::string	fieldName
std::string	fieldBuffer
const char *	fieldPtr
size_t	fieldRemainingLength
Protected Attributes inherited from httpsserver::HTTPBodyParser
HTTPRequest *	_request

Additional Inherited Members
Public Attributes inherited from httpsserver::HTTPBodyParser
const size_t	unknownLength = 0x7ffffffe

Member Function Documentation

endOfField()

bool httpsserver::HTTPURLEncodedBodyParser::endOfField ( )

virtual

Returns true when all field data has been read

Implements httpsserver::HTTPBodyParser.

getFieldFilename()

std::string httpsserver::HTTPURLEncodedBodyParser::getFieldFilename ( )

virtual

Returns the filename of the current field or an empty string

Implements httpsserver::HTTPBodyParser.

getFieldMimeType()

std::string httpsserver::HTTPURLEncodedBodyParser::getFieldMimeType ( )

virtual

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

Implements httpsserver::HTTPBodyParser.

getFieldName()

std::string httpsserver::HTTPURLEncodedBodyParser::getFieldName ( )

virtual

Returns the name of the current field

Implements httpsserver::HTTPBodyParser.

nextField()

bool httpsserver::HTTPURLEncodedBodyParser::nextField ( )

virtual

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)

Implements httpsserver::HTTPBodyParser.

read()

size_t httpsserver::HTTPURLEncodedBodyParser::read ( byte *  buffer, size_t  bufferSize  )

virtual

Reads a maximum of bufferSize bytes into buffer and returns the actual amount of bytes that have been read

Implements httpsserver::HTTPBodyParser.

---

The documentation for this class was generated from the following files:

• /home/frank/Projekte/esp32/https_server/esp32_https_server/src/HTTPURLEncodedBodyParser.hpp
• /home/frank/Projekte/esp32/https_server/esp32_https_server/src/HTTPURLEncodedBodyParser.cpp