HTTP Client#

This module contains the HTTP Client API constants.

Enumerations#

enum
sl_http_client_method_type_t {
SL_HTTP_GET = 0
SL_HTTP_POST = 1
SL_HTTP_HEAD = 2
SL_HTTP_PUT = 3
SL_HTTP_DELETE = 4
}

HTTP client methods.

enum
sl_http_client_tls_version_t {
SL_TLS_V_1_0 = 0
SL_TLS_V_1_1 = 1
SL_TLS_V_1_2 = 2
SL_TLS_V_1_3 = 3
}

HTTPS client TLS versions.

enum
sl_http_client_version_t {
SL_HTTP_V_1_0 = 0
SL_HTTP_V_1_1 = 1
}

HTTP versions.

enum
sl_http_client_event_t {
SL_HTTP_CLIENT_GET_RESPONSE_EVENT = 0
SL_HTTP_CLIENT_POST_RESPONSE_EVENT
SL_HTTP_CLIENT_PUT_RESPONSE_EVENT
SL_HTTP_CLIENT_MAX_EVENT
}

HTTP client events.

Macros#

#define
SL_HTTP_CLIENT_MAX_WRITE_BUFFER_LENGTH 900

MAX buffer length for write data.

#define
SL_HTTPS_CLIENT_DEFAULT_CERTIFICATE_INDEX 0

HTTPS client Certificate Index constants.

#define
SL_HTTPS_CLIENT_CERTIFICATE_INDEX_1 1

HTTPS CLIENT 1st Certificate Index.

#define
SL_HTTPS_CLIENT_CERTIFICATE_INDEX_2 2

HTTPS CLIENT 2nd Certificate Index.

Enumeration Documentation#

sl_http_client_method_type_t#

sl_http_client_method_type_t

HTTP client methods.

Note

  • 917 does not support SL_HTTP_HEAD and SL_HTTP_DELETE in current release.

Enumerator
SL_HTTP_GET

HTTP Request Method type GET.

SL_HTTP_POST

HTTP Request Method type POST.

SL_HTTP_HEAD

HTTP Request Method type HEAD.

SL_HTTP_PUT

HTTP Request Method type PUT.

SL_HTTP_DELETE

HTTP Request Method type DELETE.


Definition at line 57 of file components/service/http_client/inc/sl_http_client.h

sl_http_client_tls_version_t#

sl_http_client_tls_version_t

HTTPS client TLS versions.

Enumerator
SL_TLS_V_1_0

Use TLS Version 1.0 for HTTP Client.

SL_TLS_V_1_1

Use TLS Version 1.1 for HTTP Client.

SL_TLS_V_1_2

Use TLS Version 1.2 for HTTP Client.

SL_TLS_V_1_3

Use TLS Version 1.3 for HTTP Client.


Definition at line 68 of file components/service/http_client/inc/sl_http_client.h

sl_http_client_version_t#

sl_http_client_version_t

HTTP versions.

Enumerator
SL_HTTP_V_1_0

Use HTTP Protocol version 1.0.

SL_HTTP_V_1_1

Use HTTP Protocol version 1.1.


Definition at line 76 of file components/service/http_client/inc/sl_http_client.h

sl_http_client_event_t#

sl_http_client_event_t

HTTP client events.

Enumerator
SL_HTTP_CLIENT_GET_RESPONSE_EVENT

HTTP Client GET response Event.

SL_HTTP_CLIENT_POST_RESPONSE_EVENT

HTTP Client POST response Event.

SL_HTTP_CLIENT_PUT_RESPONSE_EVENT

HTTP Client PUT response Event.

SL_HTTP_CLIENT_MAX_EVENT

HTTP Client Maximum number of events.


Definition at line 82 of file components/service/http_client/inc/sl_http_client.h

Macro Definition Documentation#

SL_HTTP_CLIENT_MAX_WRITE_BUFFER_LENGTH#

#define SL_HTTP_CLIENT_MAX_WRITE_BUFFER_LENGTH
Value:
900

MAX buffer length for write data.


Definition at line 38 of file components/service/http_client/inc/sl_http_client.h

SL_HTTPS_CLIENT_DEFAULT_CERTIFICATE_INDEX#

#define SL_HTTPS_CLIENT_DEFAULT_CERTIFICATE_INDEX
Value:
0

HTTPS client Certificate Index constants.


Definition at line 41 of file components/service/http_client/inc/sl_http_client.h

SL_HTTPS_CLIENT_CERTIFICATE_INDEX_1#

#define SL_HTTPS_CLIENT_CERTIFICATE_INDEX_1
Value:
1

HTTPS CLIENT 1st Certificate Index.


Definition at line 44 of file components/service/http_client/inc/sl_http_client.h

SL_HTTPS_CLIENT_CERTIFICATE_INDEX_2#

#define SL_HTTPS_CLIENT_CERTIFICATE_INDEX_2
Value:
2

HTTPS CLIENT 2nd Certificate Index.


Definition at line 47 of file components/service/http_client/inc/sl_http_client.h