HTTP Helper

Public header: #include "brookesia/service_helper/network/http.hpp"

Overview

This page documents the HTTP helper Doxygen API: request models, async request helpers, state events, and related macros.

API Reference

Header File

service/framework/brookesia_service_helper/include/brookesia/service_helper/network/http.hpp

Classes

class Http : public esp_brookesia::service::helper::Base<Http>

Helper schema definitions for the HTTP service.

Public Types

enum class RequestState

Lifecycle state of an individual HTTP request.

Values:

enumerator Queued

enumerator Running

enumerator Completed

enumerator Failed

enumerator Canceled

enumerator Max

enum class GeneralState

General lifecycle state of the HTTP service.

Values:

enumerator Idle

enumerator Initing

enumerator Inited

enumerator TimeSyncing

enumerator Starting

enumerator Started

enumerator Stopping

enumerator Stopped

enumerator Deiniting

enumerator Max

struct RequestProgress: Progress payload for a running HTTP request.

struct RequestStateInfo: Snapshot of the current state and progress of an HTTP request.

struct Statistics: HTTP service request counters.