| 1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071727374757677787980818283848586878889909192939495969798991001011021031041051061071081091101111121131141151161171181191201211221231241251261271281291301311321331341351361371381391401411421431441451461471481491501511521531541551561571581591601611621631641651661671681691701711721731741751761771781791801811821831841851861871881891901911921931941951961971981992002012022032042052062072082092102112122132142152162172182192202212222232242252262272282292302312322332342352362372382392402412422432442452462472482492502512522532542552562572582592602612622632642652662672682692702712722732742752762772782792802812822832842852862872882892902912922932942952962972982993003013023033043053063073083093103113123133143153163173183193203213223233243253263273283293303313323333343353363373383393403413423433443453463473483493503513523533543553563573583593603613623633643653663673683693703713723733743753763773783793803813823833843853863873883893903913923933943953963973983994004014024034044054064074084094104114124134144154164174184194204214224234244254264274284294304314324334344354364374384394404414424434444454464474484494504514524534544554564574584594604614624634644654664674684694704714724734744754764774784794804814824834844854864874884894904914924934944954964974984995005015025035045055065075085095105115125135145155165175185195205215225235245255265275285295305315325335345355365375385395405415425435445455465475485495505515525535545555565575585595605615625635645655665675685695705715725735745755765775785795805815825835845855865875885895905915925935945955965975985996006016026036046056066076086096106116126136146156166176186196206216226236246256266276286296306316326336346356366376386396406416426436446456466476486496506516526536546556566576586596606616626636646656666676686696706716726736746756766776786796806816826836846856866876886896906916926936946956966976986997007017027037047057067077087097107117127137147157167177187197207217227237247257267277287297307317327337347357367377387397407417427437447457467477487497507517527537547557567577587597607617627637647657667677687697707717727737747757767777787797807817827837847857867877887897907917927937947957967977987998008018028038048058068078088098108118128138148158168178188198208218228238248258268278288298308318328338348358368378388398408418428438448458468478488498508518528538548558568578588598608618628638648658668678688698708718728738748758768778788798808818828838848858868878888898908918928938948958968978988999009019029039049059069079089099109119129139149159169179189199209219229239249259269279289299309319329339349359369379389399409419429439449459469479489499509519529539549559569579589599609619629639649659669679689699709719729739749759769779789799809819829839849859869879889899909919929939949959969979989991000100110021003100410051006100710081009101010111012101310141015101610171018101910201021102210231024102510261027102810291030103110321033103410351036103710381039104010411042104310441045104610471048104910501051105210531054105510561057105810591060106110621063106410651066106710681069107010711072107310741075107610771078107910801081108210831084108510861087108810891090109110921093109410951096109710981099110011011102110311041105110611071108110911101111111211131114111511161117111811191120112111221123112411251126112711281129113011311132113311341135113611371138113911401141114211431144114511461147114811491150115111521153115411551156115711581159116011611162116311641165116611671168116911701171117211731174117511761177117811791180118111821183118411851186118711881189119011911192119311941195119611971198119912001201120212031204120512061207120812091210121112121213121412151216121712181219122012211222122312241225122612271228122912301231123212331234123512361237123812391240124112421243124412451246124712481249125012511252125312541255125612571258125912601261126212631264126512661267126812691270127112721273127412751276127712781279128012811282128312841285128612871288128912901291129212931294129512961297129812991300130113021303130413051306130713081309131013111312131313141315131613171318131913201321132213231324132513261327132813291330133113321333133413351336133713381339134013411342134313441345134613471348134913501351135213531354135513561357135813591360136113621363136413651366136713681369137013711372137313741375137613771378137913801381138213831384138513861387138813891390139113921393139413951396139713981399140014011402140314041405140614071408140914101411141214131414141514161417141814191420142114221423142414251426142714281429143014311432143314341435143614371438143914401441144214431444144514461447144814491450145114521453145414551456145714581459146014611462146314641465146614671468146914701471147214731474147514761477147814791480148114821483148414851486148714881489149014911492149314941495149614971498149915001501150215031504150515061507150815091510151115121513151415151516151715181519152015211522152315241525152615271528152915301531153215331534153515361537153815391540154115421543154415451546154715481549155015511552155315541555155615571558155915601561156215631564156515661567156815691570157115721573157415751576157715781579158015811582158315841585158615871588158915901591159215931594159515961597159815991600160116021603160416051606160716081609161016111612161316141615161616171618161916201621162216231624162516261627162816291630163116321633163416351636163716381639164016411642164316441645164616471648164916501651165216531654165516561657165816591660166116621663166416651666166716681669167016711672167316741675167616771678167916801681168216831684168516861687168816891690169116921693169416951696169716981699170017011702170317041705170617071708170917101711171217131714171517161717171817191720172117221723172417251726172717281729173017311732173317341735173617371738173917401741174217431744174517461747174817491750175117521753175417551756175717581759176017611762176317641765176617671768176917701771177217731774177517761777177817791780178117821783178417851786178717881789179017911792179317941795179617971798179918001801180218031804180518061807180818091810181118121813181418151816181718181819182018211822182318241825182618271828182918301831183218331834183518361837183818391840184118421843184418451846184718481849185018511852185318541855185618571858185918601861186218631864186518661867186818691870187118721873187418751876187718781879188018811882188318841885188618871888188918901891189218931894189518961897189818991900190119021903190419051906190719081909191019111912191319141915191619171918191919201921192219231924192519261927192819291930193119321933193419351936193719381939194019411942194319441945194619471948194919501951195219531954195519561957195819591960196119621963196419651966196719681969197019711972197319741975197619771978197919801981198219831984198519861987198819891990199119921993199419951996199719981999200020012002200320042005200620072008200920102011201220132014201520162017201820192020202120222023202420252026202720282029203020312032203320342035203620372038203920402041204220432044204520462047204820492050205120522053205420552056205720582059206020612062206320642065206620672068206920702071207220732074207520762077207820792080208120822083208420852086208720882089209020912092209320942095209620972098209921002101210221032104210521062107210821092110211121122113211421152116211721182119212021212122212321242125212621272128212921302131213221332134213521362137213821392140214121422143214421452146214721482149215021512152215321542155215621572158215921602161216221632164216521662167216821692170217121722173217421752176217721782179218021812182218321842185218621872188218921902191219221932194219521962197219821992200220122022203220422052206220722082209221022112212221322142215221622172218221922202221222222232224222522262227222822292230223122322233223422352236223722382239224022412242224322442245224622472248224922502251225222532254225522562257225822592260226122622263226422652266226722682269227022712272227322742275227622772278227922802281228222832284228522862287228822892290229122922293229422952296229722982299230023012302230323042305230623072308230923102311231223132314231523162317231823192320232123222323232423252326232723282329233023312332233323342335233623372338233923402341234223432344234523462347234823492350235123522353235423552356235723582359236023612362236323642365236623672368236923702371237223732374237523762377237823792380238123822383238423852386238723882389239023912392239323942395239623972398239924002401240224032404240524062407240824092410241124122413241424152416241724182419242024212422242324242425242624272428242924302431243224332434243524362437243824392440244124422443244424452446244724482449245024512452245324542455245624572458245924602461246224632464246524662467246824692470247124722473247424752476247724782479248024812482248324842485248624872488248924902491249224932494249524962497249824992500250125022503250425052506250725082509251025112512251325142515251625172518251925202521252225232524252525262527252825292530253125322533253425352536253725382539254025412542254325442545254625472548254925502551255225532554255525562557255825592560256125622563256425652566256725682569257025712572257325742575257625772578257925802581258225832584258525862587258825892590259125922593259425952596259725982599260026012602260326042605260626072608260926102611261226132614261526162617261826192620262126222623262426252626262726282629263026312632263326342635263626372638263926402641264226432644264526462647264826492650265126522653265426552656265726582659266026612662266326642665266626672668266926702671267226732674267526762677267826792680268126822683268426852686268726882689269026912692269326942695269626972698269927002701270227032704270527062707270827092710271127122713271427152716271727182719272027212722272327242725272627272728272927302731273227332734273527362737273827392740274127422743274427452746274727482749275027512752275327542755275627572758275927602761276227632764276527662767276827692770277127722773277427752776277727782779278027812782278327842785278627872788278927902791279227932794279527962797279827992800280128022803280428052806280728082809281028112812281328142815281628172818281928202821282228232824282528262827282828292830283128322833283428352836283728382839284028412842284328442845284628472848284928502851285228532854285528562857285828592860286128622863286428652866286728682869287028712872287328742875287628772878287928802881288228832884288528862887288828892890289128922893289428952896289728982899290029012902290329042905290629072908290929102911291229132914291529162917291829192920292129222923292429252926292729282929293029312932293329342935293629372938293929402941294229432944294529462947294829492950295129522953295429552956295729582959296029612962296329642965296629672968296929702971297229732974297529762977297829792980298129822983298429852986298729882989299029912992299329942995299629972998299930003001300230033004300530063007300830093010301130123013301430153016301730183019302030213022302330243025302630273028302930303031303230333034303530363037303830393040304130423043304430453046304730483049305030513052305330543055305630573058305930603061306230633064306530663067306830693070307130723073307430753076307730783079308030813082308330843085308630873088308930903091309230933094309530963097309830993100310131023103310431053106310731083109311031113112311331143115311631173118311931203121312231233124312531263127312831293130313131323133313431353136313731383139314031413142314331443145314631473148314931503151315231533154315531563157315831593160316131623163316431653166316731683169317031713172317331743175317631773178317931803181318231833184318531863187318831893190319131923193319431953196319731983199320032013202320332043205320632073208320932103211321232133214321532163217321832193220322132223223322432253226322732283229323032313232323332343235323632373238323932403241324232433244324532463247324832493250325132523253325432553256325732583259326032613262326332643265326632673268326932703271327232733274327532763277327832793280328132823283328432853286328732883289329032913292329332943295329632973298329933003301330233033304330533063307330833093310331133123313331433153316331733183319332033213322332333243325332633273328332933303331333233333334333533363337333833393340334133423343334433453346334733483349335033513352335333543355335633573358335933603361336233633364336533663367336833693370337133723373337433753376337733783379338033813382338333843385338633873388338933903391339233933394339533963397339833993400340134023403340434053406340734083409341034113412 |
- //
- // httplib.h
- //
- // Copyright (c) 2026 Yuji Hirose. All rights reserved.
- // MIT License
- //
- #ifndef CPPHTTPLIB_HTTPLIB_H
- #define CPPHTTPLIB_HTTPLIB_H
- #define CPPHTTPLIB_VERSION "0.30.0"
- #define CPPHTTPLIB_VERSION_NUM "0x001E00"
- /*
- * Platform compatibility check
- */
- #if defined(_WIN32) && !defined(_WIN64)
- #if defined(_MSC_VER)
- #pragma message( \
- "cpp-httplib doesn't support 32-bit Windows. Please use a 64-bit compiler.")
- #else
- #warning \
- "cpp-httplib doesn't support 32-bit Windows. Please use a 64-bit compiler."
- #endif
- #elif defined(__SIZEOF_POINTER__) && __SIZEOF_POINTER__ < 8
- #warning \
- "cpp-httplib doesn't support 32-bit platforms. Please use a 64-bit compiler."
- #elif defined(__SIZEOF_SIZE_T__) && __SIZEOF_SIZE_T__ < 8
- #warning \
- "cpp-httplib doesn't support platforms where size_t is less than 64 bits."
- #endif
- #ifdef _WIN32
- #if defined(_WIN32_WINNT) && _WIN32_WINNT < 0x0A00
- #error \
- "cpp-httplib doesn't support Windows 8 or lower. Please use Windows 10 or later."
- #endif
- #endif
- /*
- * Configuration
- */
- #ifndef CPPHTTPLIB_KEEPALIVE_TIMEOUT_SECOND
- #define CPPHTTPLIB_KEEPALIVE_TIMEOUT_SECOND 5
- #endif
- #ifndef CPPHTTPLIB_KEEPALIVE_TIMEOUT_CHECK_INTERVAL_USECOND
- #define CPPHTTPLIB_KEEPALIVE_TIMEOUT_CHECK_INTERVAL_USECOND 10000
- #endif
- #ifndef CPPHTTPLIB_KEEPALIVE_MAX_COUNT
- #define CPPHTTPLIB_KEEPALIVE_MAX_COUNT 100
- #endif
- #ifndef CPPHTTPLIB_CONNECTION_TIMEOUT_SECOND
- #define CPPHTTPLIB_CONNECTION_TIMEOUT_SECOND 300
- #endif
- #ifndef CPPHTTPLIB_CONNECTION_TIMEOUT_USECOND
- #define CPPHTTPLIB_CONNECTION_TIMEOUT_USECOND 0
- #endif
- #ifndef CPPHTTPLIB_SERVER_READ_TIMEOUT_SECOND
- #define CPPHTTPLIB_SERVER_READ_TIMEOUT_SECOND 5
- #endif
- #ifndef CPPHTTPLIB_SERVER_READ_TIMEOUT_USECOND
- #define CPPHTTPLIB_SERVER_READ_TIMEOUT_USECOND 0
- #endif
- #ifndef CPPHTTPLIB_SERVER_WRITE_TIMEOUT_SECOND
- #define CPPHTTPLIB_SERVER_WRITE_TIMEOUT_SECOND 5
- #endif
- #ifndef CPPHTTPLIB_SERVER_WRITE_TIMEOUT_USECOND
- #define CPPHTTPLIB_SERVER_WRITE_TIMEOUT_USECOND 0
- #endif
- #ifndef CPPHTTPLIB_CLIENT_READ_TIMEOUT_SECOND
- #define CPPHTTPLIB_CLIENT_READ_TIMEOUT_SECOND 300
- #endif
- #ifndef CPPHTTPLIB_CLIENT_READ_TIMEOUT_USECOND
- #define CPPHTTPLIB_CLIENT_READ_TIMEOUT_USECOND 0
- #endif
- #ifndef CPPHTTPLIB_CLIENT_WRITE_TIMEOUT_SECOND
- #define CPPHTTPLIB_CLIENT_WRITE_TIMEOUT_SECOND 5
- #endif
- #ifndef CPPHTTPLIB_CLIENT_WRITE_TIMEOUT_USECOND
- #define CPPHTTPLIB_CLIENT_WRITE_TIMEOUT_USECOND 0
- #endif
- #ifndef CPPHTTPLIB_CLIENT_MAX_TIMEOUT_MSECOND
- #define CPPHTTPLIB_CLIENT_MAX_TIMEOUT_MSECOND 0
- #endif
- #ifndef CPPHTTPLIB_IDLE_INTERVAL_SECOND
- #define CPPHTTPLIB_IDLE_INTERVAL_SECOND 0
- #endif
- #ifndef CPPHTTPLIB_IDLE_INTERVAL_USECOND
- #ifdef _WIN32
- #define CPPHTTPLIB_IDLE_INTERVAL_USECOND 1000
- #else
- #define CPPHTTPLIB_IDLE_INTERVAL_USECOND 0
- #endif
- #endif
- #ifndef CPPHTTPLIB_REQUEST_URI_MAX_LENGTH
- #define CPPHTTPLIB_REQUEST_URI_MAX_LENGTH 8192
- #endif
- #ifndef CPPHTTPLIB_HEADER_MAX_LENGTH
- #define CPPHTTPLIB_HEADER_MAX_LENGTH 8192
- #endif
- #ifndef CPPHTTPLIB_HEADER_MAX_COUNT
- #define CPPHTTPLIB_HEADER_MAX_COUNT 100
- #endif
- #ifndef CPPHTTPLIB_REDIRECT_MAX_COUNT
- #define CPPHTTPLIB_REDIRECT_MAX_COUNT 20
- #endif
- #ifndef CPPHTTPLIB_MULTIPART_FORM_DATA_FILE_MAX_COUNT
- #define CPPHTTPLIB_MULTIPART_FORM_DATA_FILE_MAX_COUNT 1024
- #endif
- #ifndef CPPHTTPLIB_PAYLOAD_MAX_LENGTH
- #define CPPHTTPLIB_PAYLOAD_MAX_LENGTH ((std::numeric_limits<size_t>::max)())
- #endif
- #ifndef CPPHTTPLIB_FORM_URL_ENCODED_PAYLOAD_MAX_LENGTH
- #define CPPHTTPLIB_FORM_URL_ENCODED_PAYLOAD_MAX_LENGTH 8192
- #endif
- #ifndef CPPHTTPLIB_RANGE_MAX_COUNT
- #define CPPHTTPLIB_RANGE_MAX_COUNT 1024
- #endif
- #ifndef CPPHTTPLIB_TCP_NODELAY
- #define CPPHTTPLIB_TCP_NODELAY false
- #endif
- #ifndef CPPHTTPLIB_IPV6_V6ONLY
- #define CPPHTTPLIB_IPV6_V6ONLY false
- #endif
- #ifndef CPPHTTPLIB_RECV_BUFSIZ
- #define CPPHTTPLIB_RECV_BUFSIZ size_t(16384u)
- #endif
- #ifndef CPPHTTPLIB_SEND_BUFSIZ
- #define CPPHTTPLIB_SEND_BUFSIZ size_t(16384u)
- #endif
- #ifndef CPPHTTPLIB_COMPRESSION_BUFSIZ
- #define CPPHTTPLIB_COMPRESSION_BUFSIZ size_t(16384u)
- #endif
- #ifndef CPPHTTPLIB_THREAD_POOL_COUNT
- #define CPPHTTPLIB_THREAD_POOL_COUNT \
- ((std::max)(8u, std::thread::hardware_concurrency() > 0 \
- ? std::thread::hardware_concurrency() - 1 \
- : 0))
- #endif
- #ifndef CPPHTTPLIB_RECV_FLAGS
- #define CPPHTTPLIB_RECV_FLAGS 0
- #endif
- #ifndef CPPHTTPLIB_SEND_FLAGS
- #define CPPHTTPLIB_SEND_FLAGS 0
- #endif
- #ifndef CPPHTTPLIB_LISTEN_BACKLOG
- #define CPPHTTPLIB_LISTEN_BACKLOG 5
- #endif
- #ifndef CPPHTTPLIB_MAX_LINE_LENGTH
- #define CPPHTTPLIB_MAX_LINE_LENGTH 32768
- #endif
- /*
- * Headers
- */
- #ifdef _WIN32
- #ifndef _CRT_SECURE_NO_WARNINGS
- #define _CRT_SECURE_NO_WARNINGS
- #endif //_CRT_SECURE_NO_WARNINGS
- #ifndef _CRT_NONSTDC_NO_DEPRECATE
- #define _CRT_NONSTDC_NO_DEPRECATE
- #endif //_CRT_NONSTDC_NO_DEPRECATE
- #if defined(_MSC_VER)
- #if _MSC_VER < 1900
- #error Sorry, Visual Studio versions prior to 2015 are not supported
- #endif
- #pragma comment(lib, "ws2_32.lib")
- using ssize_t = __int64;
- #endif // _MSC_VER
- #ifndef S_ISREG
- #define S_ISREG(m) (((m) & S_IFREG) == S_IFREG)
- #endif // S_ISREG
- #ifndef S_ISDIR
- #define S_ISDIR(m) (((m) & S_IFDIR) == S_IFDIR)
- #endif // S_ISDIR
- #ifndef NOMINMAX
- #define NOMINMAX
- #endif // NOMINMAX
- #include <io.h>
- #include <winsock2.h>
- #include <ws2tcpip.h>
- #if defined(__has_include)
- #if __has_include(<afunix.h>)
- // afunix.h uses types declared in winsock2.h, so has to be included after it.
- #include <afunix.h>
- #define CPPHTTPLIB_HAVE_AFUNIX_H 1
- #endif
- #endif
- #ifndef WSA_FLAG_NO_HANDLE_INHERIT
- #define WSA_FLAG_NO_HANDLE_INHERIT 0x80
- #endif
- using nfds_t = unsigned long;
- using socket_t = SOCKET;
- using socklen_t = int;
- #else // not _WIN32
- #include <arpa/inet.h>
- #if !defined(_AIX) && !defined(__MVS__)
- #include <ifaddrs.h>
- #endif
- #ifdef __MVS__
- #include <strings.h>
- #ifndef NI_MAXHOST
- #define NI_MAXHOST 1025
- #endif
- #endif
- #include <net/if.h>
- #include <netdb.h>
- #include <netinet/in.h>
- #ifdef __linux__
- #include <resolv.h>
- #undef _res // Undefine _res macro to avoid conflicts with user code (#2278)
- #endif
- #include <csignal>
- #include <netinet/tcp.h>
- #include <poll.h>
- #include <pthread.h>
- #include <sys/mman.h>
- #include <sys/socket.h>
- #include <sys/un.h>
- #include <unistd.h>
- using socket_t = int;
- #ifndef INVALID_SOCKET
- #define INVALID_SOCKET (-1)
- #endif
- #endif //_WIN32
- #if defined(__APPLE__)
- #include <TargetConditionals.h>
- #endif
- #include <algorithm>
- #include <array>
- #include <atomic>
- #include <cassert>
- #include <cctype>
- #include <climits>
- #include <condition_variable>
- #include <cstring>
- #include <errno.h>
- #include <exception>
- #include <fcntl.h>
- #include <functional>
- #include <iomanip>
- #include <iostream>
- #include <list>
- #include <map>
- #include <memory>
- #include <mutex>
- #include <random>
- #include <regex>
- #include <set>
- #include <sstream>
- #include <string>
- #include <sys/stat.h>
- #include <thread>
- #include <unordered_map>
- #include <unordered_set>
- #include <utility>
- #if defined(CPPHTTPLIB_USE_NON_BLOCKING_GETADDRINFO) || \
- defined(CPPHTTPLIB_USE_CERTS_FROM_MACOSX_KEYCHAIN)
- #if TARGET_OS_MAC
- #include <CFNetwork/CFHost.h>
- #include <CoreFoundation/CoreFoundation.h>
- #endif
- #endif // CPPHTTPLIB_USE_NON_BLOCKING_GETADDRINFO or
- // CPPHTTPLIB_USE_CERTS_FROM_MACOSX_KEYCHAIN
- #ifdef CPPHTTPLIB_OPENSSL_SUPPORT
- #ifdef _WIN32
- #include <wincrypt.h>
- // these are defined in wincrypt.h and it breaks compilation if BoringSSL is
- // used
- #undef X509_NAME
- #undef X509_CERT_PAIR
- #undef X509_EXTENSIONS
- #undef PKCS7_SIGNER_INFO
- #ifdef _MSC_VER
- #pragma comment(lib, "crypt32.lib")
- #endif
- #endif // _WIN32
- #if defined(CPPHTTPLIB_USE_CERTS_FROM_MACOSX_KEYCHAIN)
- #if TARGET_OS_MAC
- #include <Security/Security.h>
- #endif
- #endif // CPPHTTPLIB_USE_NON_BLOCKING_GETADDRINFO
- #include <openssl/err.h>
- #include <openssl/evp.h>
- #include <openssl/ssl.h>
- #include <openssl/x509v3.h>
- #if defined(_WIN32) && defined(OPENSSL_USE_APPLINK)
- #include <openssl/applink.c>
- #endif
- #include <iostream>
- #include <sstream>
- #if defined(OPENSSL_IS_BORINGSSL) || defined(LIBRESSL_VERSION_NUMBER)
- #if OPENSSL_VERSION_NUMBER < 0x1010107f
- #error Please use OpenSSL or a current version of BoringSSL
- #endif
- #define SSL_get1_peer_certificate SSL_get_peer_certificate
- #elif OPENSSL_VERSION_NUMBER < 0x30000000L
- #error Sorry, OpenSSL versions prior to 3.0.0 are not supported
- #endif
- #endif // CPPHTTPLIB_OPENSSL_SUPPORT
- #ifdef CPPHTTPLIB_ZLIB_SUPPORT
- #include <zlib.h>
- #endif
- #ifdef CPPHTTPLIB_BROTLI_SUPPORT
- #include <brotli/decode.h>
- #include <brotli/encode.h>
- #endif
- #ifdef CPPHTTPLIB_ZSTD_SUPPORT
- #include <zstd.h>
- #endif
- /*
- * Declaration
- */
- namespace httplib {
- namespace detail {
- /*
- * Backport std::make_unique from C++14.
- *
- * NOTE: This code came up with the following stackoverflow post:
- * https://stackoverflow.com/questions/10149840/c-arrays-and-make-unique
- *
- */
- template <class T, class... Args>
- typename std::enable_if<!std::is_array<T>::value, std::unique_ptr<T>>::type
- make_unique(Args &&...args) {
- return std::unique_ptr<T>(new T(std::forward<Args>(args)...));
- }
- template <class T>
- typename std::enable_if<std::is_array<T>::value, std::unique_ptr<T>>::type
- make_unique(std::size_t n) {
- typedef typename std::remove_extent<T>::type RT;
- return std::unique_ptr<T>(new RT[n]);
- }
- namespace case_ignore {
- inline unsigned char to_lower(int c) {
- const static unsigned char table[256] = {
- 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14,
- 15, 16, 17, 18, 19, 20, 21, 22, 23, 24, 25, 26, 27, 28, 29,
- 30, 31, 32, 33, 34, 35, 36, 37, 38, 39, 40, 41, 42, 43, 44,
- 45, 46, 47, 48, 49, 50, 51, 52, 53, 54, 55, 56, 57, 58, 59,
- 60, 61, 62, 63, 64, 97, 98, 99, 100, 101, 102, 103, 104, 105, 106,
- 107, 108, 109, 110, 111, 112, 113, 114, 115, 116, 117, 118, 119, 120, 121,
- 122, 91, 92, 93, 94, 95, 96, 97, 98, 99, 100, 101, 102, 103, 104,
- 105, 106, 107, 108, 109, 110, 111, 112, 113, 114, 115, 116, 117, 118, 119,
- 120, 121, 122, 123, 124, 125, 126, 127, 128, 129, 130, 131, 132, 133, 134,
- 135, 136, 137, 138, 139, 140, 141, 142, 143, 144, 145, 146, 147, 148, 149,
- 150, 151, 152, 153, 154, 155, 156, 157, 158, 159, 160, 161, 162, 163, 164,
- 165, 166, 167, 168, 169, 170, 171, 172, 173, 174, 175, 176, 177, 178, 179,
- 180, 181, 182, 183, 184, 185, 186, 187, 188, 189, 190, 191, 224, 225, 226,
- 227, 228, 229, 230, 231, 232, 233, 234, 235, 236, 237, 238, 239, 240, 241,
- 242, 243, 244, 245, 246, 215, 248, 249, 250, 251, 252, 253, 254, 223, 224,
- 225, 226, 227, 228, 229, 230, 231, 232, 233, 234, 235, 236, 237, 238, 239,
- 240, 241, 242, 243, 244, 245, 246, 247, 248, 249, 250, 251, 252, 253, 254,
- 255,
- };
- return table[(unsigned char)(char)c];
- }
- inline bool equal(const std::string &a, const std::string &b) {
- return a.size() == b.size() &&
- std::equal(a.begin(), a.end(), b.begin(), [](char ca, char cb) {
- return to_lower(ca) == to_lower(cb);
- });
- }
- struct equal_to {
- bool operator()(const std::string &a, const std::string &b) const {
- return equal(a, b);
- }
- };
- struct hash {
- size_t operator()(const std::string &key) const {
- return hash_core(key.data(), key.size(), 0);
- }
- size_t hash_core(const char *s, size_t l, size_t h) const {
- return (l == 0) ? h
- : hash_core(s + 1, l - 1,
- // Unsets the 6 high bits of h, therefore no
- // overflow happens
- (((std::numeric_limits<size_t>::max)() >> 6) &
- h * 33) ^
- static_cast<unsigned char>(to_lower(*s)));
- }
- };
- template <typename T>
- using unordered_set = std::unordered_set<T, detail::case_ignore::hash,
- detail::case_ignore::equal_to>;
- } // namespace case_ignore
- // This is based on
- // "http://www.open-std.org/jtc1/sc22/wg21/docs/papers/2014/n4189".
- struct scope_exit {
- explicit scope_exit(std::function<void(void)> &&f)
- : exit_function(std::move(f)), execute_on_destruction{true} {}
- scope_exit(scope_exit &&rhs) noexcept
- : exit_function(std::move(rhs.exit_function)),
- execute_on_destruction{rhs.execute_on_destruction} {
- rhs.release();
- }
- ~scope_exit() {
- if (execute_on_destruction) { this->exit_function(); }
- }
- void release() { this->execute_on_destruction = false; }
- private:
- scope_exit(const scope_exit &) = delete;
- void operator=(const scope_exit &) = delete;
- scope_exit &operator=(scope_exit &&) = delete;
- std::function<void(void)> exit_function;
- bool execute_on_destruction;
- };
- } // namespace detail
- enum SSLVerifierResponse {
- // no decision has been made, use the built-in certificate verifier
- NoDecisionMade,
- // connection certificate is verified and accepted
- CertificateAccepted,
- // connection certificate was processed but is rejected
- CertificateRejected
- };
- enum StatusCode {
- // Information responses
- Continue_100 = 100,
- SwitchingProtocol_101 = 101,
- Processing_102 = 102,
- EarlyHints_103 = 103,
- // Successful responses
- OK_200 = 200,
- Created_201 = 201,
- Accepted_202 = 202,
- NonAuthoritativeInformation_203 = 203,
- NoContent_204 = 204,
- ResetContent_205 = 205,
- PartialContent_206 = 206,
- MultiStatus_207 = 207,
- AlreadyReported_208 = 208,
- IMUsed_226 = 226,
- // Redirection messages
- MultipleChoices_300 = 300,
- MovedPermanently_301 = 301,
- Found_302 = 302,
- SeeOther_303 = 303,
- NotModified_304 = 304,
- UseProxy_305 = 305,
- unused_306 = 306,
- TemporaryRedirect_307 = 307,
- PermanentRedirect_308 = 308,
- // Client error responses
- BadRequest_400 = 400,
- Unauthorized_401 = 401,
- PaymentRequired_402 = 402,
- Forbidden_403 = 403,
- NotFound_404 = 404,
- MethodNotAllowed_405 = 405,
- NotAcceptable_406 = 406,
- ProxyAuthenticationRequired_407 = 407,
- RequestTimeout_408 = 408,
- Conflict_409 = 409,
- Gone_410 = 410,
- LengthRequired_411 = 411,
- PreconditionFailed_412 = 412,
- PayloadTooLarge_413 = 413,
- UriTooLong_414 = 414,
- UnsupportedMediaType_415 = 415,
- RangeNotSatisfiable_416 = 416,
- ExpectationFailed_417 = 417,
- ImATeapot_418 = 418,
- MisdirectedRequest_421 = 421,
- UnprocessableContent_422 = 422,
- Locked_423 = 423,
- FailedDependency_424 = 424,
- TooEarly_425 = 425,
- UpgradeRequired_426 = 426,
- PreconditionRequired_428 = 428,
- TooManyRequests_429 = 429,
- RequestHeaderFieldsTooLarge_431 = 431,
- UnavailableForLegalReasons_451 = 451,
- // Server error responses
- InternalServerError_500 = 500,
- NotImplemented_501 = 501,
- BadGateway_502 = 502,
- ServiceUnavailable_503 = 503,
- GatewayTimeout_504 = 504,
- HttpVersionNotSupported_505 = 505,
- VariantAlsoNegotiates_506 = 506,
- InsufficientStorage_507 = 507,
- LoopDetected_508 = 508,
- NotExtended_510 = 510,
- NetworkAuthenticationRequired_511 = 511,
- };
- using Headers =
- std::unordered_multimap<std::string, std::string, detail::case_ignore::hash,
- detail::case_ignore::equal_to>;
- using Params = std::multimap<std::string, std::string>;
- using Match = std::smatch;
- using DownloadProgress = std::function<bool(size_t current, size_t total)>;
- using UploadProgress = std::function<bool(size_t current, size_t total)>;
- struct Response;
- using ResponseHandler = std::function<bool(const Response &response)>;
- struct FormData {
- std::string name;
- std::string content;
- std::string filename;
- std::string content_type;
- Headers headers;
- };
- struct FormField {
- std::string name;
- std::string content;
- Headers headers;
- };
- using FormFields = std::multimap<std::string, FormField>;
- using FormFiles = std::multimap<std::string, FormData>;
- struct MultipartFormData {
- FormFields fields; // Text fields from multipart
- FormFiles files; // Files from multipart
- // Text field access
- std::string get_field(const std::string &key, size_t id = 0) const;
- std::vector<std::string> get_fields(const std::string &key) const;
- bool has_field(const std::string &key) const;
- size_t get_field_count(const std::string &key) const;
- // File access
- FormData get_file(const std::string &key, size_t id = 0) const;
- std::vector<FormData> get_files(const std::string &key) const;
- bool has_file(const std::string &key) const;
- size_t get_file_count(const std::string &key) const;
- };
- struct UploadFormData {
- std::string name;
- std::string content;
- std::string filename;
- std::string content_type;
- };
- using UploadFormDataItems = std::vector<UploadFormData>;
- class DataSink {
- public:
- DataSink() : os(&sb_), sb_(*this) {}
- DataSink(const DataSink &) = delete;
- DataSink &operator=(const DataSink &) = delete;
- DataSink(DataSink &&) = delete;
- DataSink &operator=(DataSink &&) = delete;
- std::function<bool(const char *data, size_t data_len)> write;
- std::function<bool()> is_writable;
- std::function<void()> done;
- std::function<void(const Headers &trailer)> done_with_trailer;
- std::ostream os;
- private:
- class data_sink_streambuf final : public std::streambuf {
- public:
- explicit data_sink_streambuf(DataSink &sink) : sink_(sink) {}
- protected:
- std::streamsize xsputn(const char *s, std::streamsize n) override {
- sink_.write(s, static_cast<size_t>(n));
- return n;
- }
- private:
- DataSink &sink_;
- };
- data_sink_streambuf sb_;
- };
- using ContentProvider =
- std::function<bool(size_t offset, size_t length, DataSink &sink)>;
- using ContentProviderWithoutLength =
- std::function<bool(size_t offset, DataSink &sink)>;
- using ContentProviderResourceReleaser = std::function<void(bool success)>;
- struct FormDataProvider {
- std::string name;
- ContentProviderWithoutLength provider;
- std::string filename;
- std::string content_type;
- };
- using FormDataProviderItems = std::vector<FormDataProvider>;
- using ContentReceiverWithProgress = std::function<bool(
- const char *data, size_t data_length, size_t offset, size_t total_length)>;
- using ContentReceiver =
- std::function<bool(const char *data, size_t data_length)>;
- using FormDataHeader = std::function<bool(const FormData &file)>;
- class ContentReader {
- public:
- using Reader = std::function<bool(ContentReceiver receiver)>;
- using FormDataReader =
- std::function<bool(FormDataHeader header, ContentReceiver receiver)>;
- ContentReader(Reader reader, FormDataReader multipart_reader)
- : reader_(std::move(reader)),
- formdata_reader_(std::move(multipart_reader)) {}
- bool operator()(FormDataHeader header, ContentReceiver receiver) const {
- return formdata_reader_(std::move(header), std::move(receiver));
- }
- bool operator()(ContentReceiver receiver) const {
- return reader_(std::move(receiver));
- }
- Reader reader_;
- FormDataReader formdata_reader_;
- };
- using Range = std::pair<ssize_t, ssize_t>;
- using Ranges = std::vector<Range>;
- struct Request {
- std::string method;
- std::string path;
- std::string matched_route;
- Params params;
- Headers headers;
- Headers trailers;
- std::string body;
- std::string remote_addr;
- int remote_port = -1;
- std::string local_addr;
- int local_port = -1;
- // for server
- std::string version;
- std::string target;
- MultipartFormData form;
- Ranges ranges;
- Match matches;
- std::unordered_map<std::string, std::string> path_params;
- std::function<bool()> is_connection_closed = []() { return true; };
- // for client
- std::vector<std::string> accept_content_types;
- ResponseHandler response_handler;
- ContentReceiverWithProgress content_receiver;
- DownloadProgress download_progress;
- UploadProgress upload_progress;
- #ifdef CPPHTTPLIB_OPENSSL_SUPPORT
- const SSL *ssl = nullptr;
- #endif
- bool has_header(const std::string &key) const;
- std::string get_header_value(const std::string &key, const char *def = "",
- size_t id = 0) const;
- size_t get_header_value_u64(const std::string &key, size_t def = 0,
- size_t id = 0) const;
- size_t get_header_value_count(const std::string &key) const;
- void set_header(const std::string &key, const std::string &val);
- bool has_trailer(const std::string &key) const;
- std::string get_trailer_value(const std::string &key, size_t id = 0) const;
- size_t get_trailer_value_count(const std::string &key) const;
- bool has_param(const std::string &key) const;
- std::string get_param_value(const std::string &key, size_t id = 0) const;
- size_t get_param_value_count(const std::string &key) const;
- bool is_multipart_form_data() const;
- // private members...
- size_t redirect_count_ = CPPHTTPLIB_REDIRECT_MAX_COUNT;
- size_t content_length_ = 0;
- ContentProvider content_provider_;
- bool is_chunked_content_provider_ = false;
- size_t authorization_count_ = 0;
- std::chrono::time_point<std::chrono::steady_clock> start_time_ =
- (std::chrono::steady_clock::time_point::min)();
- };
- struct Response {
- std::string version;
- int status = -1;
- std::string reason;
- Headers headers;
- Headers trailers;
- std::string body;
- std::string location; // Redirect location
- bool has_header(const std::string &key) const;
- std::string get_header_value(const std::string &key, const char *def = "",
- size_t id = 0) const;
- size_t get_header_value_u64(const std::string &key, size_t def = 0,
- size_t id = 0) const;
- size_t get_header_value_count(const std::string &key) const;
- void set_header(const std::string &key, const std::string &val);
- bool has_trailer(const std::string &key) const;
- std::string get_trailer_value(const std::string &key, size_t id = 0) const;
- size_t get_trailer_value_count(const std::string &key) const;
- void set_redirect(const std::string &url, int status = StatusCode::Found_302);
- void set_content(const char *s, size_t n, const std::string &content_type);
- void set_content(const std::string &s, const std::string &content_type);
- void set_content(std::string &&s, const std::string &content_type);
- void set_content_provider(
- size_t length, const std::string &content_type, ContentProvider provider,
- ContentProviderResourceReleaser resource_releaser = nullptr);
- void set_content_provider(
- const std::string &content_type, ContentProviderWithoutLength provider,
- ContentProviderResourceReleaser resource_releaser = nullptr);
- void set_chunked_content_provider(
- const std::string &content_type, ContentProviderWithoutLength provider,
- ContentProviderResourceReleaser resource_releaser = nullptr);
- void set_file_content(const std::string &path,
- const std::string &content_type);
- void set_file_content(const std::string &path);
- Response() = default;
- Response(const Response &) = default;
- Response &operator=(const Response &) = default;
- Response(Response &&) = default;
- Response &operator=(Response &&) = default;
- ~Response() {
- if (content_provider_resource_releaser_) {
- content_provider_resource_releaser_(content_provider_success_);
- }
- }
- // private members...
- size_t content_length_ = 0;
- ContentProvider content_provider_;
- ContentProviderResourceReleaser content_provider_resource_releaser_;
- bool is_chunked_content_provider_ = false;
- bool content_provider_success_ = false;
- std::string file_content_path_;
- std::string file_content_content_type_;
- };
- enum class Error {
- Success = 0,
- Unknown,
- Connection,
- BindIPAddress,
- Read,
- Write,
- ExceedRedirectCount,
- Canceled,
- SSLConnection,
- SSLLoadingCerts,
- SSLServerVerification,
- SSLServerHostnameVerification,
- UnsupportedMultipartBoundaryChars,
- Compression,
- ConnectionTimeout,
- ProxyConnection,
- ConnectionClosed,
- Timeout,
- ResourceExhaustion,
- TooManyFormDataFiles,
- ExceedMaxPayloadSize,
- ExceedUriMaxLength,
- ExceedMaxSocketDescriptorCount,
- InvalidRequestLine,
- InvalidHTTPMethod,
- InvalidHTTPVersion,
- InvalidHeaders,
- MultipartParsing,
- OpenFile,
- Listen,
- GetSockName,
- UnsupportedAddressFamily,
- HTTPParsing,
- InvalidRangeHeader,
- // For internal use only
- SSLPeerCouldBeClosed_,
- };
- std::string to_string(Error error);
- std::ostream &operator<<(std::ostream &os, const Error &obj);
- class Stream {
- public:
- virtual ~Stream() = default;
- virtual bool is_readable() const = 0;
- virtual bool wait_readable() const = 0;
- virtual bool wait_writable() const = 0;
- virtual ssize_t read(char *ptr, size_t size) = 0;
- virtual ssize_t write(const char *ptr, size_t size) = 0;
- virtual void get_remote_ip_and_port(std::string &ip, int &port) const = 0;
- virtual void get_local_ip_and_port(std::string &ip, int &port) const = 0;
- virtual socket_t socket() const = 0;
- virtual time_t duration() const = 0;
- ssize_t write(const char *ptr);
- ssize_t write(const std::string &s);
- Error get_error() const { return error_; }
- protected:
- Error error_ = Error::Success;
- };
- class TaskQueue {
- public:
- TaskQueue() = default;
- virtual ~TaskQueue() = default;
- virtual bool enqueue(std::function<void()> fn) = 0;
- virtual void shutdown() = 0;
- virtual void on_idle() {}
- };
- class ThreadPool final : public TaskQueue {
- public:
- explicit ThreadPool(size_t n, size_t mqr = 0)
- : shutdown_(false), max_queued_requests_(mqr) {
- threads_.reserve(n);
- while (n) {
- threads_.emplace_back(worker(*this));
- n--;
- }
- }
- ThreadPool(const ThreadPool &) = delete;
- ~ThreadPool() override = default;
- bool enqueue(std::function<void()> fn) override {
- {
- std::unique_lock<std::mutex> lock(mutex_);
- if (max_queued_requests_ > 0 && jobs_.size() >= max_queued_requests_) {
- return false;
- }
- jobs_.push_back(std::move(fn));
- }
- cond_.notify_one();
- return true;
- }
- void shutdown() override {
- // Stop all worker threads...
- {
- std::unique_lock<std::mutex> lock(mutex_);
- shutdown_ = true;
- }
- cond_.notify_all();
- // Join...
- for (auto &t : threads_) {
- t.join();
- }
- }
- private:
- struct worker {
- explicit worker(ThreadPool &pool) : pool_(pool) {}
- void operator()() {
- for (;;) {
- std::function<void()> fn;
- {
- std::unique_lock<std::mutex> lock(pool_.mutex_);
- pool_.cond_.wait(
- lock, [&] { return !pool_.jobs_.empty() || pool_.shutdown_; });
- if (pool_.shutdown_ && pool_.jobs_.empty()) { break; }
- fn = pool_.jobs_.front();
- pool_.jobs_.pop_front();
- }
- assert(true == static_cast<bool>(fn));
- fn();
- }
- #if defined(CPPHTTPLIB_OPENSSL_SUPPORT) && !defined(OPENSSL_IS_BORINGSSL) && \
- !defined(LIBRESSL_VERSION_NUMBER)
- OPENSSL_thread_stop();
- #endif
- }
- ThreadPool &pool_;
- };
- friend struct worker;
- std::vector<std::thread> threads_;
- std::list<std::function<void()>> jobs_;
- bool shutdown_;
- size_t max_queued_requests_ = 0;
- std::condition_variable cond_;
- std::mutex mutex_;
- };
- using Logger = std::function<void(const Request &, const Response &)>;
- // Forward declaration for Error type
- enum class Error;
- using ErrorLogger = std::function<void(const Error &, const Request *)>;
- using SocketOptions = std::function<void(socket_t sock)>;
- void default_socket_options(socket_t sock);
- const char *status_message(int status);
- std::string to_string(Error error);
- std::ostream &operator<<(std::ostream &os, const Error &obj);
- std::string get_bearer_token_auth(const Request &req);
- namespace detail {
- class MatcherBase {
- public:
- MatcherBase(std::string pattern) : pattern_(std::move(pattern)) {}
- virtual ~MatcherBase() = default;
- const std::string &pattern() const { return pattern_; }
- // Match request path and populate its matches and
- virtual bool match(Request &request) const = 0;
- private:
- std::string pattern_;
- };
- /**
- * Captures parameters in request path and stores them in Request::path_params
- *
- * Capture name is a substring of a pattern from : to /.
- * The rest of the pattern is matched against the request path directly
- * Parameters are captured starting from the next character after
- * the end of the last matched static pattern fragment until the next /.
- *
- * Example pattern:
- * "/path/fragments/:capture/more/fragments/:second_capture"
- * Static fragments:
- * "/path/fragments/", "more/fragments/"
- *
- * Given the following request path:
- * "/path/fragments/:1/more/fragments/:2"
- * the resulting capture will be
- * {{"capture", "1"}, {"second_capture", "2"}}
- */
- class PathParamsMatcher final : public MatcherBase {
- public:
- PathParamsMatcher(const std::string &pattern);
- bool match(Request &request) const override;
- private:
- // Treat segment separators as the end of path parameter capture
- // Does not need to handle query parameters as they are parsed before path
- // matching
- static constexpr char separator = '/';
- // Contains static path fragments to match against, excluding the '/' after
- // path params
- // Fragments are separated by path params
- std::vector<std::string> static_fragments_;
- // Stores the names of the path parameters to be used as keys in the
- // Request::path_params map
- std::vector<std::string> param_names_;
- };
- /**
- * Performs std::regex_match on request path
- * and stores the result in Request::matches
- *
- * Note that regex match is performed directly on the whole request.
- * This means that wildcard patterns may match multiple path segments with /:
- * "/begin/(.*)/end" will match both "/begin/middle/end" and "/begin/1/2/end".
- */
- class RegexMatcher final : public MatcherBase {
- public:
- RegexMatcher(const std::string &pattern)
- : MatcherBase(pattern), regex_(pattern) {}
- bool match(Request &request) const override;
- private:
- std::regex regex_;
- };
- int close_socket(socket_t sock);
- ssize_t write_headers(Stream &strm, const Headers &headers);
- } // namespace detail
- class Server {
- public:
- using Handler = std::function<void(const Request &, Response &)>;
- using ExceptionHandler =
- std::function<void(const Request &, Response &, std::exception_ptr ep)>;
- enum class HandlerResponse {
- Handled,
- Unhandled,
- };
- using HandlerWithResponse =
- std::function<HandlerResponse(const Request &, Response &)>;
- using HandlerWithContentReader = std::function<void(
- const Request &, Response &, const ContentReader &content_reader)>;
- using Expect100ContinueHandler =
- std::function<int(const Request &, Response &)>;
- Server();
- virtual ~Server();
- virtual bool is_valid() const;
- Server &Get(const std::string &pattern, Handler handler);
- Server &Post(const std::string &pattern, Handler handler);
- Server &Post(const std::string &pattern, HandlerWithContentReader handler);
- Server &Put(const std::string &pattern, Handler handler);
- Server &Put(const std::string &pattern, HandlerWithContentReader handler);
- Server &Patch(const std::string &pattern, Handler handler);
- Server &Patch(const std::string &pattern, HandlerWithContentReader handler);
- Server &Delete(const std::string &pattern, Handler handler);
- Server &Delete(const std::string &pattern, HandlerWithContentReader handler);
- Server &Options(const std::string &pattern, Handler handler);
- bool set_base_dir(const std::string &dir,
- const std::string &mount_point = std::string());
- bool set_mount_point(const std::string &mount_point, const std::string &dir,
- Headers headers = Headers());
- bool remove_mount_point(const std::string &mount_point);
- Server &set_file_extension_and_mimetype_mapping(const std::string &ext,
- const std::string &mime);
- Server &set_default_file_mimetype(const std::string &mime);
- Server &set_file_request_handler(Handler handler);
- template <class ErrorHandlerFunc>
- Server &set_error_handler(ErrorHandlerFunc &&handler) {
- return set_error_handler_core(
- std::forward<ErrorHandlerFunc>(handler),
- std::is_convertible<ErrorHandlerFunc, HandlerWithResponse>{});
- }
- Server &set_exception_handler(ExceptionHandler handler);
- Server &set_pre_routing_handler(HandlerWithResponse handler);
- Server &set_post_routing_handler(Handler handler);
- Server &set_pre_request_handler(HandlerWithResponse handler);
- Server &set_expect_100_continue_handler(Expect100ContinueHandler handler);
- Server &set_logger(Logger logger);
- Server &set_pre_compression_logger(Logger logger);
- Server &set_error_logger(ErrorLogger error_logger);
- Server &set_address_family(int family);
- Server &set_tcp_nodelay(bool on);
- Server &set_ipv6_v6only(bool on);
- Server &set_socket_options(SocketOptions socket_options);
- Server &set_default_headers(Headers headers);
- Server &
- set_header_writer(std::function<ssize_t(Stream &, Headers &)> const &writer);
- Server &set_trusted_proxies(const std::vector<std::string> &proxies);
- Server &set_keep_alive_max_count(size_t count);
- Server &set_keep_alive_timeout(time_t sec);
- Server &set_read_timeout(time_t sec, time_t usec = 0);
- template <class Rep, class Period>
- Server &set_read_timeout(const std::chrono::duration<Rep, Period> &duration);
- Server &set_write_timeout(time_t sec, time_t usec = 0);
- template <class Rep, class Period>
- Server &set_write_timeout(const std::chrono::duration<Rep, Period> &duration);
- Server &set_idle_interval(time_t sec, time_t usec = 0);
- template <class Rep, class Period>
- Server &set_idle_interval(const std::chrono::duration<Rep, Period> &duration);
- Server &set_payload_max_length(size_t length);
- bool bind_to_port(const std::string &host, int port, int socket_flags = 0);
- int bind_to_any_port(const std::string &host, int socket_flags = 0);
- bool listen_after_bind();
- bool listen(const std::string &host, int port, int socket_flags = 0);
- bool is_running() const;
- void wait_until_ready() const;
- void stop();
- void decommission();
- std::function<TaskQueue *(void)> new_task_queue;
- protected:
- bool process_request(Stream &strm, const std::string &remote_addr,
- int remote_port, const std::string &local_addr,
- int local_port, bool close_connection,
- bool &connection_closed,
- const std::function<void(Request &)> &setup_request);
- std::atomic<socket_t> svr_sock_{INVALID_SOCKET};
- std::vector<std::string> trusted_proxies_;
- size_t keep_alive_max_count_ = CPPHTTPLIB_KEEPALIVE_MAX_COUNT;
- time_t keep_alive_timeout_sec_ = CPPHTTPLIB_KEEPALIVE_TIMEOUT_SECOND;
- time_t read_timeout_sec_ = CPPHTTPLIB_SERVER_READ_TIMEOUT_SECOND;
- time_t read_timeout_usec_ = CPPHTTPLIB_SERVER_READ_TIMEOUT_USECOND;
- time_t write_timeout_sec_ = CPPHTTPLIB_SERVER_WRITE_TIMEOUT_SECOND;
- time_t write_timeout_usec_ = CPPHTTPLIB_SERVER_WRITE_TIMEOUT_USECOND;
- time_t idle_interval_sec_ = CPPHTTPLIB_IDLE_INTERVAL_SECOND;
- time_t idle_interval_usec_ = CPPHTTPLIB_IDLE_INTERVAL_USECOND;
- size_t payload_max_length_ = CPPHTTPLIB_PAYLOAD_MAX_LENGTH;
- private:
- using Handlers =
- std::vector<std::pair<std::unique_ptr<detail::MatcherBase>, Handler>>;
- using HandlersForContentReader =
- std::vector<std::pair<std::unique_ptr<detail::MatcherBase>,
- HandlerWithContentReader>>;
- static std::unique_ptr<detail::MatcherBase>
- make_matcher(const std::string &pattern);
- Server &set_error_handler_core(HandlerWithResponse handler, std::true_type);
- Server &set_error_handler_core(Handler handler, std::false_type);
- socket_t create_server_socket(const std::string &host, int port,
- int socket_flags,
- SocketOptions socket_options) const;
- int bind_internal(const std::string &host, int port, int socket_flags);
- bool listen_internal();
- bool routing(Request &req, Response &res, Stream &strm);
- bool handle_file_request(Request &req, Response &res);
- bool check_if_not_modified(const Request &req, Response &res,
- const std::string &etag, time_t mtime) const;
- bool check_if_range(Request &req, const std::string &etag,
- time_t mtime) const;
- bool dispatch_request(Request &req, Response &res,
- const Handlers &handlers) const;
- bool dispatch_request_for_content_reader(
- Request &req, Response &res, ContentReader content_reader,
- const HandlersForContentReader &handlers) const;
- bool parse_request_line(const char *s, Request &req) const;
- void apply_ranges(const Request &req, Response &res,
- std::string &content_type, std::string &boundary) const;
- bool write_response(Stream &strm, bool close_connection, Request &req,
- Response &res);
- bool write_response_with_content(Stream &strm, bool close_connection,
- const Request &req, Response &res);
- bool write_response_core(Stream &strm, bool close_connection,
- const Request &req, Response &res,
- bool need_apply_ranges);
- bool write_content_with_provider(Stream &strm, const Request &req,
- Response &res, const std::string &boundary,
- const std::string &content_type);
- bool read_content(Stream &strm, Request &req, Response &res);
- bool read_content_with_content_receiver(Stream &strm, Request &req,
- Response &res,
- ContentReceiver receiver,
- FormDataHeader multipart_header,
- ContentReceiver multipart_receiver);
- bool read_content_core(Stream &strm, Request &req, Response &res,
- ContentReceiver receiver,
- FormDataHeader multipart_header,
- ContentReceiver multipart_receiver) const;
- virtual bool process_and_close_socket(socket_t sock);
- void output_log(const Request &req, const Response &res) const;
- void output_pre_compression_log(const Request &req,
- const Response &res) const;
- void output_error_log(const Error &err, const Request *req) const;
- std::atomic<bool> is_running_{false};
- std::atomic<bool> is_decommissioned{false};
- struct MountPointEntry {
- std::string mount_point;
- std::string base_dir;
- Headers headers;
- };
- std::vector<MountPointEntry> base_dirs_;
- std::map<std::string, std::string> file_extension_and_mimetype_map_;
- std::string default_file_mimetype_ = "application/octet-stream";
- Handler file_request_handler_;
- Handlers get_handlers_;
- Handlers post_handlers_;
- HandlersForContentReader post_handlers_for_content_reader_;
- Handlers put_handlers_;
- HandlersForContentReader put_handlers_for_content_reader_;
- Handlers patch_handlers_;
- HandlersForContentReader patch_handlers_for_content_reader_;
- Handlers delete_handlers_;
- HandlersForContentReader delete_handlers_for_content_reader_;
- Handlers options_handlers_;
- HandlerWithResponse error_handler_;
- ExceptionHandler exception_handler_;
- HandlerWithResponse pre_routing_handler_;
- Handler post_routing_handler_;
- HandlerWithResponse pre_request_handler_;
- Expect100ContinueHandler expect_100_continue_handler_;
- mutable std::mutex logger_mutex_;
- Logger logger_;
- Logger pre_compression_logger_;
- ErrorLogger error_logger_;
- int address_family_ = AF_UNSPEC;
- bool tcp_nodelay_ = CPPHTTPLIB_TCP_NODELAY;
- bool ipv6_v6only_ = CPPHTTPLIB_IPV6_V6ONLY;
- SocketOptions socket_options_ = default_socket_options;
- Headers default_headers_;
- std::function<ssize_t(Stream &, Headers &)> header_writer_ =
- detail::write_headers;
- };
- class Result {
- public:
- Result() = default;
- Result(std::unique_ptr<Response> &&res, Error err,
- Headers &&request_headers = Headers{})
- : res_(std::move(res)), err_(err),
- request_headers_(std::move(request_headers)) {}
- #ifdef CPPHTTPLIB_OPENSSL_SUPPORT
- Result(std::unique_ptr<Response> &&res, Error err, Headers &&request_headers,
- int ssl_error)
- : res_(std::move(res)), err_(err),
- request_headers_(std::move(request_headers)), ssl_error_(ssl_error) {}
- Result(std::unique_ptr<Response> &&res, Error err, Headers &&request_headers,
- int ssl_error, unsigned long ssl_openssl_error)
- : res_(std::move(res)), err_(err),
- request_headers_(std::move(request_headers)), ssl_error_(ssl_error),
- ssl_openssl_error_(ssl_openssl_error) {}
- #endif
- // Response
- operator bool() const { return res_ != nullptr; }
- bool operator==(std::nullptr_t) const { return res_ == nullptr; }
- bool operator!=(std::nullptr_t) const { return res_ != nullptr; }
- const Response &value() const { return *res_; }
- Response &value() { return *res_; }
- const Response &operator*() const { return *res_; }
- Response &operator*() { return *res_; }
- const Response *operator->() const { return res_.get(); }
- Response *operator->() { return res_.get(); }
- // Error
- Error error() const { return err_; }
- #ifdef CPPHTTPLIB_OPENSSL_SUPPORT
- // SSL Error
- int ssl_error() const { return ssl_error_; }
- // OpenSSL Error
- unsigned long ssl_openssl_error() const { return ssl_openssl_error_; }
- #endif
- // Request Headers
- bool has_request_header(const std::string &key) const;
- std::string get_request_header_value(const std::string &key,
- const char *def = "",
- size_t id = 0) const;
- size_t get_request_header_value_u64(const std::string &key, size_t def = 0,
- size_t id = 0) const;
- size_t get_request_header_value_count(const std::string &key) const;
- private:
- std::unique_ptr<Response> res_;
- Error err_ = Error::Unknown;
- Headers request_headers_;
- #ifdef CPPHTTPLIB_OPENSSL_SUPPORT
- int ssl_error_ = 0;
- unsigned long ssl_openssl_error_ = 0;
- #endif
- };
- struct ClientConnection {
- socket_t sock = INVALID_SOCKET;
- #ifdef CPPHTTPLIB_OPENSSL_SUPPORT
- SSL *ssl = nullptr;
- #endif
- bool is_open() const { return sock != INVALID_SOCKET; }
- ClientConnection() = default;
- ~ClientConnection() {
- #ifdef CPPHTTPLIB_OPENSSL_SUPPORT
- if (ssl) {
- SSL_free(ssl);
- ssl = nullptr;
- }
- #endif
- if (sock != INVALID_SOCKET) {
- detail::close_socket(sock);
- sock = INVALID_SOCKET;
- }
- }
- ClientConnection(const ClientConnection &) = delete;
- ClientConnection &operator=(const ClientConnection &) = delete;
- ClientConnection(ClientConnection &&other) noexcept
- : sock(other.sock)
- #ifdef CPPHTTPLIB_OPENSSL_SUPPORT
- ,
- ssl(other.ssl)
- #endif
- {
- other.sock = INVALID_SOCKET;
- #ifdef CPPHTTPLIB_OPENSSL_SUPPORT
- other.ssl = nullptr;
- #endif
- }
- ClientConnection &operator=(ClientConnection &&other) noexcept {
- if (this != &other) {
- sock = other.sock;
- #ifdef CPPHTTPLIB_OPENSSL_SUPPORT
- ssl = other.ssl;
- #endif
- other.sock = INVALID_SOCKET;
- #ifdef CPPHTTPLIB_OPENSSL_SUPPORT
- other.ssl = nullptr;
- #endif
- }
- return *this;
- }
- };
- namespace detail {
- struct ChunkedDecoder;
- struct BodyReader {
- Stream *stream = nullptr;
- size_t content_length = 0;
- size_t bytes_read = 0;
- bool chunked = false;
- bool eof = false;
- std::unique_ptr<ChunkedDecoder> chunked_decoder;
- Error last_error = Error::Success;
- ssize_t read(char *buf, size_t len);
- bool has_error() const { return last_error != Error::Success; }
- };
- inline ssize_t read_body_content(Stream *stream, BodyReader &br, char *buf,
- size_t len) {
- (void)stream;
- return br.read(buf, len);
- }
- class decompressor;
- } // namespace detail
- class ClientImpl {
- public:
- explicit ClientImpl(const std::string &host);
- explicit ClientImpl(const std::string &host, int port);
- explicit ClientImpl(const std::string &host, int port,
- const std::string &client_cert_path,
- const std::string &client_key_path);
- virtual ~ClientImpl();
- virtual bool is_valid() const;
- struct StreamHandle {
- std::unique_ptr<Response> response;
- Error error = Error::Success;
- StreamHandle() = default;
- StreamHandle(const StreamHandle &) = delete;
- StreamHandle &operator=(const StreamHandle &) = delete;
- StreamHandle(StreamHandle &&) = default;
- StreamHandle &operator=(StreamHandle &&) = default;
- ~StreamHandle() = default;
- bool is_valid() const {
- return response != nullptr && error == Error::Success;
- }
- ssize_t read(char *buf, size_t len);
- void parse_trailers_if_needed();
- Error get_read_error() const { return body_reader_.last_error; }
- bool has_read_error() const { return body_reader_.has_error(); }
- bool trailers_parsed_ = false;
- private:
- friend class ClientImpl;
- ssize_t read_with_decompression(char *buf, size_t len);
- std::unique_ptr<ClientConnection> connection_;
- std::unique_ptr<Stream> socket_stream_;
- Stream *stream_ = nullptr;
- detail::BodyReader body_reader_;
- std::unique_ptr<detail::decompressor> decompressor_;
- std::string decompress_buffer_;
- size_t decompress_offset_ = 0;
- };
- // clang-format off
- Result Get(const std::string &path, DownloadProgress progress = nullptr);
- Result Get(const std::string &path, ContentReceiver content_receiver, DownloadProgress progress = nullptr);
- Result Get(const std::string &path, ResponseHandler response_handler, ContentReceiver content_receiver, DownloadProgress progress = nullptr);
- Result Get(const std::string &path, const Headers &headers, DownloadProgress progress = nullptr);
- Result Get(const std::string &path, const Headers &headers, ContentReceiver content_receiver, DownloadProgress progress = nullptr);
- Result Get(const std::string &path, const Headers &headers, ResponseHandler response_handler, ContentReceiver content_receiver, DownloadProgress progress = nullptr);
- Result Get(const std::string &path, const Params ¶ms, const Headers &headers, DownloadProgress progress = nullptr);
- Result Get(const std::string &path, const Params ¶ms, const Headers &headers, ContentReceiver content_receiver, DownloadProgress progress = nullptr);
- Result Get(const std::string &path, const Params ¶ms, const Headers &headers, ResponseHandler response_handler, ContentReceiver content_receiver, DownloadProgress progress = nullptr);
- Result Head(const std::string &path);
- Result Head(const std::string &path, const Headers &headers);
- Result Post(const std::string &path);
- Result Post(const std::string &path, const char *body, size_t content_length, const std::string &content_type, UploadProgress progress = nullptr);
- Result Post(const std::string &path, const std::string &body, const std::string &content_type, UploadProgress progress = nullptr);
- Result Post(const std::string &path, size_t content_length, ContentProvider content_provider, const std::string &content_type, UploadProgress progress = nullptr);
- Result Post(const std::string &path, size_t content_length, ContentProvider content_provider, const std::string &content_type, ContentReceiver content_receiver, UploadProgress progress = nullptr);
- Result Post(const std::string &path, ContentProviderWithoutLength content_provider, const std::string &content_type, UploadProgress progress = nullptr);
- Result Post(const std::string &path, ContentProviderWithoutLength content_provider, const std::string &content_type, ContentReceiver content_receiver, UploadProgress progress = nullptr);
- Result Post(const std::string &path, const Params ¶ms);
- Result Post(const std::string &path, const UploadFormDataItems &items, UploadProgress progress = nullptr);
- Result Post(const std::string &path, const Headers &headers);
- Result Post(const std::string &path, const Headers &headers, const char *body, size_t content_length, const std::string &content_type, UploadProgress progress = nullptr);
- Result Post(const std::string &path, const Headers &headers, const std::string &body, const std::string &content_type, UploadProgress progress = nullptr);
- Result Post(const std::string &path, const Headers &headers, size_t content_length, ContentProvider content_provider, const std::string &content_type, UploadProgress progress = nullptr);
- Result Post(const std::string &path, const Headers &headers, size_t content_length, ContentProvider content_provider, const std::string &content_type, ContentReceiver content_receiver, DownloadProgress progress = nullptr);
- Result Post(const std::string &path, const Headers &headers, ContentProviderWithoutLength content_provider, const std::string &content_type, UploadProgress progress = nullptr);
- Result Post(const std::string &path, const Headers &headers, ContentProviderWithoutLength content_provider, const std::string &content_type, ContentReceiver content_receiver, DownloadProgress progress = nullptr);
- Result Post(const std::string &path, const Headers &headers, const Params ¶ms);
- Result Post(const std::string &path, const Headers &headers, const UploadFormDataItems &items, UploadProgress progress = nullptr);
- Result Post(const std::string &path, const Headers &headers, const UploadFormDataItems &items, const std::string &boundary, UploadProgress progress = nullptr);
- Result Post(const std::string &path, const Headers &headers, const UploadFormDataItems &items, const FormDataProviderItems &provider_items, UploadProgress progress = nullptr);
- Result Post(const std::string &path, const Headers &headers, const std::string &body, const std::string &content_type, ContentReceiver content_receiver, DownloadProgress progress = nullptr);
- Result Put(const std::string &path);
- Result Put(const std::string &path, const char *body, size_t content_length, const std::string &content_type, UploadProgress progress = nullptr);
- Result Put(const std::string &path, const std::string &body, const std::string &content_type, UploadProgress progress = nullptr);
- Result Put(const std::string &path, size_t content_length, ContentProvider content_provider, const std::string &content_type, UploadProgress progress = nullptr);
- Result Put(const std::string &path, size_t content_length, ContentProvider content_provider, const std::string &content_type, ContentReceiver content_receiver, UploadProgress progress = nullptr);
- Result Put(const std::string &path, ContentProviderWithoutLength content_provider, const std::string &content_type, UploadProgress progress = nullptr);
- Result Put(const std::string &path, ContentProviderWithoutLength content_provider, const std::string &content_type, ContentReceiver content_receiver, UploadProgress progress = nullptr);
- Result Put(const std::string &path, const Params ¶ms);
- Result Put(const std::string &path, const UploadFormDataItems &items, UploadProgress progress = nullptr);
- Result Put(const std::string &path, const Headers &headers);
- Result Put(const std::string &path, const Headers &headers, const char *body, size_t content_length, const std::string &content_type, UploadProgress progress = nullptr);
- Result Put(const std::string &path, const Headers &headers, const std::string &body, const std::string &content_type, UploadProgress progress = nullptr);
- Result Put(const std::string &path, const Headers &headers, size_t content_length, ContentProvider content_provider, const std::string &content_type, UploadProgress progress = nullptr);
- Result Put(const std::string &path, const Headers &headers, size_t content_length, ContentProvider content_provider, const std::string &content_type, ContentReceiver content_receiver, UploadProgress progress = nullptr);
- Result Put(const std::string &path, const Headers &headers, ContentProviderWithoutLength content_provider, const std::string &content_type, UploadProgress progress = nullptr);
- Result Put(const std::string &path, const Headers &headers, ContentProviderWithoutLength content_provider, const std::string &content_type, ContentReceiver content_receiver, UploadProgress progress = nullptr);
- Result Put(const std::string &path, const Headers &headers, const Params ¶ms);
- Result Put(const std::string &path, const Headers &headers, const UploadFormDataItems &items, UploadProgress progress = nullptr);
- Result Put(const std::string &path, const Headers &headers, const UploadFormDataItems &items, const std::string &boundary, UploadProgress progress = nullptr);
- Result Put(const std::string &path, const Headers &headers, const UploadFormDataItems &items, const FormDataProviderItems &provider_items, UploadProgress progress = nullptr);
- Result Put(const std::string &path, const Headers &headers, const std::string &body, const std::string &content_type, ContentReceiver content_receiver, DownloadProgress progress = nullptr);
- Result Patch(const std::string &path);
- Result Patch(const std::string &path, const char *body, size_t content_length, const std::string &content_type, UploadProgress progress = nullptr);
- Result Patch(const std::string &path, const std::string &body, const std::string &content_type, UploadProgress progress = nullptr);
- Result Patch(const std::string &path, size_t content_length, ContentProvider content_provider, const std::string &content_type, UploadProgress progress = nullptr);
- Result Patch(const std::string &path, size_t content_length, ContentProvider content_provider, const std::string &content_type, ContentReceiver content_receiver, UploadProgress progress = nullptr);
- Result Patch(const std::string &path, ContentProviderWithoutLength content_provider, const std::string &content_type, UploadProgress progress = nullptr);
- Result Patch(const std::string &path, ContentProviderWithoutLength content_provider, const std::string &content_type, ContentReceiver content_receiver, UploadProgress progress = nullptr);
- Result Patch(const std::string &path, const Params ¶ms);
- Result Patch(const std::string &path, const UploadFormDataItems &items, UploadProgress progress = nullptr);
- Result Patch(const std::string &path, const Headers &headers, UploadProgress progress = nullptr);
- Result Patch(const std::string &path, const Headers &headers, const char *body, size_t content_length, const std::string &content_type, UploadProgress progress = nullptr);
- Result Patch(const std::string &path, const Headers &headers, const std::string &body, const std::string &content_type, UploadProgress progress = nullptr);
- Result Patch(const std::string &path, const Headers &headers, size_t content_length, ContentProvider content_provider, const std::string &content_type, UploadProgress progress = nullptr);
- Result Patch(const std::string &path, const Headers &headers, size_t content_length, ContentProvider content_provider, const std::string &content_type, ContentReceiver content_receiver, UploadProgress progress = nullptr);
- Result Patch(const std::string &path, const Headers &headers, ContentProviderWithoutLength content_provider, const std::string &content_type, UploadProgress progress = nullptr);
- Result Patch(const std::string &path, const Headers &headers, ContentProviderWithoutLength content_provider, const std::string &content_type, ContentReceiver content_receiver, UploadProgress progress = nullptr);
- Result Patch(const std::string &path, const Headers &headers, const Params ¶ms);
- Result Patch(const std::string &path, const Headers &headers, const UploadFormDataItems &items, UploadProgress progress = nullptr);
- Result Patch(const std::string &path, const Headers &headers, const UploadFormDataItems &items, const std::string &boundary, UploadProgress progress = nullptr);
- Result Patch(const std::string &path, const Headers &headers, const UploadFormDataItems &items, const FormDataProviderItems &provider_items, UploadProgress progress = nullptr);
- Result Patch(const std::string &path, const Headers &headers, const std::string &body, const std::string &content_type, ContentReceiver content_receiver, DownloadProgress progress = nullptr);
- Result Delete(const std::string &path, DownloadProgress progress = nullptr);
- Result Delete(const std::string &path, const char *body, size_t content_length, const std::string &content_type, DownloadProgress progress = nullptr);
- Result Delete(const std::string &path, const std::string &body, const std::string &content_type, DownloadProgress progress = nullptr);
- Result Delete(const std::string &path, const Params ¶ms, DownloadProgress progress = nullptr);
- Result Delete(const std::string &path, const Headers &headers, DownloadProgress progress = nullptr);
- Result Delete(const std::string &path, const Headers &headers, const char *body, size_t content_length, const std::string &content_type, DownloadProgress progress = nullptr);
- Result Delete(const std::string &path, const Headers &headers, const std::string &body, const std::string &content_type, DownloadProgress progress = nullptr);
- Result Delete(const std::string &path, const Headers &headers, const Params ¶ms, DownloadProgress progress = nullptr);
- Result Options(const std::string &path);
- Result Options(const std::string &path, const Headers &headers);
- // clang-format on
- // Streaming API: Open a stream for reading response body incrementally
- // Socket ownership is transferred to StreamHandle for true streaming
- // Supports all HTTP methods (GET, POST, PUT, PATCH, DELETE, etc.)
- StreamHandle open_stream(const std::string &method, const std::string &path,
- const Params ¶ms = {},
- const Headers &headers = {},
- const std::string &body = {},
- const std::string &content_type = {});
- bool send(Request &req, Response &res, Error &error);
- Result send(const Request &req);
- void stop();
- std::string host() const;
- int port() const;
- size_t is_socket_open() const;
- socket_t socket() const;
- void set_hostname_addr_map(std::map<std::string, std::string> addr_map);
- void set_default_headers(Headers headers);
- void
- set_header_writer(std::function<ssize_t(Stream &, Headers &)> const &writer);
- void set_address_family(int family);
- void set_tcp_nodelay(bool on);
- void set_ipv6_v6only(bool on);
- void set_socket_options(SocketOptions socket_options);
- void set_connection_timeout(time_t sec, time_t usec = 0);
- template <class Rep, class Period>
- void
- set_connection_timeout(const std::chrono::duration<Rep, Period> &duration);
- void set_read_timeout(time_t sec, time_t usec = 0);
- template <class Rep, class Period>
- void set_read_timeout(const std::chrono::duration<Rep, Period> &duration);
- void set_write_timeout(time_t sec, time_t usec = 0);
- template <class Rep, class Period>
- void set_write_timeout(const std::chrono::duration<Rep, Period> &duration);
- void set_max_timeout(time_t msec);
- template <class Rep, class Period>
- void set_max_timeout(const std::chrono::duration<Rep, Period> &duration);
- void set_basic_auth(const std::string &username, const std::string &password);
- void set_bearer_token_auth(const std::string &token);
- #ifdef CPPHTTPLIB_OPENSSL_SUPPORT
- void set_digest_auth(const std::string &username,
- const std::string &password);
- #endif
- void set_keep_alive(bool on);
- void set_follow_location(bool on);
- void set_path_encode(bool on);
- void set_compress(bool on);
- void set_decompress(bool on);
- void set_interface(const std::string &intf);
- void set_proxy(const std::string &host, int port);
- void set_proxy_basic_auth(const std::string &username,
- const std::string &password);
- void set_proxy_bearer_token_auth(const std::string &token);
- #ifdef CPPHTTPLIB_OPENSSL_SUPPORT
- void set_proxy_digest_auth(const std::string &username,
- const std::string &password);
- #endif
- #ifdef CPPHTTPLIB_OPENSSL_SUPPORT
- void set_ca_cert_path(const std::string &ca_cert_file_path,
- const std::string &ca_cert_dir_path = std::string());
- void set_ca_cert_store(X509_STORE *ca_cert_store);
- X509_STORE *create_ca_cert_store(const char *ca_cert, std::size_t size) const;
- #endif
- #ifdef CPPHTTPLIB_OPENSSL_SUPPORT
- void enable_server_certificate_verification(bool enabled);
- void enable_server_hostname_verification(bool enabled);
- void set_server_certificate_verifier(
- std::function<SSLVerifierResponse(SSL *ssl)> verifier);
- #endif
- void set_logger(Logger logger);
- void set_error_logger(ErrorLogger error_logger);
- protected:
- struct Socket {
- socket_t sock = INVALID_SOCKET;
- #ifdef CPPHTTPLIB_OPENSSL_SUPPORT
- SSL *ssl = nullptr;
- #endif
- bool is_open() const { return sock != INVALID_SOCKET; }
- };
- virtual bool create_and_connect_socket(Socket &socket, Error &error);
- virtual bool ensure_socket_connection(Socket &socket, Error &error);
- // All of:
- // shutdown_ssl
- // shutdown_socket
- // close_socket
- // should ONLY be called when socket_mutex_ is locked.
- // Also, shutdown_ssl and close_socket should also NOT be called concurrently
- // with a DIFFERENT thread sending requests using that socket.
- virtual void shutdown_ssl(Socket &socket, bool shutdown_gracefully);
- void shutdown_socket(Socket &socket) const;
- void close_socket(Socket &socket);
- bool process_request(Stream &strm, Request &req, Response &res,
- bool close_connection, Error &error);
- bool write_content_with_provider(Stream &strm, const Request &req,
- Error &error) const;
- void copy_settings(const ClientImpl &rhs);
- void output_log(const Request &req, const Response &res) const;
- void output_error_log(const Error &err, const Request *req) const;
- // Socket endpoint information
- const std::string host_;
- const int port_;
- // Current open socket
- Socket socket_;
- mutable std::mutex socket_mutex_;
- std::recursive_mutex request_mutex_;
- // These are all protected under socket_mutex
- size_t socket_requests_in_flight_ = 0;
- std::thread::id socket_requests_are_from_thread_ = std::thread::id();
- bool socket_should_be_closed_when_request_is_done_ = false;
- // Hostname-IP map
- std::map<std::string, std::string> addr_map_;
- // Default headers
- Headers default_headers_;
- // Header writer
- std::function<ssize_t(Stream &, Headers &)> header_writer_ =
- detail::write_headers;
- // Settings
- std::string client_cert_path_;
- std::string client_key_path_;
- time_t connection_timeout_sec_ = CPPHTTPLIB_CONNECTION_TIMEOUT_SECOND;
- time_t connection_timeout_usec_ = CPPHTTPLIB_CONNECTION_TIMEOUT_USECOND;
- time_t read_timeout_sec_ = CPPHTTPLIB_CLIENT_READ_TIMEOUT_SECOND;
- time_t read_timeout_usec_ = CPPHTTPLIB_CLIENT_READ_TIMEOUT_USECOND;
- time_t write_timeout_sec_ = CPPHTTPLIB_CLIENT_WRITE_TIMEOUT_SECOND;
- time_t write_timeout_usec_ = CPPHTTPLIB_CLIENT_WRITE_TIMEOUT_USECOND;
- time_t max_timeout_msec_ = CPPHTTPLIB_CLIENT_MAX_TIMEOUT_MSECOND;
- std::string basic_auth_username_;
- std::string basic_auth_password_;
- std::string bearer_token_auth_token_;
- #ifdef CPPHTTPLIB_OPENSSL_SUPPORT
- std::string digest_auth_username_;
- std::string digest_auth_password_;
- #endif
- bool keep_alive_ = false;
- bool follow_location_ = false;
- bool path_encode_ = true;
- int address_family_ = AF_UNSPEC;
- bool tcp_nodelay_ = CPPHTTPLIB_TCP_NODELAY;
- bool ipv6_v6only_ = CPPHTTPLIB_IPV6_V6ONLY;
- SocketOptions socket_options_ = nullptr;
- bool compress_ = false;
- bool decompress_ = true;
- std::string interface_;
- std::string proxy_host_;
- int proxy_port_ = -1;
- std::string proxy_basic_auth_username_;
- std::string proxy_basic_auth_password_;
- std::string proxy_bearer_token_auth_token_;
- #ifdef CPPHTTPLIB_OPENSSL_SUPPORT
- std::string proxy_digest_auth_username_;
- std::string proxy_digest_auth_password_;
- #endif
- #ifdef CPPHTTPLIB_OPENSSL_SUPPORT
- std::string ca_cert_file_path_;
- std::string ca_cert_dir_path_;
- X509_STORE *ca_cert_store_ = nullptr;
- #endif
- #ifdef CPPHTTPLIB_OPENSSL_SUPPORT
- bool server_certificate_verification_ = true;
- bool server_hostname_verification_ = true;
- std::function<SSLVerifierResponse(SSL *ssl)> server_certificate_verifier_;
- #endif
- mutable std::mutex logger_mutex_;
- Logger logger_;
- ErrorLogger error_logger_;
- #ifdef CPPHTTPLIB_OPENSSL_SUPPORT
- int last_ssl_error_ = 0;
- unsigned long last_openssl_error_ = 0;
- #endif
- private:
- bool send_(Request &req, Response &res, Error &error);
- Result send_(Request &&req);
- socket_t create_client_socket(Error &error) const;
- bool read_response_line(Stream &strm, const Request &req,
- Response &res) const;
- bool write_request(Stream &strm, Request &req, bool close_connection,
- Error &error);
- void prepare_default_headers(Request &r, bool for_stream,
- const std::string &ct);
- bool redirect(Request &req, Response &res, Error &error);
- bool create_redirect_client(const std::string &scheme,
- const std::string &host, int port, Request &req,
- Response &res, const std::string &path,
- const std::string &location, Error &error);
- template <typename ClientType> void setup_redirect_client(ClientType &client);
- bool handle_request(Stream &strm, Request &req, Response &res,
- bool close_connection, Error &error);
- std::unique_ptr<Response> send_with_content_provider_and_receiver(
- Request &req, const char *body, size_t content_length,
- ContentProvider content_provider,
- ContentProviderWithoutLength content_provider_without_length,
- const std::string &content_type, ContentReceiver content_receiver,
- Error &error);
- Result send_with_content_provider_and_receiver(
- const std::string &method, const std::string &path,
- const Headers &headers, const char *body, size_t content_length,
- ContentProvider content_provider,
- ContentProviderWithoutLength content_provider_without_length,
- const std::string &content_type, ContentReceiver content_receiver,
- UploadProgress progress);
- ContentProviderWithoutLength get_multipart_content_provider(
- const std::string &boundary, const UploadFormDataItems &items,
- const FormDataProviderItems &provider_items) const;
- virtual bool
- process_socket(const Socket &socket,
- std::chrono::time_point<std::chrono::steady_clock> start_time,
- std::function<bool(Stream &strm)> callback);
- virtual bool is_ssl() const;
- void transfer_socket_ownership_to_handle(StreamHandle &handle);
- };
- class Client {
- public:
- // Universal interface
- explicit Client(const std::string &scheme_host_port);
- explicit Client(const std::string &scheme_host_port,
- const std::string &client_cert_path,
- const std::string &client_key_path);
- // HTTP only interface
- explicit Client(const std::string &host, int port);
- explicit Client(const std::string &host, int port,
- const std::string &client_cert_path,
- const std::string &client_key_path);
- Client(Client &&) = default;
- Client &operator=(Client &&) = default;
- ~Client();
- bool is_valid() const;
- // clang-format off
- Result Get(const std::string &path, DownloadProgress progress = nullptr);
- Result Get(const std::string &path, ContentReceiver content_receiver, DownloadProgress progress = nullptr);
- Result Get(const std::string &path, ResponseHandler response_handler, ContentReceiver content_receiver, DownloadProgress progress = nullptr);
- Result Get(const std::string &path, const Headers &headers, DownloadProgress progress = nullptr);
- Result Get(const std::string &path, const Headers &headers, ContentReceiver content_receiver, DownloadProgress progress = nullptr);
- Result Get(const std::string &path, const Headers &headers, ResponseHandler response_handler, ContentReceiver content_receiver, DownloadProgress progress = nullptr);
- Result Get(const std::string &path, const Params ¶ms, const Headers &headers, DownloadProgress progress = nullptr);
- Result Get(const std::string &path, const Params ¶ms, const Headers &headers, ContentReceiver content_receiver, DownloadProgress progress = nullptr);
- Result Get(const std::string &path, const Params ¶ms, const Headers &headers, ResponseHandler response_handler, ContentReceiver content_receiver, DownloadProgress progress = nullptr);
- Result Head(const std::string &path);
- Result Head(const std::string &path, const Headers &headers);
- Result Post(const std::string &path);
- Result Post(const std::string &path, const char *body, size_t content_length, const std::string &content_type, UploadProgress progress = nullptr);
- Result Post(const std::string &path, const std::string &body, const std::string &content_type, UploadProgress progress = nullptr);
- Result Post(const std::string &path, size_t content_length, ContentProvider content_provider, const std::string &content_type, UploadProgress progress = nullptr);
- Result Post(const std::string &path, size_t content_length, ContentProvider content_provider, const std::string &content_type, ContentReceiver content_receiver, UploadProgress progress = nullptr);
- Result Post(const std::string &path, ContentProviderWithoutLength content_provider, const std::string &content_type, UploadProgress progress = nullptr);
- Result Post(const std::string &path, ContentProviderWithoutLength content_provider, const std::string &content_type, ContentReceiver content_receiver, UploadProgress progress = nullptr);
- Result Post(const std::string &path, const Params ¶ms);
- Result Post(const std::string &path, const UploadFormDataItems &items, UploadProgress progress = nullptr);
- Result Post(const std::string &path, const Headers &headers);
- Result Post(const std::string &path, const Headers &headers, const char *body, size_t content_length, const std::string &content_type, UploadProgress progress = nullptr);
- Result Post(const std::string &path, const Headers &headers, const std::string &body, const std::string &content_type, UploadProgress progress = nullptr);
- Result Post(const std::string &path, const Headers &headers, size_t content_length, ContentProvider content_provider, const std::string &content_type, UploadProgress progress = nullptr);
- Result Post(const std::string &path, const Headers &headers, size_t content_length, ContentProvider content_provider, const std::string &content_type, ContentReceiver content_receiver, DownloadProgress progress = nullptr);
- Result Post(const std::string &path, const Headers &headers, ContentProviderWithoutLength content_provider, const std::string &content_type, UploadProgress progress = nullptr);
- Result Post(const std::string &path, const Headers &headers, ContentProviderWithoutLength content_provider, const std::string &content_type, ContentReceiver content_receiver, DownloadProgress progress = nullptr);
- Result Post(const std::string &path, const Headers &headers, const Params ¶ms);
- Result Post(const std::string &path, const Headers &headers, const UploadFormDataItems &items, UploadProgress progress = nullptr);
- Result Post(const std::string &path, const Headers &headers, const UploadFormDataItems &items, const std::string &boundary, UploadProgress progress = nullptr);
- Result Post(const std::string &path, const Headers &headers, const UploadFormDataItems &items, const FormDataProviderItems &provider_items, UploadProgress progress = nullptr);
- Result Post(const std::string &path, const Headers &headers, const std::string &body, const std::string &content_type, ContentReceiver content_receiver, DownloadProgress progress = nullptr);
- Result Put(const std::string &path);
- Result Put(const std::string &path, const char *body, size_t content_length, const std::string &content_type, UploadProgress progress = nullptr);
- Result Put(const std::string &path, const std::string &body, const std::string &content_type, UploadProgress progress = nullptr);
- Result Put(const std::string &path, size_t content_length, ContentProvider content_provider, const std::string &content_type, UploadProgress progress = nullptr);
- Result Put(const std::string &path, size_t content_length, ContentProvider content_provider, const std::string &content_type, ContentReceiver content_receiver, UploadProgress progress = nullptr);
- Result Put(const std::string &path, ContentProviderWithoutLength content_provider, const std::string &content_type, UploadProgress progress = nullptr);
- Result Put(const std::string &path, ContentProviderWithoutLength content_provider, const std::string &content_type, ContentReceiver content_receiver, UploadProgress progress = nullptr);
- Result Put(const std::string &path, const Params ¶ms);
- Result Put(const std::string &path, const UploadFormDataItems &items, UploadProgress progress = nullptr);
- Result Put(const std::string &path, const Headers &headers);
- Result Put(const std::string &path, const Headers &headers, const char *body, size_t content_length, const std::string &content_type, UploadProgress progress = nullptr);
- Result Put(const std::string &path, const Headers &headers, const std::string &body, const std::string &content_type, UploadProgress progress = nullptr);
- Result Put(const std::string &path, const Headers &headers, size_t content_length, ContentProvider content_provider, const std::string &content_type, UploadProgress progress = nullptr);
- Result Put(const std::string &path, const Headers &headers, size_t content_length, ContentProvider content_provider, const std::string &content_type, ContentReceiver content_receiver, UploadProgress progress = nullptr);
- Result Put(const std::string &path, const Headers &headers, ContentProviderWithoutLength content_provider, const std::string &content_type, UploadProgress progress = nullptr);
- Result Put(const std::string &path, const Headers &headers, ContentProviderWithoutLength content_provider, const std::string &content_type, ContentReceiver content_receiver, UploadProgress progress = nullptr);
- Result Put(const std::string &path, const Headers &headers, const Params ¶ms);
- Result Put(const std::string &path, const Headers &headers, const UploadFormDataItems &items, UploadProgress progress = nullptr);
- Result Put(const std::string &path, const Headers &headers, const UploadFormDataItems &items, const std::string &boundary, UploadProgress progress = nullptr);
- Result Put(const std::string &path, const Headers &headers, const UploadFormDataItems &items, const FormDataProviderItems &provider_items, UploadProgress progress = nullptr);
- Result Put(const std::string &path, const Headers &headers, const std::string &body, const std::string &content_type, ContentReceiver content_receiver, DownloadProgress progress = nullptr);
- Result Patch(const std::string &path);
- Result Patch(const std::string &path, const char *body, size_t content_length, const std::string &content_type, UploadProgress progress = nullptr);
- Result Patch(const std::string &path, const std::string &body, const std::string &content_type, UploadProgress progress = nullptr);
- Result Patch(const std::string &path, size_t content_length, ContentProvider content_provider, const std::string &content_type, UploadProgress progress = nullptr);
- Result Patch(const std::string &path, size_t content_length, ContentProvider content_provider, const std::string &content_type, ContentReceiver content_receiver, UploadProgress progress = nullptr);
- Result Patch(const std::string &path, ContentProviderWithoutLength content_provider, const std::string &content_type, UploadProgress progress = nullptr);
- Result Patch(const std::string &path, ContentProviderWithoutLength content_provider, const std::string &content_type, ContentReceiver content_receiver, UploadProgress progress = nullptr);
- Result Patch(const std::string &path, const Params ¶ms);
- Result Patch(const std::string &path, const UploadFormDataItems &items, UploadProgress progress = nullptr);
- Result Patch(const std::string &path, const Headers &headers);
- Result Patch(const std::string &path, const Headers &headers, const char *body, size_t content_length, const std::string &content_type, UploadProgress progress = nullptr);
- Result Patch(const std::string &path, const Headers &headers, const std::string &body, const std::string &content_type, UploadProgress progress = nullptr);
- Result Patch(const std::string &path, const Headers &headers, size_t content_length, ContentProvider content_provider, const std::string &content_type, UploadProgress progress = nullptr);
- Result Patch(const std::string &path, const Headers &headers, size_t content_length, ContentProvider content_provider, const std::string &content_type, ContentReceiver content_receiver, UploadProgress progress = nullptr);
- Result Patch(const std::string &path, const Headers &headers, ContentProviderWithoutLength content_provider, const std::string &content_type, UploadProgress progress = nullptr);
- Result Patch(const std::string &path, const Headers &headers, ContentProviderWithoutLength content_provider, const std::string &content_type, ContentReceiver content_receiver, UploadProgress progress = nullptr);
- Result Patch(const std::string &path, const Headers &headers, const Params ¶ms);
- Result Patch(const std::string &path, const Headers &headers, const UploadFormDataItems &items, UploadProgress progress = nullptr);
- Result Patch(const std::string &path, const Headers &headers, const UploadFormDataItems &items, const std::string &boundary, UploadProgress progress = nullptr);
- Result Patch(const std::string &path, const Headers &headers, const UploadFormDataItems &items, const FormDataProviderItems &provider_items, UploadProgress progress = nullptr);
- Result Patch(const std::string &path, const Headers &headers, const std::string &body, const std::string &content_type, ContentReceiver content_receiver, DownloadProgress progress = nullptr);
- Result Delete(const std::string &path, DownloadProgress progress = nullptr);
- Result Delete(const std::string &path, const char *body, size_t content_length, const std::string &content_type, DownloadProgress progress = nullptr);
- Result Delete(const std::string &path, const std::string &body, const std::string &content_type, DownloadProgress progress = nullptr);
- Result Delete(const std::string &path, const Params ¶ms, DownloadProgress progress = nullptr);
- Result Delete(const std::string &path, const Headers &headers, DownloadProgress progress = nullptr);
- Result Delete(const std::string &path, const Headers &headers, const char *body, size_t content_length, const std::string &content_type, DownloadProgress progress = nullptr);
- Result Delete(const std::string &path, const Headers &headers, const std::string &body, const std::string &content_type, DownloadProgress progress = nullptr);
- Result Delete(const std::string &path, const Headers &headers, const Params ¶ms, DownloadProgress progress = nullptr);
- Result Options(const std::string &path);
- Result Options(const std::string &path, const Headers &headers);
- // clang-format on
- // Streaming API: Open a stream for reading response body incrementally
- // Socket ownership is transferred to StreamHandle for true streaming
- // Supports all HTTP methods (GET, POST, PUT, PATCH, DELETE, etc.)
- ClientImpl::StreamHandle open_stream(const std::string &method,
- const std::string &path,
- const Params ¶ms = {},
- const Headers &headers = {},
- const std::string &body = {},
- const std::string &content_type = {});
- bool send(Request &req, Response &res, Error &error);
- Result send(const Request &req);
- void stop();
- std::string host() const;
- int port() const;
- size_t is_socket_open() const;
- socket_t socket() const;
- void set_hostname_addr_map(std::map<std::string, std::string> addr_map);
- void set_default_headers(Headers headers);
- void
- set_header_writer(std::function<ssize_t(Stream &, Headers &)> const &writer);
- void set_address_family(int family);
- void set_tcp_nodelay(bool on);
- void set_socket_options(SocketOptions socket_options);
- void set_connection_timeout(time_t sec, time_t usec = 0);
- template <class Rep, class Period>
- void
- set_connection_timeout(const std::chrono::duration<Rep, Period> &duration);
- void set_read_timeout(time_t sec, time_t usec = 0);
- template <class Rep, class Period>
- void set_read_timeout(const std::chrono::duration<Rep, Period> &duration);
- void set_write_timeout(time_t sec, time_t usec = 0);
- template <class Rep, class Period>
- void set_write_timeout(const std::chrono::duration<Rep, Period> &duration);
- void set_max_timeout(time_t msec);
- template <class Rep, class Period>
- void set_max_timeout(const std::chrono::duration<Rep, Period> &duration);
- void set_basic_auth(const std::string &username, const std::string &password);
- void set_bearer_token_auth(const std::string &token);
- #ifdef CPPHTTPLIB_OPENSSL_SUPPORT
- void set_digest_auth(const std::string &username,
- const std::string &password);
- #endif
- void set_keep_alive(bool on);
- void set_follow_location(bool on);
- void set_path_encode(bool on);
- void set_url_encode(bool on);
- void set_compress(bool on);
- void set_decompress(bool on);
- void set_interface(const std::string &intf);
- void set_proxy(const std::string &host, int port);
- void set_proxy_basic_auth(const std::string &username,
- const std::string &password);
- void set_proxy_bearer_token_auth(const std::string &token);
- #ifdef CPPHTTPLIB_OPENSSL_SUPPORT
- void set_proxy_digest_auth(const std::string &username,
- const std::string &password);
- #endif
- #ifdef CPPHTTPLIB_OPENSSL_SUPPORT
- void enable_server_certificate_verification(bool enabled);
- void enable_server_hostname_verification(bool enabled);
- void set_server_certificate_verifier(
- std::function<SSLVerifierResponse(SSL *ssl)> verifier);
- #endif
- void set_logger(Logger logger);
- void set_error_logger(ErrorLogger error_logger);
- // SSL
- #ifdef CPPHTTPLIB_OPENSSL_SUPPORT
- void set_ca_cert_path(const std::string &ca_cert_file_path,
- const std::string &ca_cert_dir_path = std::string());
- void set_ca_cert_store(X509_STORE *ca_cert_store);
- void load_ca_cert_store(const char *ca_cert, std::size_t size);
- long get_openssl_verify_result() const;
- SSL_CTX *ssl_context() const;
- #endif
- private:
- std::unique_ptr<ClientImpl> cli_;
- #ifdef CPPHTTPLIB_OPENSSL_SUPPORT
- bool is_ssl_ = false;
- #endif
- };
- #ifdef CPPHTTPLIB_OPENSSL_SUPPORT
- class SSLServer : public Server {
- public:
- SSLServer(const char *cert_path, const char *private_key_path,
- const char *client_ca_cert_file_path = nullptr,
- const char *client_ca_cert_dir_path = nullptr,
- const char *private_key_password = nullptr);
- SSLServer(X509 *cert, EVP_PKEY *private_key,
- X509_STORE *client_ca_cert_store = nullptr);
- SSLServer(
- const std::function<bool(SSL_CTX &ssl_ctx)> &setup_ssl_ctx_callback);
- ~SSLServer() override;
- bool is_valid() const override;
- SSL_CTX *ssl_context() const;
- void update_certs(X509 *cert, EVP_PKEY *private_key,
- X509_STORE *client_ca_cert_store = nullptr);
- int ssl_last_error() const { return last_ssl_error_; }
- private:
- bool process_and_close_socket(socket_t sock) override;
- STACK_OF(X509_NAME) * extract_ca_names_from_x509_store(X509_STORE *store);
- SSL_CTX *ctx_;
- std::mutex ctx_mutex_;
- int last_ssl_error_ = 0;
- };
- class SSLClient final : public ClientImpl {
- public:
- explicit SSLClient(const std::string &host);
- explicit SSLClient(const std::string &host, int port);
- explicit SSLClient(const std::string &host, int port,
- const std::string &client_cert_path,
- const std::string &client_key_path,
- const std::string &private_key_password = std::string());
- explicit SSLClient(const std::string &host, int port, X509 *client_cert,
- EVP_PKEY *client_key,
- const std::string &private_key_password = std::string());
- ~SSLClient() override;
- bool is_valid() const override;
- void set_ca_cert_store(X509_STORE *ca_cert_store);
- void load_ca_cert_store(const char *ca_cert, std::size_t size);
- long get_openssl_verify_result() const;
- SSL_CTX *ssl_context() const;
- private:
- bool create_and_connect_socket(Socket &socket, Error &error) override;
- bool ensure_socket_connection(Socket &socket, Error &error) override;
- void shutdown_ssl(Socket &socket, bool shutdown_gracefully) override;
- void shutdown_ssl_impl(Socket &socket, bool shutdown_gracefully);
- bool
- process_socket(const Socket &socket,
- std::chrono::time_point<std::chrono::steady_clock> start_time,
- std::function<bool(Stream &strm)> callback) override;
- bool is_ssl() const override;
- bool connect_with_proxy(
- Socket &sock,
- std::chrono::time_point<std::chrono::steady_clock> start_time,
- Response &res, bool &success, Error &error);
- bool initialize_ssl(Socket &socket, Error &error);
- bool load_certs();
- bool verify_host(X509 *server_cert) const;
- bool verify_host_with_subject_alt_name(X509 *server_cert) const;
- bool verify_host_with_common_name(X509 *server_cert) const;
- bool check_host_name(const char *pattern, size_t pattern_len) const;
- SSL_CTX *ctx_;
- std::mutex ctx_mutex_;
- std::once_flag initialize_cert_;
- std::vector<std::string> host_components_;
- long verify_result_ = 0;
- friend class ClientImpl;
- };
- #endif
- /*
- * Implementation of template methods.
- */
- namespace detail {
- template <typename T, typename U>
- inline void duration_to_sec_and_usec(const T &duration, U callback) {
- auto sec = std::chrono::duration_cast<std::chrono::seconds>(duration).count();
- auto usec = std::chrono::duration_cast<std::chrono::microseconds>(
- duration - std::chrono::seconds(sec))
- .count();
- callback(static_cast<time_t>(sec), static_cast<time_t>(usec));
- }
- template <size_t N> inline constexpr size_t str_len(const char (&)[N]) {
- return N - 1;
- }
- inline bool is_numeric(const std::string &str) {
- return !str.empty() &&
- std::all_of(str.cbegin(), str.cend(),
- [](unsigned char c) { return std::isdigit(c); });
- }
- inline size_t get_header_value_u64(const Headers &headers,
- const std::string &key, size_t def,
- size_t id, bool &is_invalid_value) {
- is_invalid_value = false;
- auto rng = headers.equal_range(key);
- auto it = rng.first;
- std::advance(it, static_cast<ssize_t>(id));
- if (it != rng.second) {
- if (is_numeric(it->second)) {
- return std::strtoull(it->second.data(), nullptr, 10);
- } else {
- is_invalid_value = true;
- }
- }
- return def;
- }
- inline size_t get_header_value_u64(const Headers &headers,
- const std::string &key, size_t def,
- size_t id) {
- auto dummy = false;
- return get_header_value_u64(headers, key, def, id, dummy);
- }
- } // namespace detail
- inline size_t Request::get_header_value_u64(const std::string &key, size_t def,
- size_t id) const {
- return detail::get_header_value_u64(headers, key, def, id);
- }
- inline size_t Response::get_header_value_u64(const std::string &key, size_t def,
- size_t id) const {
- return detail::get_header_value_u64(headers, key, def, id);
- }
- namespace detail {
- inline bool set_socket_opt_impl(socket_t sock, int level, int optname,
- const void *optval, socklen_t optlen) {
- return setsockopt(sock, level, optname,
- #ifdef _WIN32
- reinterpret_cast<const char *>(optval),
- #else
- optval,
- #endif
- optlen) == 0;
- }
- inline bool set_socket_opt(socket_t sock, int level, int optname, int optval) {
- return set_socket_opt_impl(sock, level, optname, &optval, sizeof(optval));
- }
- inline bool set_socket_opt_time(socket_t sock, int level, int optname,
- time_t sec, time_t usec) {
- #ifdef _WIN32
- auto timeout = static_cast<uint32_t>(sec * 1000 + usec / 1000);
- #else
- timeval timeout;
- timeout.tv_sec = static_cast<long>(sec);
- timeout.tv_usec = static_cast<decltype(timeout.tv_usec)>(usec);
- #endif
- return set_socket_opt_impl(sock, level, optname, &timeout, sizeof(timeout));
- }
- } // namespace detail
- inline void default_socket_options(socket_t sock) {
- detail::set_socket_opt(sock, SOL_SOCKET,
- #ifdef SO_REUSEPORT
- SO_REUSEPORT,
- #else
- SO_REUSEADDR,
- #endif
- 1);
- }
- inline std::string get_bearer_token_auth(const Request &req) {
- if (req.has_header("Authorization")) {
- constexpr auto bearer_header_prefix_len = detail::str_len("Bearer ");
- return req.get_header_value("Authorization")
- .substr(bearer_header_prefix_len);
- }
- return "";
- }
- template <class Rep, class Period>
- inline Server &
- Server::set_read_timeout(const std::chrono::duration<Rep, Period> &duration) {
- detail::duration_to_sec_and_usec(
- duration, [&](time_t sec, time_t usec) { set_read_timeout(sec, usec); });
- return *this;
- }
- template <class Rep, class Period>
- inline Server &
- Server::set_write_timeout(const std::chrono::duration<Rep, Period> &duration) {
- detail::duration_to_sec_and_usec(
- duration, [&](time_t sec, time_t usec) { set_write_timeout(sec, usec); });
- return *this;
- }
- template <class Rep, class Period>
- inline Server &
- Server::set_idle_interval(const std::chrono::duration<Rep, Period> &duration) {
- detail::duration_to_sec_and_usec(
- duration, [&](time_t sec, time_t usec) { set_idle_interval(sec, usec); });
- return *this;
- }
- inline size_t Result::get_request_header_value_u64(const std::string &key,
- size_t def,
- size_t id) const {
- return detail::get_header_value_u64(request_headers_, key, def, id);
- }
- template <class Rep, class Period>
- inline void ClientImpl::set_connection_timeout(
- const std::chrono::duration<Rep, Period> &duration) {
- detail::duration_to_sec_and_usec(duration, [&](time_t sec, time_t usec) {
- set_connection_timeout(sec, usec);
- });
- }
- template <class Rep, class Period>
- inline void ClientImpl::set_read_timeout(
- const std::chrono::duration<Rep, Period> &duration) {
- detail::duration_to_sec_and_usec(
- duration, [&](time_t sec, time_t usec) { set_read_timeout(sec, usec); });
- }
- template <class Rep, class Period>
- inline void ClientImpl::set_write_timeout(
- const std::chrono::duration<Rep, Period> &duration) {
- detail::duration_to_sec_and_usec(
- duration, [&](time_t sec, time_t usec) { set_write_timeout(sec, usec); });
- }
- template <class Rep, class Period>
- inline void ClientImpl::set_max_timeout(
- const std::chrono::duration<Rep, Period> &duration) {
- auto msec =
- std::chrono::duration_cast<std::chrono::milliseconds>(duration).count();
- set_max_timeout(msec);
- }
- template <class Rep, class Period>
- inline void Client::set_connection_timeout(
- const std::chrono::duration<Rep, Period> &duration) {
- cli_->set_connection_timeout(duration);
- }
- template <class Rep, class Period>
- inline void
- Client::set_read_timeout(const std::chrono::duration<Rep, Period> &duration) {
- cli_->set_read_timeout(duration);
- }
- template <class Rep, class Period>
- inline void
- Client::set_write_timeout(const std::chrono::duration<Rep, Period> &duration) {
- cli_->set_write_timeout(duration);
- }
- inline void Client::set_max_timeout(time_t msec) {
- cli_->set_max_timeout(msec);
- }
- template <class Rep, class Period>
- inline void
- Client::set_max_timeout(const std::chrono::duration<Rep, Period> &duration) {
- cli_->set_max_timeout(duration);
- }
- /*
- * Forward declarations and types that will be part of the .h file if split into
- * .h + .cc.
- */
- std::string hosted_at(const std::string &hostname);
- void hosted_at(const std::string &hostname, std::vector<std::string> &addrs);
- // JavaScript-style URL encoding/decoding functions
- std::string encode_uri_component(const std::string &value);
- std::string encode_uri(const std::string &value);
- std::string decode_uri_component(const std::string &value);
- std::string decode_uri(const std::string &value);
- // RFC 3986 compliant URL component encoding/decoding functions
- std::string encode_path_component(const std::string &component);
- std::string decode_path_component(const std::string &component);
- std::string encode_query_component(const std::string &component,
- bool space_as_plus = true);
- std::string decode_query_component(const std::string &component,
- bool plus_as_space = true);
- std::string append_query_params(const std::string &path, const Params ¶ms);
- std::pair<std::string, std::string> make_range_header(const Ranges &ranges);
- std::pair<std::string, std::string>
- make_basic_authentication_header(const std::string &username,
- const std::string &password,
- bool is_proxy = false);
- namespace detail {
- #if defined(_WIN32)
- inline std::wstring u8string_to_wstring(const char *s) {
- std::wstring ws;
- auto len = static_cast<int>(strlen(s));
- auto wlen = ::MultiByteToWideChar(CP_UTF8, 0, s, len, nullptr, 0);
- if (wlen > 0) {
- ws.resize(wlen);
- wlen = ::MultiByteToWideChar(
- CP_UTF8, 0, s, len,
- const_cast<LPWSTR>(reinterpret_cast<LPCWSTR>(ws.data())), wlen);
- if (wlen != static_cast<int>(ws.size())) { ws.clear(); }
- }
- return ws;
- }
- #endif
- struct FileStat {
- FileStat(const std::string &path);
- bool is_file() const;
- bool is_dir() const;
- time_t mtime() const;
- size_t size() const;
- private:
- #if defined(_WIN32)
- struct _stat st_;
- #else
- struct stat st_;
- #endif
- int ret_ = -1;
- };
- std::string make_host_and_port_string(const std::string &host, int port,
- bool is_ssl);
- std::string trim_copy(const std::string &s);
- void divide(
- const char *data, std::size_t size, char d,
- std::function<void(const char *, std::size_t, const char *, std::size_t)>
- fn);
- void divide(
- const std::string &str, char d,
- std::function<void(const char *, std::size_t, const char *, std::size_t)>
- fn);
- void split(const char *b, const char *e, char d,
- std::function<void(const char *, const char *)> fn);
- void split(const char *b, const char *e, char d, size_t m,
- std::function<void(const char *, const char *)> fn);
- bool process_client_socket(
- socket_t sock, time_t read_timeout_sec, time_t read_timeout_usec,
- time_t write_timeout_sec, time_t write_timeout_usec,
- time_t max_timeout_msec,
- std::chrono::time_point<std::chrono::steady_clock> start_time,
- std::function<bool(Stream &)> callback);
- socket_t create_client_socket(const std::string &host, const std::string &ip,
- int port, int address_family, bool tcp_nodelay,
- bool ipv6_v6only, SocketOptions socket_options,
- time_t connection_timeout_sec,
- time_t connection_timeout_usec,
- time_t read_timeout_sec, time_t read_timeout_usec,
- time_t write_timeout_sec,
- time_t write_timeout_usec,
- const std::string &intf, Error &error);
- const char *get_header_value(const Headers &headers, const std::string &key,
- const char *def, size_t id);
- std::string params_to_query_str(const Params ¶ms);
- void parse_query_text(const char *data, std::size_t size, Params ¶ms);
- void parse_query_text(const std::string &s, Params ¶ms);
- bool parse_multipart_boundary(const std::string &content_type,
- std::string &boundary);
- bool parse_range_header(const std::string &s, Ranges &ranges);
- bool parse_accept_header(const std::string &s,
- std::vector<std::string> &content_types);
- int close_socket(socket_t sock);
- ssize_t send_socket(socket_t sock, const void *ptr, size_t size, int flags);
- ssize_t read_socket(socket_t sock, void *ptr, size_t size, int flags);
- enum class EncodingType { None = 0, Gzip, Brotli, Zstd };
- EncodingType encoding_type(const Request &req, const Response &res);
- class BufferStream final : public Stream {
- public:
- BufferStream() = default;
- ~BufferStream() override = default;
- bool is_readable() const override;
- bool wait_readable() const override;
- bool wait_writable() const override;
- ssize_t read(char *ptr, size_t size) override;
- ssize_t write(const char *ptr, size_t size) override;
- void get_remote_ip_and_port(std::string &ip, int &port) const override;
- void get_local_ip_and_port(std::string &ip, int &port) const override;
- socket_t socket() const override;
- time_t duration() const override;
- const std::string &get_buffer() const;
- private:
- std::string buffer;
- size_t position = 0;
- };
- class compressor {
- public:
- virtual ~compressor() = default;
- typedef std::function<bool(const char *data, size_t data_len)> Callback;
- virtual bool compress(const char *data, size_t data_length, bool last,
- Callback callback) = 0;
- };
- class decompressor {
- public:
- virtual ~decompressor() = default;
- virtual bool is_valid() const = 0;
- typedef std::function<bool(const char *data, size_t data_len)> Callback;
- virtual bool decompress(const char *data, size_t data_length,
- Callback callback) = 0;
- };
- class nocompressor final : public compressor {
- public:
- ~nocompressor() override = default;
- bool compress(const char *data, size_t data_length, bool /*last*/,
- Callback callback) override;
- };
- #ifdef CPPHTTPLIB_ZLIB_SUPPORT
- class gzip_compressor final : public compressor {
- public:
- gzip_compressor();
- ~gzip_compressor() override;
- bool compress(const char *data, size_t data_length, bool last,
- Callback callback) override;
- private:
- bool is_valid_ = false;
- z_stream strm_;
- };
- class gzip_decompressor final : public decompressor {
- public:
- gzip_decompressor();
- ~gzip_decompressor() override;
- bool is_valid() const override;
- bool decompress(const char *data, size_t data_length,
- Callback callback) override;
- private:
- bool is_valid_ = false;
- z_stream strm_;
- };
- #endif
- #ifdef CPPHTTPLIB_BROTLI_SUPPORT
- class brotli_compressor final : public compressor {
- public:
- brotli_compressor();
- ~brotli_compressor();
- bool compress(const char *data, size_t data_length, bool last,
- Callback callback) override;
- private:
- BrotliEncoderState *state_ = nullptr;
- };
- class brotli_decompressor final : public decompressor {
- public:
- brotli_decompressor();
- ~brotli_decompressor();
- bool is_valid() const override;
- bool decompress(const char *data, size_t data_length,
- Callback callback) override;
- private:
- BrotliDecoderResult decoder_r;
- BrotliDecoderState *decoder_s = nullptr;
- };
- #endif
- #ifdef CPPHTTPLIB_ZSTD_SUPPORT
- class zstd_compressor : public compressor {
- public:
- zstd_compressor();
- ~zstd_compressor();
- bool compress(const char *data, size_t data_length, bool last,
- Callback callback) override;
- private:
- ZSTD_CCtx *ctx_ = nullptr;
- };
- class zstd_decompressor : public decompressor {
- public:
- zstd_decompressor();
- ~zstd_decompressor();
- bool is_valid() const override;
- bool decompress(const char *data, size_t data_length,
- Callback callback) override;
- private:
- ZSTD_DCtx *ctx_ = nullptr;
- };
- #endif
- // NOTE: until the read size reaches `fixed_buffer_size`, use `fixed_buffer`
- // to store data. The call can set memory on stack for performance.
- class stream_line_reader {
- public:
- stream_line_reader(Stream &strm, char *fixed_buffer,
- size_t fixed_buffer_size);
- const char *ptr() const;
- size_t size() const;
- bool end_with_crlf() const;
- bool getline();
- private:
- void append(char c);
- Stream &strm_;
- char *fixed_buffer_;
- const size_t fixed_buffer_size_;
- size_t fixed_buffer_used_size_ = 0;
- std::string growable_buffer_;
- };
- bool parse_trailers(stream_line_reader &line_reader, Headers &dest,
- const Headers &src_headers);
- struct ChunkedDecoder {
- Stream &strm;
- size_t chunk_remaining = 0;
- bool finished = false;
- char line_buf[64];
- size_t last_chunk_total = 0;
- size_t last_chunk_offset = 0;
- explicit ChunkedDecoder(Stream &s);
- ssize_t read_payload(char *buf, size_t len, size_t &out_chunk_offset,
- size_t &out_chunk_total);
- bool parse_trailers_into(Headers &dest, const Headers &src_headers);
- };
- class mmap {
- public:
- mmap(const char *path);
- ~mmap();
- bool open(const char *path);
- void close();
- bool is_open() const;
- size_t size() const;
- const char *data() const;
- private:
- #if defined(_WIN32)
- HANDLE hFile_ = NULL;
- HANDLE hMapping_ = NULL;
- #else
- int fd_ = -1;
- #endif
- size_t size_ = 0;
- void *addr_ = nullptr;
- bool is_open_empty_file = false;
- };
- // NOTE: https://www.rfc-editor.org/rfc/rfc9110#section-5
- namespace fields {
- bool is_token_char(char c);
- bool is_token(const std::string &s);
- bool is_field_name(const std::string &s);
- bool is_vchar(char c);
- bool is_obs_text(char c);
- bool is_field_vchar(char c);
- bool is_field_content(const std::string &s);
- bool is_field_value(const std::string &s);
- } // namespace fields
- } // namespace detail
- namespace stream {
- class Result {
- public:
- Result() : chunk_size_(8192) {}
- explicit Result(ClientImpl::StreamHandle &&handle, size_t chunk_size = 8192)
- : handle_(std::move(handle)), chunk_size_(chunk_size) {}
- Result(Result &&other) noexcept
- : handle_(std::move(other.handle_)), buffer_(std::move(other.buffer_)),
- current_size_(other.current_size_), chunk_size_(other.chunk_size_),
- finished_(other.finished_) {
- other.current_size_ = 0;
- other.finished_ = true;
- }
- Result &operator=(Result &&other) noexcept {
- if (this != &other) {
- handle_ = std::move(other.handle_);
- buffer_ = std::move(other.buffer_);
- current_size_ = other.current_size_;
- chunk_size_ = other.chunk_size_;
- finished_ = other.finished_;
- other.current_size_ = 0;
- other.finished_ = true;
- }
- return *this;
- }
- Result(const Result &) = delete;
- Result &operator=(const Result &) = delete;
- // Check if the result is valid (connection succeeded and response received)
- bool is_valid() const { return handle_.is_valid(); }
- explicit operator bool() const { return is_valid(); }
- // Response status code
- int status() const {
- return handle_.response ? handle_.response->status : -1;
- }
- // Response headers
- const Headers &headers() const {
- static const Headers empty_headers;
- return handle_.response ? handle_.response->headers : empty_headers;
- }
- std::string get_header_value(const std::string &key,
- const char *def = "") const {
- return handle_.response ? handle_.response->get_header_value(key, def)
- : def;
- }
- bool has_header(const std::string &key) const {
- return handle_.response ? handle_.response->has_header(key) : false;
- }
- // Error information
- Error error() const { return handle_.error; }
- Error read_error() const { return handle_.get_read_error(); }
- bool has_read_error() const { return handle_.has_read_error(); }
- // Streaming iteration API
- // Call next() to read the next chunk, then access data via data()/size()
- // Returns true if data was read, false when stream is exhausted
- bool next() {
- if (!handle_.is_valid() || finished_) { return false; }
- if (buffer_.size() < chunk_size_) { buffer_.resize(chunk_size_); }
- ssize_t n = handle_.read(&buffer_[0], chunk_size_);
- if (n > 0) {
- current_size_ = static_cast<size_t>(n);
- return true;
- }
- current_size_ = 0;
- finished_ = true;
- return false;
- }
- // Pointer to current chunk data (valid after next() returns true)
- const char *data() const { return buffer_.data(); }
- // Size of current chunk (valid after next() returns true)
- size_t size() const { return current_size_; }
- // Convenience method: read all remaining data into a string
- std::string read_all() {
- std::string result;
- while (next()) {
- result.append(data(), size());
- }
- return result;
- }
- private:
- ClientImpl::StreamHandle handle_;
- std::string buffer_;
- size_t current_size_ = 0;
- size_t chunk_size_;
- bool finished_ = false;
- };
- // GET
- template <typename ClientType>
- inline Result Get(ClientType &cli, const std::string &path,
- size_t chunk_size = 8192) {
- return Result{cli.open_stream("GET", path), chunk_size};
- }
- template <typename ClientType>
- inline Result Get(ClientType &cli, const std::string &path,
- const Headers &headers, size_t chunk_size = 8192) {
- return Result{cli.open_stream("GET", path, {}, headers), chunk_size};
- }
- template <typename ClientType>
- inline Result Get(ClientType &cli, const std::string &path,
- const Params ¶ms, size_t chunk_size = 8192) {
- return Result{cli.open_stream("GET", path, params), chunk_size};
- }
- template <typename ClientType>
- inline Result Get(ClientType &cli, const std::string &path,
- const Params ¶ms, const Headers &headers,
- size_t chunk_size = 8192) {
- return Result{cli.open_stream("GET", path, params, headers), chunk_size};
- }
- // POST
- template <typename ClientType>
- inline Result Post(ClientType &cli, const std::string &path,
- const std::string &body, const std::string &content_type,
- size_t chunk_size = 8192) {
- return Result{cli.open_stream("POST", path, {}, {}, body, content_type),
- chunk_size};
- }
- template <typename ClientType>
- inline Result Post(ClientType &cli, const std::string &path,
- const Headers &headers, const std::string &body,
- const std::string &content_type, size_t chunk_size = 8192) {
- return Result{cli.open_stream("POST", path, {}, headers, body, content_type),
- chunk_size};
- }
- template <typename ClientType>
- inline Result Post(ClientType &cli, const std::string &path,
- const Params ¶ms, const std::string &body,
- const std::string &content_type, size_t chunk_size = 8192) {
- return Result{cli.open_stream("POST", path, params, {}, body, content_type),
- chunk_size};
- }
- template <typename ClientType>
- inline Result Post(ClientType &cli, const std::string &path,
- const Params ¶ms, const Headers &headers,
- const std::string &body, const std::string &content_type,
- size_t chunk_size = 8192) {
- return Result{
- cli.open_stream("POST", path, params, headers, body, content_type),
- chunk_size};
- }
- // PUT
- template <typename ClientType>
- inline Result Put(ClientType &cli, const std::string &path,
- const std::string &body, const std::string &content_type,
- size_t chunk_size = 8192) {
- return Result{cli.open_stream("PUT", path, {}, {}, body, content_type),
- chunk_size};
- }
- template <typename ClientType>
- inline Result Put(ClientType &cli, const std::string &path,
- const Headers &headers, const std::string &body,
- const std::string &content_type, size_t chunk_size = 8192) {
- return Result{cli.open_stream("PUT", path, {}, headers, body, content_type),
- chunk_size};
- }
- template <typename ClientType>
- inline Result Put(ClientType &cli, const std::string &path,
- const Params ¶ms, const std::string &body,
- const std::string &content_type, size_t chunk_size = 8192) {
- return Result{cli.open_stream("PUT", path, params, {}, body, content_type),
- chunk_size};
- }
- template <typename ClientType>
- inline Result Put(ClientType &cli, const std::string &path,
- const Params ¶ms, const Headers &headers,
- const std::string &body, const std::string &content_type,
- size_t chunk_size = 8192) {
- return Result{
- cli.open_stream("PUT", path, params, headers, body, content_type),
- chunk_size};
- }
- // PATCH
- template <typename ClientType>
- inline Result Patch(ClientType &cli, const std::string &path,
- const std::string &body, const std::string &content_type,
- size_t chunk_size = 8192) {
- return Result{cli.open_stream("PATCH", path, {}, {}, body, content_type),
- chunk_size};
- }
- template <typename ClientType>
- inline Result Patch(ClientType &cli, const std::string &path,
- const Headers &headers, const std::string &body,
- const std::string &content_type, size_t chunk_size = 8192) {
- return Result{cli.open_stream("PATCH", path, {}, headers, body, content_type),
- chunk_size};
- }
- template <typename ClientType>
- inline Result Patch(ClientType &cli, const std::string &path,
- const Params ¶ms, const std::string &body,
- const std::string &content_type, size_t chunk_size = 8192) {
- return Result{cli.open_stream("PATCH", path, params, {}, body, content_type),
- chunk_size};
- }
- template <typename ClientType>
- inline Result Patch(ClientType &cli, const std::string &path,
- const Params ¶ms, const Headers &headers,
- const std::string &body, const std::string &content_type,
- size_t chunk_size = 8192) {
- return Result{
- cli.open_stream("PATCH", path, params, headers, body, content_type),
- chunk_size};
- }
- // DELETE
- template <typename ClientType>
- inline Result Delete(ClientType &cli, const std::string &path,
- size_t chunk_size = 8192) {
- return Result{cli.open_stream("DELETE", path), chunk_size};
- }
- template <typename ClientType>
- inline Result Delete(ClientType &cli, const std::string &path,
- const Headers &headers, size_t chunk_size = 8192) {
- return Result{cli.open_stream("DELETE", path, {}, headers), chunk_size};
- }
- template <typename ClientType>
- inline Result Delete(ClientType &cli, const std::string &path,
- const std::string &body, const std::string &content_type,
- size_t chunk_size = 8192) {
- return Result{cli.open_stream("DELETE", path, {}, {}, body, content_type),
- chunk_size};
- }
- template <typename ClientType>
- inline Result Delete(ClientType &cli, const std::string &path,
- const Headers &headers, const std::string &body,
- const std::string &content_type,
- size_t chunk_size = 8192) {
- return Result{
- cli.open_stream("DELETE", path, {}, headers, body, content_type),
- chunk_size};
- }
- template <typename ClientType>
- inline Result Delete(ClientType &cli, const std::string &path,
- const Params ¶ms, size_t chunk_size = 8192) {
- return Result{cli.open_stream("DELETE", path, params), chunk_size};
- }
- template <typename ClientType>
- inline Result Delete(ClientType &cli, const std::string &path,
- const Params ¶ms, const Headers &headers,
- size_t chunk_size = 8192) {
- return Result{cli.open_stream("DELETE", path, params, headers), chunk_size};
- }
- template <typename ClientType>
- inline Result Delete(ClientType &cli, const std::string &path,
- const Params ¶ms, const std::string &body,
- const std::string &content_type,
- size_t chunk_size = 8192) {
- return Result{cli.open_stream("DELETE", path, params, {}, body, content_type),
- chunk_size};
- }
- template <typename ClientType>
- inline Result Delete(ClientType &cli, const std::string &path,
- const Params ¶ms, const Headers &headers,
- const std::string &body, const std::string &content_type,
- size_t chunk_size = 8192) {
- return Result{
- cli.open_stream("DELETE", path, params, headers, body, content_type),
- chunk_size};
- }
- // HEAD
- template <typename ClientType>
- inline Result Head(ClientType &cli, const std::string &path,
- size_t chunk_size = 8192) {
- return Result{cli.open_stream("HEAD", path), chunk_size};
- }
- template <typename ClientType>
- inline Result Head(ClientType &cli, const std::string &path,
- const Headers &headers, size_t chunk_size = 8192) {
- return Result{cli.open_stream("HEAD", path, {}, headers), chunk_size};
- }
- template <typename ClientType>
- inline Result Head(ClientType &cli, const std::string &path,
- const Params ¶ms, size_t chunk_size = 8192) {
- return Result{cli.open_stream("HEAD", path, params), chunk_size};
- }
- template <typename ClientType>
- inline Result Head(ClientType &cli, const std::string &path,
- const Params ¶ms, const Headers &headers,
- size_t chunk_size = 8192) {
- return Result{cli.open_stream("HEAD", path, params, headers), chunk_size};
- }
- // OPTIONS
- template <typename ClientType>
- inline Result Options(ClientType &cli, const std::string &path,
- size_t chunk_size = 8192) {
- return Result{cli.open_stream("OPTIONS", path), chunk_size};
- }
- template <typename ClientType>
- inline Result Options(ClientType &cli, const std::string &path,
- const Headers &headers, size_t chunk_size = 8192) {
- return Result{cli.open_stream("OPTIONS", path, {}, headers), chunk_size};
- }
- template <typename ClientType>
- inline Result Options(ClientType &cli, const std::string &path,
- const Params ¶ms, size_t chunk_size = 8192) {
- return Result{cli.open_stream("OPTIONS", path, params), chunk_size};
- }
- template <typename ClientType>
- inline Result Options(ClientType &cli, const std::string &path,
- const Params ¶ms, const Headers &headers,
- size_t chunk_size = 8192) {
- return Result{cli.open_stream("OPTIONS", path, params, headers), chunk_size};
- }
- } // namespace stream
- namespace sse {
- struct SSEMessage {
- std::string event; // Event type (default: "message")
- std::string data; // Event payload
- std::string id; // Event ID for Last-Event-ID header
- SSEMessage() : event("message") {}
- void clear() {
- event = "message";
- data.clear();
- id.clear();
- }
- };
- class SSEClient {
- public:
- using MessageHandler = std::function<void(const SSEMessage &)>;
- using ErrorHandler = std::function<void(Error)>;
- using OpenHandler = std::function<void()>;
- SSEClient(Client &client, const std::string &path)
- : client_(client), path_(path) {}
- SSEClient(Client &client, const std::string &path, const Headers &headers)
- : client_(client), path_(path), headers_(headers) {}
- ~SSEClient() { stop(); }
- SSEClient(const SSEClient &) = delete;
- SSEClient &operator=(const SSEClient &) = delete;
- // Event handlers
- SSEClient &on_message(MessageHandler handler) {
- on_message_ = std::move(handler);
- return *this;
- }
- SSEClient &on_event(const std::string &type, MessageHandler handler) {
- event_handlers_[type] = std::move(handler);
- return *this;
- }
- SSEClient &on_open(OpenHandler handler) {
- on_open_ = std::move(handler);
- return *this;
- }
- SSEClient &on_error(ErrorHandler handler) {
- on_error_ = std::move(handler);
- return *this;
- }
- SSEClient &set_reconnect_interval(int ms) {
- reconnect_interval_ms_ = ms;
- return *this;
- }
- SSEClient &set_max_reconnect_attempts(int n) {
- max_reconnect_attempts_ = n;
- return *this;
- }
- // State accessors
- bool is_connected() const { return connected_.load(); }
- const std::string &last_event_id() const { return last_event_id_; }
- // Blocking start - runs event loop with auto-reconnect
- void start() {
- running_.store(true);
- run_event_loop();
- }
- // Non-blocking start - runs in background thread
- void start_async() {
- running_.store(true);
- async_thread_ = std::thread([this]() { run_event_loop(); });
- }
- // Stop the client (thread-safe)
- void stop() {
- running_.store(false);
- client_.stop(); // Cancel any pending operations
- if (async_thread_.joinable()) { async_thread_.join(); }
- }
- private:
- // Parse a single SSE field line
- // Returns true if this line ends an event (blank line)
- bool parse_sse_line(const std::string &line, SSEMessage &msg, int &retry_ms) {
- // Blank line signals end of event
- if (line.empty() || line == "\r") { return true; }
- // Lines starting with ':' are comments (ignored)
- if (!line.empty() && line[0] == ':') { return false; }
- // Find the colon separator
- auto colon_pos = line.find(':');
- if (colon_pos == std::string::npos) {
- // Line with no colon is treated as field name with empty value
- return false;
- }
- auto field = line.substr(0, colon_pos);
- std::string value;
- // Value starts after colon, skip optional single space
- if (colon_pos + 1 < line.size()) {
- auto value_start = colon_pos + 1;
- if (line[value_start] == ' ') { value_start++; }
- value = line.substr(value_start);
- // Remove trailing \r if present
- if (!value.empty() && value.back() == '\r') { value.pop_back(); }
- }
- // Handle known fields
- if (field == "event") {
- msg.event = value;
- } else if (field == "data") {
- // Multiple data lines are concatenated with newlines
- if (!msg.data.empty()) { msg.data += "\n"; }
- msg.data += value;
- } else if (field == "id") {
- // Empty id is valid (clears the last event ID)
- msg.id = value;
- } else if (field == "retry") {
- // Parse retry interval in milliseconds
- try {
- retry_ms = std::stoi(value);
- } catch (...) {
- // Invalid retry value, ignore
- }
- }
- // Unknown fields are ignored per SSE spec
- return false;
- }
- // Main event loop with auto-reconnect
- void run_event_loop() {
- auto reconnect_count = 0;
- while (running_.load()) {
- // Build headers, including Last-Event-ID if we have one
- auto request_headers = headers_;
- if (!last_event_id_.empty()) {
- request_headers.emplace("Last-Event-ID", last_event_id_);
- }
- // Open streaming connection
- auto result = stream::Get(client_, path_, request_headers);
- // Connection error handling
- if (!result) {
- connected_.store(false);
- if (on_error_) { on_error_(result.error()); }
- if (!should_reconnect(reconnect_count)) { break; }
- wait_for_reconnect();
- reconnect_count++;
- continue;
- }
- if (result.status() != 200) {
- connected_.store(false);
- // For certain errors, don't reconnect
- if (result.status() == 204 || // No Content - server wants us to stop
- result.status() == 404 || // Not Found
- result.status() == 401 || // Unauthorized
- result.status() == 403) { // Forbidden
- if (on_error_) { on_error_(Error::Connection); }
- break;
- }
- if (on_error_) { on_error_(Error::Connection); }
- if (!should_reconnect(reconnect_count)) { break; }
- wait_for_reconnect();
- reconnect_count++;
- continue;
- }
- // Connection successful
- connected_.store(true);
- reconnect_count = 0;
- if (on_open_) { on_open_(); }
- // Event receiving loop
- std::string buffer;
- SSEMessage current_msg;
- while (running_.load() && result.next()) {
- buffer.append(result.data(), result.size());
- // Process complete lines in the buffer
- size_t line_start = 0;
- size_t newline_pos;
- while ((newline_pos = buffer.find('\n', line_start)) !=
- std::string::npos) {
- auto line = buffer.substr(line_start, newline_pos - line_start);
- line_start = newline_pos + 1;
- // Parse the line and check if event is complete
- auto event_complete =
- parse_sse_line(line, current_msg, reconnect_interval_ms_);
- if (event_complete && !current_msg.data.empty()) {
- // Update last_event_id for reconnection
- if (!current_msg.id.empty()) { last_event_id_ = current_msg.id; }
- // Dispatch event to appropriate handler
- dispatch_event(current_msg);
- current_msg.clear();
- }
- }
- // Keep unprocessed data in buffer
- buffer.erase(0, line_start);
- }
- // Connection ended
- connected_.store(false);
- if (!running_.load()) { break; }
- // Check for read errors
- if (result.has_read_error()) {
- if (on_error_) { on_error_(result.read_error()); }
- }
- if (!should_reconnect(reconnect_count)) { break; }
- wait_for_reconnect();
- reconnect_count++;
- }
- connected_.store(false);
- }
- // Dispatch event to appropriate handler
- void dispatch_event(const SSEMessage &msg) {
- // Check for specific event type handler first
- auto it = event_handlers_.find(msg.event);
- if (it != event_handlers_.end()) {
- it->second(msg);
- return;
- }
- // Fall back to generic message handler
- if (on_message_) { on_message_(msg); }
- }
- // Check if we should attempt to reconnect
- bool should_reconnect(int count) const {
- if (!running_.load()) { return false; }
- if (max_reconnect_attempts_ == 0) { return true; } // unlimited
- return count < max_reconnect_attempts_;
- }
- // Wait for reconnect interval
- void wait_for_reconnect() {
- // Use small increments to check running_ flag frequently
- auto waited = 0;
- while (running_.load() && waited < reconnect_interval_ms_) {
- std::this_thread::sleep_for(std::chrono::milliseconds(100));
- waited += 100;
- }
- }
- // Client and path
- Client &client_;
- std::string path_;
- Headers headers_;
- // Callbacks
- MessageHandler on_message_;
- std::map<std::string, MessageHandler> event_handlers_;
- OpenHandler on_open_;
- ErrorHandler on_error_;
- // Configuration
- int reconnect_interval_ms_ = 3000;
- int max_reconnect_attempts_ = 0; // 0 = unlimited
- // State
- std::atomic<bool> running_{false};
- std::atomic<bool> connected_{false};
- std::string last_event_id_;
- // Async support
- std::thread async_thread_;
- };
- } // namespace sse
- } // namespace httplib
- #endif // CPPHTTPLIB_HTTPLIB_H
|