az_http.h

Go to the documentation of this file.

// Copyright (c) Microsoft Corporation. All rights reserved.
// SPDX-License-Identifier: MIT
 
#ifndef _az_HTTP_H
#define _az_HTTP_H
 
#include <azure/core/az_config.h>
#include <azure/core/az_context.h>
#include <azure/core/az_result.h>
#include <azure/core/az_span.h>
 
#include <stdbool.h>
#include <stdint.h>
 
#include <azure/core/_az_cfg_prefix.h>
 
typedef enum
{
  AZ_HTTP_STATUS_CODE_NONE = 0,
 
  // === 1xx (information) Status Codes: ===
  AZ_HTTP_STATUS_CODE_CONTINUE = 100, 
  AZ_HTTP_STATUS_CODE_SWITCHING_PROTOCOLS = 101, 
  AZ_HTTP_STATUS_CODE_PROCESSING = 102, 
  AZ_HTTP_STATUS_CODE_EARLY_HINTS = 103, 
 
  // === 2xx (successful) Status Codes: ===
  AZ_HTTP_STATUS_CODE_OK = 200, 
  AZ_HTTP_STATUS_CODE_CREATED = 201, 
  AZ_HTTP_STATUS_CODE_ACCEPTED = 202, 
  AZ_HTTP_STATUS_CODE_NON_AUTHORITATIVE_INFORMATION
  = 203, 
  AZ_HTTP_STATUS_CODE_NO_CONTENT = 204, 
  AZ_HTTP_STATUS_CODE_RESET_CONTENT = 205, 
  AZ_HTTP_STATUS_CODE_PARTIAL_CONTENT = 206, 
  AZ_HTTP_STATUS_CODE_MULTI_STATUS = 207, 
  AZ_HTTP_STATUS_CODE_ALREADY_REPORTED = 208, 
  AZ_HTTP_STATUS_CODE_IM_USED = 226, 
 
  // === 3xx (redirection) Status Codes: ===
  AZ_HTTP_STATUS_CODE_MULTIPLE_CHOICES = 300, 
  AZ_HTTP_STATUS_CODE_MOVED_PERMANENTLY = 301, 
  AZ_HTTP_STATUS_CODE_FOUND = 302, 
  AZ_HTTP_STATUS_CODE_SEE_OTHER = 303, 
  AZ_HTTP_STATUS_CODE_NOT_MODIFIED = 304, 
  AZ_HTTP_STATUS_CODE_USE_PROXY = 305, 
  AZ_HTTP_STATUS_CODE_TEMPORARY_REDIRECT = 307, 
  AZ_HTTP_STATUS_CODE_PERMANENT_REDIRECT = 308, 
 
  // === 4xx (client error) Status Codes: ===
  AZ_HTTP_STATUS_CODE_BAD_REQUEST = 400, 
  AZ_HTTP_STATUS_CODE_UNAUTHORIZED = 401, 
  AZ_HTTP_STATUS_CODE_PAYMENT_REQUIRED = 402, 
  AZ_HTTP_STATUS_CODE_FORBIDDEN = 403, 
  AZ_HTTP_STATUS_CODE_NOT_FOUND = 404, 
  AZ_HTTP_STATUS_CODE_METHOD_NOT_ALLOWED = 405, 
  AZ_HTTP_STATUS_CODE_NOT_ACCEPTABLE = 406, 
  AZ_HTTP_STATUS_CODE_PROXY_AUTHENTICATION_REQUIRED
  = 407, 
  AZ_HTTP_STATUS_CODE_REQUEST_TIMEOUT = 408, 
  AZ_HTTP_STATUS_CODE_CONFLICT = 409, 
  AZ_HTTP_STATUS_CODE_GONE = 410, 
  AZ_HTTP_STATUS_CODE_LENGTH_REQUIRED = 411, 
  AZ_HTTP_STATUS_CODE_PRECONDITION_FAILED = 412, 
  AZ_HTTP_STATUS_CODE_PAYLOAD_TOO_LARGE = 413, 
  AZ_HTTP_STATUS_CODE_URI_TOO_LONG = 414, 
  AZ_HTTP_STATUS_CODE_UNSUPPORTED_MEDIA_TYPE = 415, 
  AZ_HTTP_STATUS_CODE_RANGE_NOT_SATISFIABLE = 416, 
  AZ_HTTP_STATUS_CODE_EXPECTATION_FAILED = 417, 
  AZ_HTTP_STATUS_CODE_MISDIRECTED_REQUEST = 421, 
  AZ_HTTP_STATUS_CODE_UNPROCESSABLE_ENTITY = 422, 
  AZ_HTTP_STATUS_CODE_LOCKED = 423, 
  AZ_HTTP_STATUS_CODE_FAILED_DEPENDENCY = 424, 
  AZ_HTTP_STATUS_CODE_TOO_EARLY = 425, 
  AZ_HTTP_STATUS_CODE_UPGRADE_REQUIRED = 426, 
  AZ_HTTP_STATUS_CODE_PRECONDITION_REQUIRED = 428, 
  AZ_HTTP_STATUS_CODE_TOO_MANY_REQUESTS = 429, 
  AZ_HTTP_STATUS_CODE_REQUEST_HEADER_FIELDS_TOO_LARGE
  = 431, 
  AZ_HTTP_STATUS_CODE_UNAVAILABLE_FOR_LEGAL_REASONS
  = 451, 
 
  // === 5xx (server error) Status Codes: ===
  AZ_HTTP_STATUS_CODE_INTERNAL_SERVER_ERROR = 500, 
  AZ_HTTP_STATUS_CODE_NOT_IMPLEMENTED = 501, 
  AZ_HTTP_STATUS_CODE_BAD_GATEWAY = 502, 
  AZ_HTTP_STATUS_CODE_SERVICE_UNAVAILABLE = 503, 
  AZ_HTTP_STATUS_CODE_GATEWAY_TIMEOUT = 504, 
  AZ_HTTP_STATUS_CODE_HTTP_VERSION_NOT_SUPPORTED = 505, 
  AZ_HTTP_STATUS_CODE_VARIANT_ALSO_NEGOTIATES = 506, 
  AZ_HTTP_STATUS_CODE_INSUFFICIENT_STORAGE = 507, 
  AZ_HTTP_STATUS_CODE_LOOP_DETECTED = 508, 
  AZ_HTTP_STATUS_CODE_NOT_EXTENDED = 510, 
  AZ_HTTP_STATUS_CODE_NETWORK_AUTHENTICATION_REQUIRED
  = 511, 
} az_http_status_code;
 
