Skip to content

Commit

Permalink
Reworked to trim down the code size of sketches using HttpClient
Browse files Browse the repository at this point in the history
  • Loading branch information
Adrian McEwen committed Nov 24, 2013
1 parent fa50bfd commit 53cc49f
Show file tree
Hide file tree
Showing 2 changed files with 33 additions and 27 deletions.
21 changes: 10 additions & 11 deletions HttpClient.cpp
Original file line number Diff line number Diff line change
Expand Up @@ -7,16 +7,10 @@
#ifdef PROXY_ENABLED // currently disabled as introduces dependency on Dns.h in Ethernet
#include <Dns.h>
#endif
#include <string.h>
#include <ctype.h>

// Initialize constants
const char* HttpClient::kUserAgent = "Arduino/2.0";
const char* HttpClient::kGet = "GET";
const char* HttpClient::kPost = "POST";
const char* HttpClient::kPut = "PUT";
const char* HttpClient::kDelete = "DELETE";
const char* HttpClient::kContentLengthPrefix = "Content-Length: ";
const char* HttpClient::kUserAgent = "Arduino/2.1";
const char* HttpClient::kContentLengthPrefix = HTTP_HEADER_CONTENT_LENGTH ": ";

#ifdef PROXY_ENABLED // currently disabled as introduces dependency on Dns.h in Ethernet
HttpClient::HttpClient(Client& aClient, const char* aProxy, uint16_t aProxyPort)
Expand Down Expand Up @@ -70,6 +64,7 @@ int HttpClient::startRequest(const char* aServerName, uint16_t aServerPort, cons
return HTTP_ERROR_API;
}

