You can not select more than 25 topics
Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
96 lines
3.4 KiB
96 lines
3.4 KiB
/*
|
|
* ----------------------------------------------------------------------------
|
|
* "THE BEER-WARE LICENSE" (Revision 42):
|
|
* Martin d'Allens <martin.dallens@gmail.com> wrote this file. As long as you retain
|
|
* this notice you can do whatever you want with this stuff. If we meet some day,
|
|
* and you think this stuff is worth it, you can buy me a beer in return.
|
|
* ----------------------------------------------------------------------------
|
|
*/
|
|
|
|
#ifndef HTTPCLIENT_H
|
|
#define HTTPCLIENT_H
|
|
|
|
#include <esp8266.h>
|
|
#include <httpd.h>
|
|
|
|
#define HTTP_STATUS_GENERIC_ERROR -1 // In case of TCP or DNS error the callback is called with this status.
|
|
#define HTTP_STATUS_TIMEOUT -2
|
|
|
|
#define HTTPCLIENT_DEF_MAX_LEN 5000 // Size of http responses that will cause an error.
|
|
#define HTTPCLIENT_DEF_TIMEOUT_MS 5000
|
|
|
|
/* Define this if ssl is needed. Also link the ssl lib */
|
|
//#define USE_SECURE
|
|
|
|
/**
|
|
* "full_response" is a string containing all response headers and the response body.
|
|
* "response_body and "http_status" are extracted from "full_response" for convenience.
|
|
*
|
|
* A successful request corresponds to an HTTP status code of 200 (OK).
|
|
* More info at http://en.wikipedia.org/wiki/List_of_HTTP_status_codes
|
|
*/
|
|
typedef void (* httpclient_cb)(int http_status,
|
|
char *response_headers,
|
|
char *response_body,
|
|
size_t body_size,
|
|
void *userData);
|
|
|
|
typedef struct {
|
|
const char* url; //!< The full URL
|
|
const char* headers; //!< Headers string (\r\n separated lines)
|
|
const char* body; //!< Request body string
|
|
httpd_method method; //!< HTTP method constant
|
|
int timeout; //!< Timeout in ms
|
|
size_t max_response_len; //!< Max response length to allow
|
|
void *userData; //!< Opaque pointer that is passed to the user callback
|
|
} httpclient_args;
|
|
|
|
/**
|
|
* Populate args struct with defaults
|
|
* @param args
|
|
*/
|
|
void httpclient_args_init(httpclient_args *args);
|
|
|
|
/**
|
|
* @brief Download a web page from its URL.
|
|
*
|
|
* Try:
|
|
* http_get("http://wtfismyip.com/text", NULL, http_callback_example);
|
|
*/
|
|
bool http_get(const char * url, void *userData, httpclient_cb user_callback);
|
|
|
|
/**
|
|
* @brief Post data to a web form.
|
|
*
|
|
* The data should be encoded as application/x-www-form-urlencoded.
|
|
*
|
|
* Try:
|
|
* http_post("http://httpbin.org/post", "first_word=hello&second_word=world", NULL, http_callback_example);
|
|
*/
|
|
bool http_post(const char *url, const char *post_data, void *userData, httpclient_cb user_callback);
|
|
|
|
/** Like POST, but with the PUT method. */
|
|
bool http_put(const char *url, const char *body, void *userData, httpclient_cb user_callback);
|
|
|
|
/**
|
|
* @brief Send a HTTP request
|
|
* @param url : protocol://host[:port][/path]
|
|
* @param method : get, post, ...
|
|
* @param body : request body. If GET & body != NULL, method changes to POST.
|
|
* @param headers : additional headers string. Must end with \r\n
|
|
* @param user_callback : callback for parsing the response
|
|
* @return success (in sending)
|
|
*/
|
|
bool http_request(const httpclient_args *args, httpclient_cb user_callback);
|
|
|
|
/**
|
|
* Output on the UART.
|
|
*/
|
|
void http_callback_example(int http_status, char *response_headers, char *response_body, size_t body_size, void *userData);
|
|
|
|
/**
|
|
* Show status code, and body on error. Error/warn log msg on error.
|
|
*/
|
|
void http_callback_showstatus(int code, char *response_headers, char *response_body, size_t body_size, void *userData);
|
|
|
|
#endif
|
|
|