Filter results by

Older Versions

Older API versions are available as a download. To view, extract the file and open the index.html file in a web browser.

artik_http.h File Reference

HTTP module definition. More...

#include "artik_error.h"
#include "artik_types.h"
#include "artik_ssl.h"

Go to the source code of this file.

Data Structures

struct  artik_http_header_field
 HTTP header field structure. More...
 
struct  artik_http_headers
 HTTP headers structure. More...
 
struct  artik_http_module
 HTTP module operations. More...
 

Macros

#define MAX_HEADER_SIZE   256
 Maximum length for headers. More...
 

Typedefs

typedef int(* artik_http_stream_callback) (char *data, unsigned int len, void *user_data)
 Stream data callback prototype. More...
 
typedef void(* artik_http_response_callback) (artik_error result, int status, char *response, void *user_data)
 Response callback prototype. More...
 

Variables

const artik_http_module http_module
 

Detailed Description

Definitions and functions for accessing the HTTP module and performing HTTP/HTTPS requests to remote servers

Definition in file artik_http.h.

Macro Definition Documentation

#define MAX_HEADER_SIZE   256

Maximum length allowed for string containing the name and the date of a HTTP header

Definition at line 49 of file artik_http.h.

Typedef Documentation

typedef void(* artik_http_response_callback) (artik_error result, int status, char *response, void *user_data)
Parameters
[in]resultError returned by the http process, S_OK on success, error code otherwise
[in]statusStatus filled up by the function with the server's response status
[in]responseString allocated and filled up by the function with the response body returned by the server.
[in]user_dataThe user data passed from the callback function

Definition at line 109 of file artik_http.h.

typedef int(* artik_http_stream_callback) (char *data, unsigned int len, void *user_data)
Parameters
[in]dataReceived data
[in]lenLength of the received data
[in]user_dataThe user data passed from the callback function

Definition at line 93 of file artik_http.h.

Last updated on: