FreeRTOS: HTTPS Client
HTTPS Client v1.0.0 library
Return to main page ↑
Enumerated types

Enumerated types of the HTTPS Client library. More...

Enumerations

enum  IotHttpsReturnCode_t {
  IOT_HTTPS_OK = 0, IOT_HTTPS_INVALID_PARAMETER = 101, IOT_HTTPS_INVALID_PAYLOAD = 102, IOT_HTTPS_MESSAGE_TOO_LARGE = 103,
  IOT_HTTPS_OVERFLOW = 104, IOT_HTTPS_INSUFFICIENT_MEMORY = 105, IOT_HTTPS_QUEUE_FULL = 106, IOT_HTTPS_RETRY = 107,
  IOT_HTTPS_NOT_FOUND = 108, IOT_HTTPS_MESSAGE_FINISHED = 109, IOT_HTTPS_INTERNAL_ERROR = 201, IOT_HTTPS_NETWORK_ERROR = 202,
  IOT_HTTPS_CONNECTION_ERROR = 203, IOT_HTTPS_STREAM_ERROR = 204, IOT_HTTPS_AUTHENTICATION_ERROR = 205, IOT_HTTPS_TLS_ERROR = 206,
  IOT_HTTPS_USER_CALLBACK_ERROR = 207, IOT_HTTPS_TIMEOUT_ERROR = 208, IOT_HTTPS_PROTOCOL_ERROR = 209, IOT_HTTPS_SEND_ABORT = 210,
  IOT_HTTPS_RECEIVE_ABORT = 211, IOT_HTTPS_ASYNC_SCHEDULING_ERROR = 212, IOT_HTTPS_PARSING_ERROR = 213, IOT_HTTPS_FATAL = 901,
  IOT_HTTPS_BUSY = 902, IOT_HTTPS_TRY_AGAIN = 903, IOT_HTTPS_DATA_EXIST = 904, IOT_HTTPS_NOT_SUPPORTED = 905
}
 Return codes of HTTPS Client functions. More...
 
enum  IotHttpsMethod_t { IOT_HTTPS_METHOD_GET = 0, IOT_HTTPS_METHOD_HEAD, IOT_HTTPS_METHOD_PUT, IOT_HTTPS_METHOD_POST }
 Types of HTTP methods. More...
 
enum  IotHttpsResponseStatus {
  IOT_HTTPS_STATUS_CONTINUE = 100, IOT_HTTPS_STATUS_SWITCHING_PROTOCOLS, IOT_HTTPS_STATUS_OK = 200, IOT_HTTPS_STATUS_CREATED,
  IOT_HTTPS_STATUS_ACCEPTED, IOT_HTTPS_STATUS_NON_AUTHORITIVE_INFORMATION, IOT_HTTPS_STATUS_NO_CONTENT, IOT_HTTPS_STATUS_RESET_CONTENT,
  IOT_HTTPS_STATUS_PARTIAL_CONTENT, IOT_HTTPS_STATUS_MULTIPLE_CHOICES = 300, IOT_HTTPS_STATUS_MOVED_PERMANENTLY, IOT_HTTPS_STATUS_FOUND,
  IOT_HTTPS_STATUS_SEE_OTHER, IOT_HTTPS_STATUS_NOT_MODIFIED, IOT_HTTPS_STATUS_USE_PROXY, IOT_HTTPS_STATUS_UNUSED,
  IOT_HTTPS_STATUS_TEMPORARY_REDIRECT, IOT_HTTPS_STATUS_BAD_REQUEST = 400, IOT_HTTPS_STATUS_UNAUTHORIZED, IOT_HTTPS_STATUS_PAYMENT_REQUIRED,
  IOT_HTTPS_STATUS_FORBIDDEN, IOT_HTTPS_STATUS_NOT_FOUND, IOT_HTTPS_STATUS_METHOD_NOT_ALLOWED, IOT_HTTPS_STATUS_NOT_ACCEPTABLE,
  IOT_HTTPS_STATUS_PROXY_AUTHENTICATION_REQUIRED, IOT_HTTPS_STATUS_REQUEST_TIMEOUT, IOT_HTTPS_STATUS_CONFLICT, IOT_HTTPS_STATUS_GONE,
  IOT_HTTPS_STATUS_LENGTH_REQUIRED, IOT_HTTPS_STATUS_PRECONDITION_FAILED, IOT_HTTPS_STATUS_REQUEST_ENTITY_TOO_LARGE, IOT_HTTPS_STATUS_REQUEST_URI_TOO_LONG,
  IOT_HTTPS_STATUS_UNSUPPORTED_MEDIA_TYPE, IOT_HTTPS_STATUS_REQUEST_RANGE_NOT_SATISFIABLE, IOT_HTTPS_STATUS_EXPECTATION_FAILED, IOT_HTTPS_STATUS_INTERNAL_SERVER_ERROR = 500,
  IOT_HTTPS_STATUS_NOT_IMPLEMENTED, IOT_HTTPS_STATUS_BAD_GATEWAY, IOT_HTTPS_STATUS_SERVICE_UNAVAILABLE, IOT_HTTPS_STATUS_GATEWAY_TIMEOUT,
  IOT_HTTPS_STATUS_HTTP_VERSION_NOT_SUPPORTED
}
 Types of standard HTTP Response status codes. More...
 

