edjx-cpp-sdk/fetch_8hpp_source.html

#pragma once


#include <cstdint>

#include <vector>

#include <map>

#include <string>


#include "http.hpp"

#include "stream.hpp"

#include "error.hpp"


namespace edjx {


namespace fetch {


    struct FetchResponse {

        edjx::http::HttpStatusCode status;

        edjx::http::HttpHeaders headers;

        edjx::stream::ReadStream read_stream;


        edjx::http::HttpStatusCode get_status_code() const;


        const edjx::http::HttpHeaders & get_headers() const;


        edjx::error::StreamError read_body(std::vector<uint8_t> & result);


        edjx::stream::ReadStream & get_read_stream();

    };


    struct FetchResponsePending {

        uint32_t sd;


        FetchResponsePending() {}

        FetchResponsePending(uint32_t sd) : sd(sd) {}


        edjx::error::HttpError get_fetch_response(FetchResponse & result);

    };


    struct HttpFetch {

        http::HttpVersion version;

        edjx::http::HttpHeaders headers;

        http::Uri uri;

        http::HttpMethod method;

        std::vector<uint8_t> body;


        inline HttpFetch(http::Uri uri, http::HttpMethod method) :

            version(http::HttpVersion::HTTP_11),

            uri(uri),

            method(method) {}


        HttpFetch & set_version(http::HttpVersion version);


        http::HttpVersion get_version() const;


        HttpFetch & set_header(

            const std::string & header_name,

            const std::string & value

        );


        HttpFetch & set_header(

            const std::string & header_name,

            const std::vector<std::string> & value

        );


        HttpFetch & append_header(

            const std::string & header_name,

            const std::string & value

        );


        HttpFetch & set_headers(

            const edjx::http::HttpHeaders & value

        );


        const edjx::http::HttpHeaders & get_headers() const;


        HttpFetch & set_body(const std::string & text);


        HttpFetch & set_body(const std::vector<std::uint8_t> bytes);


        const std::vector<uint8_t> & get_body() const;


        edjx::error::HttpError send(FetchResponse & response);


        edjx::error::HttpError send_streaming(FetchResponsePending & response, edjx::stream::WriteStream & write_stream);

    };


}}

edjx::http::Uri
Class that represents a URL.
Definition: http.hpp:67

edjx::stream::ReadStream
Read stream class.
Definition: stream.hpp:120

edjx::stream::WriteStream
This class represents a write stream.
Definition: stream.hpp:68

error.hpp

http.hpp

edjx::error::StreamError
StreamError
Enum that describes values returned by streaming functions.
Definition: error.hpp:243

edjx::error::HttpError
HttpError
Enum describing return values of functions that correspond to HTTP modules.
Definition: error.hpp:14

edjx::http::HttpVersion
HttpVersion
Enum containing an HTTP version.
Definition: http.hpp:18

edjx::http::HttpStatusCode
uint16_t HttpStatusCode
HTTP status code (e.g., value 200 means OK, value 404 means Not Found)
Definition: http.hpp:60

edjx::http::HttpHeaders
std::map< std::string, std::vector< std::string >, CaseInsensitiveKeys > HttpHeaders
A map of HttpHeaders where keys are case-insensitive header names.
Definition: http.hpp:54

edjx::http::HttpMethod
HttpMethod
Enum containing a number of common HTTP methods.
Definition: http.hpp:29

edjx
Definition: error.hpp:5

stream.hpp

edjx::fetch::FetchResponsePending
A pending Fetch response.
Definition: fetch.hpp:73

edjx::fetch::FetchResponsePending::FetchResponsePending
FetchResponsePending(uint32_t sd)
Definition: fetch.hpp:78

edjx::fetch::FetchResponsePending::get_fetch_response
edjx::error::HttpError get_fetch_response(FetchResponse &result)
Get the server's response.

edjx::fetch::FetchResponsePending::sd
uint32_t sd
Stream descriptor.
Definition: fetch.hpp:75

edjx::fetch::FetchResponsePending::FetchResponsePending
FetchResponsePending()
Definition: fetch.hpp:77