typedef struct
{
  int32_t retry_delay_msec;
 
  int32_t max_retry_delay_msec;
 
  int32_t max_retries;
} az_http_policy_retry_options;
 
typedef enum
{
  _az_HTTP_RESPONSE_KIND_STATUS_LINE = 0,
  _az_HTTP_RESPONSE_KIND_HEADER = 1,
  _az_HTTP_RESPONSE_KIND_BODY = 2,
  _az_HTTP_RESPONSE_KIND_EOF = 3,
} _az_http_response_kind;
 
typedef struct
{
  struct
  {
    az_span http_response;
    int32_t written;
    struct
    {
      az_span remaining; // the remaining un-parsed portion of the original http_response.
      _az_http_response_kind next_kind;
      // After parsing an element, next_kind refers to the next expected element
    } parser;
  } _internal;
} az_http_response;
 
AZ_NODISCARD AZ_INLINE az_result
az_http_response_init(az_http_response* out_response, az_span buffer)
{
  *out_response = (az_http_response){
    ._internal = {
      .http_response = buffer,
      .written = 0,
      .parser = {
        .remaining = AZ_SPAN_EMPTY,
        .next_kind = _az_HTTP_RESPONSE_KIND_STATUS_LINE,
      },
    },
  };
 
  return AZ_OK;
}
 
// Member order is optimized for alignment.
typedef struct
{
  az_span reason_phrase; 
  az_http_status_code status_code; 
  uint8_t major_version; 
  uint8_t minor_version; 
} az_http_response_status_line;
 
AZ_NODISCARD az_result az_http_response_get_status_line(
    az_http_response* ref_response,
    az_http_response_status_line* out_status_line);
 
AZ_INLINE AZ_NODISCARD az_http_status_code
az_http_response_get_status_code(az_http_response* ref_response)
{
  az_http_response_status_line status_line = { 0 };
  return az_result_failed(az_http_response_get_status_line(ref_response, &status_line))
      ? AZ_HTTP_STATUS_CODE_NONE
      : status_line.status_code;
}
 
AZ_NODISCARD az_result az_http_response_get_next_header(
    az_http_response* ref_response,
    az_span* out_name,
    az_span* out_value);
 
AZ_NODISCARD az_result az_http_response_get_body(az_http_response* ref_response, az_span* out_body);
 
#include <azure/core/_az_cfg_suffix.h>
 
#endif // _az_HTTP_H