#ifdef PROXY_ENABLED
if (iProxyPort)
{
if (!iClient->connect(iProxyAddress, iProxyPort) > 0)
Expand All @@ -81,6 +76,7 @@ int HttpClient::startRequest(const char* aServerName, uint16_t aServerPort, cons
}
}
else
#endif
{
if (!iClient->connect(aServerName, aServerPort) > 0)
{
Expand Down Expand Up @@ -111,6 +107,7 @@ int HttpClient::startRequest(const IPAddress& aServerAddress, const char* aServe
return HTTP_ERROR_API;
}

#ifdef PROXY_ENABLED
if (iProxyPort)
{
if (!iClient->connect(iProxyAddress, iProxyPort) > 0)
Expand All @@ -122,6 +119,7 @@ int HttpClient::startRequest(const IPAddress& aServerAddress, const char* aServe
}
}
else
#endif
{
if (!iClient->connect(aServerAddress, aServerPort) > 0)
{
Expand Down Expand Up @@ -152,6 +150,7 @@ int HttpClient::sendInitialHeaders(const char* aServerName, IPAddress aServerIP,
// Send the HTTP command, i.e. "GET /somepath/ HTTP/1.0"
iClient->print(aHttpMethod);
iClient->print(" ");
#ifdef PROXY_ENABLED
if (iProxyPort)
{
// We're going through a proxy, send a full URL
Expand All @@ -172,6 +171,7 @@ int HttpClient::sendInitialHeaders(const char* aServerName, IPAddress aServerIP,
iClient->print(aPort);
}
}
#endif
iClient->print(aURLPath);
iClient->println(" HTTP/1.1");
// The host header, if required
Expand All @@ -187,14 +187,13 @@ int HttpClient::sendInitialHeaders(const char* aServerName, IPAddress aServerIP,
iClient->println();
}
// And user-agent string
iClient->print("User-Agent: ");
if (aUserAgent)
{
iClient->println(aUserAgent);
sendHeader(HTTP_HEADER_USER_AGENT, aUserAgent);
}
else
{
iClient->println(kUserAgent);
sendHeader(HTTP_HEADER_USER_AGENT, kUserAgent);
}

// Everything has gone well
Expand Down
39 changes: 23 additions & 16 deletions HttpClient.h
Original file line number Diff line number Diff line change
Expand Up @@ -23,16 +23,23 @@ static const int HTTP_ERROR_TIMED_OUT =-3;
// server?
static const int HTTP_ERROR_INVALID_RESPONSE =-4;

// Define some of the common methods and headers here
// That lets other code reuse them without having to declare another copy
// of them, so saves code space and RAM
#define HTTP_METHOD_GET "GET"
#define HTTP_METHOD_POST "POST"
#define HTTP_METHOD_PUT "PUT"
#define HTTP_METHOD_DELETE "DELETE"
#define HTTP_HEADER_CONTENT_LENGTH "Content-Length"
#define HTTP_HEADER_CONNECTION "Connection"
#define HTTP_HEADER_USER_AGENT "User-Agent"

class HttpClient : public Client
{
public:
static const int kNoContentLengthHeader =-1;
static const int kHttpPort =80;
static const char* kUserAgent;
static const char* kGet;
static const char* kPost;
static const char* kPut;
static const char* kDelete;

// FIXME Write longer API request, using port and user-agent, example
// FIXME Update tempToPachube example to calculate Content-Length correctly
Expand Down Expand Up @@ -66,7 +73,7 @@ class HttpClient : public Client
*/
int get(const char* aServerName, uint16_t aServerPort, const char* aURLPath,
const char* aUserAgent =NULL)
{ return startRequest(aServerName, aServerPort, aURLPath, kGet, aUserAgent); }
{ return startRequest(aServerName, aServerPort, aURLPath, HTTP_METHOD_GET, aUserAgent); }

/** Connect to the server and start to send a GET request.
@param aServerName Name of the server being connected to. If NULL, the
Expand All @@ -77,7 +84,7 @@ class HttpClient : public Client
@return 0 if successful, else error
*/
int get(const char* aServerName, const char* aURLPath, const char* aUserAgent =NULL)
{ return startRequest(aServerName, kHttpPort, aURLPath, kGet, aUserAgent); }
{ return startRequest(aServerName, kHttpPort, aURLPath, HTTP_METHOD_GET, aUserAgent); }

/** Connect to the server and start to send a GET request. This version connects
doesn't perform a DNS lookup and just connects to the given IP address.
Expand All @@ -95,7 +102,7 @@ class HttpClient : public Client
uint16_t aServerPort,
const char* aURLPath,
const char* aUserAgent =NULL)
{ return startRequest(aServerAddress, aServerName, aServerPort, aURLPath, kGet, aUserAgent); }
{ return startRequest(aServerAddress, aServerName, aServerPort, aURLPath, HTTP_METHOD_GET, aUserAgent); }

/** Connect to the server and start to send a GET request. This version connects
doesn't perform a DNS lookup and just connects to the given IP address.
Expand All @@ -111,7 +118,7 @@ class HttpClient : public Client
const char* aServerName,
const char* aURLPath,
const char* aUserAgent =NULL)
{ return startRequest(aServerAddress, aServerName, kHttpPort, aURLPath, kGet, aUserAgent); }
{ return startRequest(aServerAddress, aServerName, kHttpPort, aURLPath, HTTP_METHOD_GET, aUserAgent); }

/** Connect to the server and start to send a POST request.
@param aServerName Name of the server being connected to. If NULL, the
Expand All @@ -126,7 +133,7 @@ class HttpClient : public Client
uint16_t aServerPort,
const char* aURLPath,
const char* aUserAgent =NULL)
{ return startRequest(aServerName, aServerPort, aURLPath, kPost, aUserAgent); }
{ return startRequest(aServerName, aServerPort, aURLPath, HTTP_METHOD_POST, aUserAgent); }

/** Connect to the server and start to send a POST request.
@param aServerName Name of the server being connected to. If NULL, the
Expand All @@ -139,7 +146,7 @@ class HttpClient : public Client
int post(const char* aServerName,
const char* aURLPath,
const char* aUserAgent =NULL)
{ return startRequest(aServerName, kHttpPort, aURLPath, kPost, aUserAgent); }
{ return startRequest(aServerName, kHttpPort, aURLPath, HTTP_METHOD_POST, aUserAgent); }

/** Connect to the server and start to send a POST request. This version connects
doesn't perform a DNS lookup and just connects to the given IP address.
Expand All @@ -157,7 +164,7 @@ class HttpClient : public Client
uint16_t aServerPort,
const char* aURLPath,
const char* aUserAgent =NULL)
{ return startRequest(aServerAddress, aServerName, aServerPort, aURLPath, kPost, aUserAgent); }
{ return startRequest(aServerAddress, aServerName, aServerPort, aURLPath, HTTP_METHOD_POST, aUserAgent); }

/** Connect to the server and start to send a POST request. This version connects
doesn't perform a DNS lookup and just connects to the given IP address.
Expand All @@ -173,7 +180,7 @@ class HttpClient : public Client
const char* aServerName,
const char* aURLPath,
const char* aUserAgent =NULL)
{ return startRequest(aServerAddress, aServerName, kHttpPort, aURLPath, kPost, aUserAgent); }
{ return startRequest(aServerAddress, aServerName, kHttpPort, aURLPath, HTTP_METHOD_POST, aUserAgent); }

/** Connect to the server and start to send a PUT request.
@param aServerName Name of the server being connected to. If NULL, the
Expand All @@ -188,7 +195,7 @@ class HttpClient : public Client
uint16_t aServerPort,
const char* aURLPath,
const char* aUserAgent =NULL)
{ return startRequest(aServerName, aServerPort, aURLPath, kPut, aUserAgent); }
{ return startRequest(aServerName, aServerPort, aURLPath, HTTP_METHOD_PUT, aUserAgent); }

/** Connect to the server and start to send a PUT request.
@param aServerName Name of the server being connected to. If NULL, the
Expand All @@ -201,7 +208,7 @@ class HttpClient : public Client
int put(const char* aServerName,
const char* aURLPath,
const char* aUserAgent =NULL)
{ return startRequest(aServerName, kHttpPort, aURLPath, kPut, aUserAgent); }
{ return startRequest(aServerName, kHttpPort, aURLPath, HTTP_METHOD_PUT, aUserAgent); }

/** Connect to the server and start to send a PUT request. This version connects
doesn't perform a DNS lookup and just connects to the given IP address.
Expand All @@ -219,7 +226,7 @@ class HttpClient : public Client
uint16_t aServerPort,
const char* aURLPath,
const char* aUserAgent =NULL)
{ return startRequest(aServerAddress, aServerName, aServerPort, aURLPath, kPut, aUserAgent); }
{ return startRequest(aServerAddress, aServerName, aServerPort, aURLPath, HTTP_METHOD_PUT, aUserAgent); }

/** Connect to the server and start to send a PUT request. This version connects
doesn't perform a DNS lookup and just connects to the given IP address.
Expand All @@ -235,7 +242,7 @@ class HttpClient : public Client
const char* aServerName,
const char* aURLPath,
const char* aUserAgent =NULL)
{ return startRequest(aServerAddress, aServerName, kHttpPort, aURLPath, kPut, aUserAgent); }
{ return startRequest(aServerAddress, aServerName, kHttpPort, aURLPath, HTTP_METHOD_PUT, aUserAgent); }

/** Connect to the server and start to send the request.
@param aServerName Name of the server being connected to.
Expand Down

0 comments on commit 53cc49f

Please sign in to comment.