Detailed Description

Enumerated types of the HTTPS Client library.

Enumeration Type Documentation

◆ IotHttpsReturnCode_t

Return codes of HTTPS Client functions.

Enumerator
IOT_HTTPS_OK 

Returned for a successful operation.

IOT_HTTPS_INVALID_PARAMETER 

An invalid parameter was passed into an API function.

IOT_HTTPS_INVALID_PAYLOAD 

Invalid payload.

IOT_HTTPS_MESSAGE_TOO_LARGE 

HTTPS message was too large to fit into a configured synchronous body buffer.

IOT_HTTPS_OVERFLOW 

Overflow occurred somewhere.

IOT_HTTPS_INSUFFICIENT_MEMORY 

A buffer provided could not hold data required by the library.

IOT_HTTPS_QUEUE_FULL 

Queue full.

IOT_HTTPS_RETRY 

Operation retry.

IOT_HTTPS_NOT_FOUND 

Could not find an item specified by an API.

Returned for not being able to find the address in a URL, the path in a URL, or a header field from the response headers.

IOT_HTTPS_MESSAGE_FINISHED 

The HTTP request message was finished being written and we cannot write more with IotHttpsClient_WriteRequestBody.

IOT_HTTPS_INTERNAL_ERROR 

An error occurred internally to the library.

IOT_HTTPS_NETWORK_ERROR 

A network error occurred.

IOT_HTTPS_CONNECTION_ERROR 

A network connection error occurred.

IOT_HTTPS_STREAM_ERROR 

A stream error occurred.

IOT_HTTPS_AUTHENTICATION_ERROR 

An authentication error occurred.

IOT_HTTPS_TLS_ERROR 

A TLS error occurred.

IOT_HTTPS_USER_CALLBACK_ERROR 

An error occurred during the user callback.

IOT_HTTPS_TIMEOUT_ERROR 

The synchronous response could not be received in the specified timeout in IotHttpsClient_SendSync.

IOT_HTTPS_PROTOCOL_ERROR 

An error in the HTTP protocol.

IOT_HTTPS_SEND_ABORT 

The HTTPS request send was cancelled.

IOT_HTTPS_RECEIVE_ABORT 

The HTTPS response receiving was cancelled.

IOT_HTTPS_ASYNC_SCHEDULING_ERROR 

The asynchronous request had an error being scheduled.

IOT_HTTPS_PARSING_ERROR 

There was an error parsing the HTTP response.

IOT_HTTPS_FATAL 

Fatal HTTP library error.

IOT_HTTPS_BUSY 

The connection is busy and cannot be cleaned up.

The connection was closed, but IotHttpsClient_Disconnect must be called again to cleanup connection resources.

IOT_HTTPS_TRY_AGAIN 

Try again.

IOT_HTTPS_DATA_EXIST 

Data exists.

IOT_HTTPS_NOT_SUPPORTED 

The operation on the public API is not supported.

◆ IotHttpsMethod_t

Types of HTTP methods.

The HTTP method is configured in IotHttpsRequestInfo_t.method.

◆ IotHttpsResponseStatus

Types of standard HTTP Response status codes.

These status codes are taken from RFC 2616. Please see RFC 2616 for a description of each response status.