edjx::fetch::FetchResponse
Response for HTTP fetch request, which may include body, headers, and status code.
Definition: fetch.hpp:21

edjx::fetch::FetchResponse::get_headers
const edjx::http::HttpHeaders & get_headers() const
Returns HTTP headers of the fetch response.

edjx::fetch::FetchResponse::status
edjx::http::HttpStatusCode status
HTTP status code of the response.
Definition: fetch.hpp:23

edjx::fetch::FetchResponse::read_stream
edjx::stream::ReadStream read_stream
Body of the response as a stream.
Definition: fetch.hpp:27

edjx::fetch::FetchResponse::headers
edjx::http::HttpHeaders headers
HTTP headers of the response.
Definition: fetch.hpp:25

edjx::fetch::FetchResponse::get_status_code
edjx::http::HttpStatusCode get_status_code() const
Returns the HTTP status code of the fetch response.

edjx::fetch::FetchResponse::read_body
edjx::error::StreamError read_body(std::vector< uint8_t > &result)
Reads and returns the HTTP body of the fetch response.

edjx::fetch::FetchResponse::get_read_stream
edjx::stream::ReadStream & get_read_stream()
Returns the HTTP body of the fetch response as a read stream.

edjx::fetch::HttpFetch
An HTTP fetch request includes body, headers, version, method, and URI.
Definition: fetch.hpp:94

edjx::fetch::HttpFetch::send
edjx::error::HttpError send(FetchResponse &response)
Sends the request to the server, and returns after the response is received or an error occurs.

edjx::fetch::HttpFetch::set_headers
HttpFetch & set_headers(const edjx::http::HttpHeaders &value)
Set request headers to the given values.

edjx::fetch::HttpFetch::set_header
HttpFetch & set_header(const std::string &header_name, const std::vector< std::string > &value)
Sets a request header to the given values.

edjx::fetch::HttpFetch::get_headers
const edjx::http::HttpHeaders & get_headers() const
Returns a const reference to the request header map.

edjx::fetch::HttpFetch::set_body
HttpFetch & set_body(const std::string &text)
Sets the given [text] value as the body of the request.

edjx::fetch::HttpFetch::set_body
HttpFetch & set_body(const std::vector< std::uint8_t > bytes)
Sets the given [bytes] value as the body of the request.

edjx::fetch::HttpFetch::get_version
http::HttpVersion get_version() const
Gets the HTTP version of the request.

edjx::fetch::HttpFetch::HttpFetch
HttpFetch(http::Uri uri, http::HttpMethod method)
Creates a request with the given method and URI, version as HTTP/1.1, no headers, and no body.
Definition: fetch.hpp:113

edjx::fetch::HttpFetch::set_version
HttpFetch & set_version(http::HttpVersion version)
Sets the HTTP version of the request.

edjx::fetch::HttpFetch::method
http::HttpMethod method
Method for the request.
Definition: fetch.hpp:102

edjx::fetch::HttpFetch::version
http::HttpVersion version
HTTP version of the request.
Definition: fetch.hpp:96

edjx::fetch::HttpFetch::get_body
const std::vector< uint8_t > & get_body() const
Returns a constant reference to the body.

edjx::fetch::HttpFetch::headers
edjx::http::HttpHeaders headers
Headers for the request.
Definition: fetch.hpp:98

edjx::fetch::HttpFetch::uri
http::Uri uri
URI of the request.
Definition: fetch.hpp:100

edjx::fetch::HttpFetch::append_header
HttpFetch & append_header(const std::string &header_name, const std::string &value)
Appends a value to the existing request header.

edjx::fetch::HttpFetch::body
std::vector< uint8_t > body
Request body.
Definition: fetch.hpp:104

edjx::fetch::HttpFetch::set_header
HttpFetch & set_header(const std::string &header_name, const std::string &value)
Sets a request header to the given value.

edjx::fetch::HttpFetch::send_streaming
edjx::error::HttpError send_streaming(FetchResponsePending &response, edjx::stream::WriteStream &write_stream)
Starts streaming an HTTP Fetch request to the server. This method returns a FetchResponsePending obje...