Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[WebServer] Mark functions as const + reduce copy of strings #10339

Merged
merged 2 commits into from
Sep 13, 2024
Merged

[WebServer] Mark functions as const + reduce copy of strings #10339

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
4466fbb
[WebServer] Mark functions as const + reduce copy of strings
TD-er Sep 12, 2024
161434f
ci(pre-commit): Apply automatic fixes
pre-commit-ci-lite[bot] Sep 13, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions libraries/WebServer/src/Parsing.cpp
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -280,7 +280,7 @@ bool WebServer::_collectHeader(const char *headerName, const char *headerValue)
return false;
}

void WebServer::_parseArguments(String data) {
void WebServer::_parseArguments(const String& data) {
log_v("args: %s", data.c_str());
if (_currentArgs) {
delete[] _currentArgs;
Expand Down Expand Up @@ -387,7 +387,7 @@ int WebServer::_uploadReadByte(NetworkClient &client) {
return res;
}

bool WebServer::_parseForm(NetworkClient &client, String boundary, uint32_t len) {
bool WebServer::_parseForm(NetworkClient &client, const String& boundary, uint32_t len) {
(void)len;
log_v("Parse Form: Boundary: %s Length: %d", boundary.c_str(), len);
String line;
Expand Down
24 changes: 12 additions & 12 deletions libraries/WebServer/src/WebServer.cpp
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -673,14 +673,14 @@ void WebServer::_streamFileCore(const size_t fileSize, const String &fileName, c
send(code, contentType, "");
}

String WebServer::pathArg(unsigned int i) {
String WebServer::pathArg(unsigned int i) const {
if (_currentHandler != nullptr) {
return _currentHandler->pathArg(i);
}
return "";
}

String WebServer::arg(String name) {
String WebServer::arg(const String& name) const {
for (int j = 0; j < _postArgsLen; ++j) {
if (_postArgs[j].key == name) {
return _postArgs[j].value;
Expand All @@ -694,25 +694,25 @@ String WebServer::arg(String name) {
return "";
}

String WebServer::arg(int i) {
String WebServer::arg(int i) const {
if (i < _currentArgCount) {
return _currentArgs[i].value;
}
return "";
}

String WebServer::argName(int i) {
String WebServer::argName(int i) const {
if (i < _currentArgCount) {
return _currentArgs[i].key;
}
return "";
}

int WebServer::args() {
int WebServer::args() const {
return _currentArgCount;
}

bool WebServer::hasArg(String name) {
bool WebServer::hasArg(const String& name) const {
for (int j = 0; j < _postArgsLen; ++j) {
if (_postArgs[j].key == name) {
return true;
Expand All @@ -726,7 +726,7 @@ bool WebServer::hasArg(String name) {
return false;
}

String WebServer::header(String name) {
String WebServer::header(const String& name) const {
for (int i = 0; i < _headerKeysCount; ++i) {
if (_currentHeaders[i].key.equalsIgnoreCase(name)) {
return _currentHeaders[i].value;
Expand All @@ -748,25 +748,25 @@ void WebServer::collectHeaders(const char *headerKeys[], const size_t headerKeys
}
}

String WebServer::header(int i) {
String WebServer::header(int i) const {
if (i < _headerKeysCount) {
return _currentHeaders[i].value;
}
return "";
}

String WebServer::headerName(int i) {
String WebServer::headerName(int i) const {
if (i < _headerKeysCount) {
return _currentHeaders[i].key;
}
return "";
}

int WebServer::headers() {
int WebServer::headers() const {
return _headerKeysCount;
}

bool WebServer::hasHeader(String name) {
bool WebServer::hasHeader(const String& name) const {
for (int i = 0; i < _headerKeysCount; ++i) {
if ((_currentHeaders[i].key.equalsIgnoreCase(name)) && (_currentHeaders[i].value.length() > 0)) {
return true;
Expand All @@ -775,7 +775,7 @@ bool WebServer::hasHeader(String name) {
return false;
}

String WebServer::hostHeader() {
String WebServer::hostHeader() const {
return _hostHeader;
}

Expand Down
34 changes: 17 additions & 17 deletions libraries/WebServer/src/WebServer.h
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -158,10 +158,10 @@ class WebServer {
void onNotFound(THandlerFunction fn); //called when handler is not assigned
void onFileUpload(THandlerFunction ufn); //handle file uploads

String uri() {
String uri() const {
return _currentUri;
}
HTTPMethod method() {
HTTPMethod method() const {
return _currentMethod;
}
virtual NetworkClient &client() {
Expand All @@ -174,24 +174,24 @@ class WebServer {
return *_currentRaw;
}

String pathArg(unsigned int i); // get request path argument by number
String arg(String name); // get request argument value by name
String arg(int i); // get request argument value by number
String argName(int i); // get request argument name by number
int args(); // get arguments count
bool hasArg(String name); // check if argument exists
String pathArg(unsigned int i) const; // get request path argument by number
String arg(const String& name) const; // get request argument value by name
String arg(int i) const; // get request argument value by number
String argName(int i) const; // get request argument name by number
int args() const; // get arguments count
bool hasArg(const String& name) const; // check if argument exists
void collectHeaders(const char *headerKeys[], const size_t headerKeysCount); // set the request headers to collect
String header(String name); // get request header value by name
String header(int i); // get request header value by number
String headerName(int i); // get request header name by number
int headers(); // get header count
bool hasHeader(String name); // check if header exists
String header(const String& name) const; // get request header value by name
String header(int i) const; // get request header value by number
String headerName(int i) const; // get request header name by number
int headers() const; // get header count
bool hasHeader(const String& name) const; // check if header exists

int clientContentLength() {
int clientContentLength() const {
return _clientContentLength;
} // return "content-length" of incoming HTTP header from "_currentClient"

String hostHeader(); // get request host header if available or empty String if not
String hostHeader() const; // get request host header if available or empty String if not

// send response to the client
// code - HTTP response code, can be 200 or 404
Expand Down Expand Up @@ -240,9 +240,9 @@ class WebServer {
void _handleRequest();
void _finalizeResponse();
bool _parseRequest(NetworkClient &client);
void _parseArguments(String data);
void _parseArguments(const String& data);
static String _responseCodeToString(int code);
bool _parseForm(NetworkClient &client, String boundary, uint32_t len);
bool _parseForm(NetworkClient &client, const String& boundary, uint32_t len);
bool _parseFormUploadAborted();
void _uploadWriteByte(uint8_t b);
int _uploadReadByte(NetworkClient &client);
Expand Down
Loading