Skip to content

Allow custom headers between startRequest & endRequest #12

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.

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

Closed
wants to merge 2 commits into from
Closed
Show file tree
Hide file tree
Changes from all commits
Commits
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
89 changes: 89 additions & 0 deletions examples/CustomHeaders/CustomHeaders.ino
Original file line number Diff line number Diff line change
@@ -0,0 +1,89 @@
/*

Custom request header example for the ArduinoHttpClient
library. This example sends a GET request with a custom header every 5 seconds.

note: WiFi SSID and password are stored in config.h file.
If it is not present, add a new tab, call it "config.h"
and add the following variables:
char ssid[] = "ssid"; // your network SSID (name)
char pass[] = "password"; // your network password

based on SimpleGet example by Tom Igoe
header modifications by Todd Treece

this example is in the public domain
*/
#include <ArduinoHttpClient.h>
#include <WiFi101.h>
#include "config.h"

char serverAddress[] = "192.168.0.3"; // server address
int port = 8080;

WiFiClient wifi;
HttpClient client = HttpClient(wifi, serverAddress, port);
int status = WL_IDLE_STATUS;
String response;
int statusCode = 0;

void setup() {
Serial.begin(9600);
while ( status != WL_CONNECTED) {
Serial.print("Attempting to connect to Network named: ");
Serial.println(ssid); // print the network name (SSID);

// Connect to WPA/WPA2 network:
status = WiFi.begin(ssid, pass);
}

// print the SSID of the network you're attached to:
Serial.print("SSID: ");
Serial.println(WiFi.SSID());

// print your WiFi shield's IP address:
IPAddress ip = WiFi.localIP();
Serial.print("IP Address: ");
Serial.println(ip);
}

void loop() {

Serial.println("making GET request");
client.startRequest("/", HTTP_METHOD_GET);
client.sendHeader("X-CUSTOM-HEADER", "custom_value");
client.endRequest();

// read the status code and body of the response
statusCode = client.responseStatusCode();
response = client.responseBody();

Serial.print("GET Status code: ");
Serial.println(statusCode);
Serial.print("GET Response: ");
Serial.println(response);

Serial.println("Wait five seconds");
delay(5000);

Serial.println("making POST request");
String postData = "name=Alice&age=12";
client.startRequest("/", HTTP_METHOD_POST);
client.sendHeader(HTTP_HEADER_CONTENT_TYPE, "application/x-www-form-urlencoded");
client.sendHeader(HTTP_HEADER_CONTENT_LENGTH, postData.length());
client.sendHeader("X-CUSTOM-HEADER", "custom_value");
client.endRequest();
client.write((const byte*)postData.c_str(), postData.length());

// read the status code and body of the response
statusCode = client.responseStatusCode();
response = client.responseBody();

Serial.print("POST Status code: ");
Serial.println(statusCode);
Serial.print("POST Response: ");
Serial.println(response);

Serial.println("Wait five seconds");
delay(5000);
}
2 changes: 2 additions & 0 deletions examples/CustomHeaders/config.h
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
char ssid[] = "ssid"; // your network SSID (name)
char pass[] = "password"; // your network password
63 changes: 49 additions & 14 deletions src/HttpClient.cpp
Original file line number Diff line number Diff line change
Expand Up @@ -123,16 +123,11 @@ int HttpClient::startRequest(const char* aURLPath, const char* aHttpMethod,

bool hasBody = (aBody && aContentLength > 0);

if (initialState == eIdle || hasBody)
if (hasBody)
{
// This was a simple version of the API, so terminate the headers now
finishHeaders();
}
// else we'll call it in endRequest or in the first call to print, etc.

if (hasBody)
{
write(aBody, aContentLength);
write(aBody, aContentLength);
}
}

Expand Down Expand Up @@ -274,7 +269,11 @@ void HttpClient::endRequest()

int HttpClient::get(const char* aURLPath)
{
return startRequest(aURLPath, HTTP_METHOD_GET);
int ret = startRequest(aURLPath, HTTP_METHOD_GET);
if (HTTP_SUCCESS == ret) {
endRequest();
}
return ret;
}

int HttpClient::get(const String& aURLPath)
Expand All @@ -284,7 +283,13 @@ int HttpClient::get(const String& aURLPath)

int HttpClient::post(const char* aURLPath)
{
return startRequest(aURLPath, HTTP_METHOD_POST);
int ret = startRequest(aURLPath, HTTP_METHOD_POST);

if (HTTP_SUCCESS == ret) {
endRequest();
}

return ret;
}

int HttpClient::post(const String& aURLPath)
Expand All @@ -304,12 +309,24 @@ int HttpClient::post(const String& aURLPath, const String& aContentType, const S

int HttpClient::post(const char* aURLPath, const char* aContentType, int aContentLength, const byte aBody[])
{
return startRequest(aURLPath, HTTP_METHOD_POST, aContentType, aContentLength, aBody);
int ret = startRequest(aURLPath, HTTP_METHOD_POST, aContentType, aContentLength, aBody);

if (HTTP_SUCCESS == ret) {
endRequest();
}

return ret;
}

int HttpClient::put(const char* aURLPath)
{
return startRequest(aURLPath, HTTP_METHOD_PUT);
int ret = startRequest(aURLPath, HTTP_METHOD_PUT);

if (HTTP_SUCCESS == ret) {
endRequest();
}

return ret;
}

int HttpClient::put(const String& aURLPath)
Expand All @@ -329,12 +346,24 @@ int HttpClient::put(const String& aURLPath, const String& aContentType, const St

int HttpClient::put(const char* aURLPath, const char* aContentType, int aContentLength, const byte aBody[])
{
return startRequest(aURLPath, HTTP_METHOD_PUT, aContentType, aContentLength, aBody);
int ret = startRequest(aURLPath, HTTP_METHOD_PUT, aContentType, aContentLength, aBody);

if (HTTP_SUCCESS == ret) {
endRequest();
}

return ret;
}

int HttpClient::del(const char* aURLPath)
{
return startRequest(aURLPath, HTTP_METHOD_DELETE);
int ret = startRequest(aURLPath, HTTP_METHOD_DELETE);

if (HTTP_SUCCESS == ret) {
endRequest();
}

return ret;
}

int HttpClient::del(const String& aURLPath)
Expand All @@ -354,7 +383,13 @@ int HttpClient::del(const String& aURLPath, const String& aContentType, const St

int HttpClient::del(const char* aURLPath, const char* aContentType, int aContentLength, const byte aBody[])
{
return startRequest(aURLPath, HTTP_METHOD_DELETE, aContentType, aContentLength, aBody);
int ret = startRequest(aURLPath, HTTP_METHOD_DELETE, aContentType, aContentLength, aBody);

if (HTTP_SUCCESS == ret) {
endRequest();
}

return ret;
}

int HttpClient::responseStatusCode()
Expand Down