Skip to content

API Reference Overview

The siddiqsoft::restcl namespace provides the following primary classes, functions, and models:


Primary Entry Point

Entity Description Reference
GetRESTClient() Factory function producing a platform-specific REST client instance GetRESTClient

Client Classes

Class Description Platform Reference
WinHttpRESTClient Windows REST client using WinHTTP Windows WinHttpRESTClient
HttpRESTClient Unix/Linux/macOS REST client using libcurl Linux / macOS HttpRESTClient
basic_restclient<CharT> Abstract base class defining sync & async interface All basic_restclient

Request & Response Models

Entity Description Reference
rest_request<CharT> HTTP request container (method, URI, headers, content) rest_request
rest_response<CharT> HTTP response container (status code, headers, content) rest_response
basic_callbacktype Async callback function type signature basic_callbacktype

Literals & Helpers

Namespace / Literal Description Reference
siddiqsoft::restcl_literals User-defined literals (_GET, _POST, etc.) restcl_literals