iconnection.hpp

Go to the documentation of this file.

 
#ifndef ACONNECTION_HPP
#define ACONNECTION_HPP
 
#include <atomic>
#include <expected>
#include <functional>
#include <memory>
#include <string>
#include <vector>
 
#include "http_error.hpp"
 
namespace cpp_restapi
{
    // Forward declarations – include the corresponding header when
    // you need the full definition (e.g. to access SseEvent members).
    struct SseEvent;
    struct ISseConnection;
    struct IPaginationStrategy;
 
    struct Response
    {
        std::string body;
        std::string headers;
        int         statusCode = 0;  
    };
 
    using CancellationToken = std::shared_ptr<std::atomic<bool>>;
 
    struct IConnection
    {
        public:
            using EventCallback   = std::function<void(const SseEvent&)>;
            using FetchCallback   = std::function<void(Response)>;
            using BodyCallback    = std::function<void(std::string)>;
            using ErrorCallback   = std::function<void(HttpError)>;
 
            virtual ~IConnection() = default;
 
            // -- connection info --
 
            virtual const std::string& url() const = 0;
 
            // -- synchronous fetch --
 
            virtual std::expected<std::string, HttpError> fetch(const std::string& request) = 0;
 
            virtual std::expected<std::string, HttpError> fetch(const std::string& request, IPaginationStrategy& strategy) = 0;
 
            virtual std::expected<Response, HttpError> fetchResponse(const std::string& url) = 0;
 
            // -- asynchronous fetch --
 
            virtual CancellationToken fetch(const std::string& request,
                               FetchCallback onSuccess,
                               ErrorCallback onError = {}) = 0;
 
            virtual CancellationToken fetch(const std::string& request,
                               IPaginationStrategy& strategy,
                               BodyCallback onSuccess,
                               ErrorCallback onError = {}) = 0;
 
            // -- Server-Sent Events --
 
            virtual std::unique_ptr<ISseConnection> subscribe(const std::string& request, EventCallback callback) = 0;
 
            // -- deprecated --
 
            [[deprecated("Use fetch() or fetch() with IPaginationStrategy instead")]]
            virtual std::string get(const std::string& request) = 0;
    };
}
 
#endif