| 12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970717273747576777879808182838485868788899091929394959697989910010110210310410510610710810911011111211311411511611711811912012112212312412512612712812913013113213313413513613713813914014114214314414514614714814915015115215315415515615715815916016116216316416516616716816917017117217317417517617717817918018118218318418518618718818919019119219319419519619719819920020120220320420520620720820921021121221321421521621721821922022122222322422522622722822923023123223323423523623723823924024124224324424524624724824925025125225325425525625725825926026126226326426526626726826927027127227327427527627727827928028128228328428528628728828929029129229329429529629729829930030130230330430530630730830931031131231331431531631731831932032132232332432532632732832933033133233333433533633733833934034134234334434534634734834935035135235335435535635735835936036136236336436536636736836937037137237337437537637737837938038138238338438538638738838939039139239339439539639739839940040140240340440540640740840941041141241341441541641741841942042142242342442542642742842943043143243343443543643743843944044144244344444544644744844945045145245345445545645745845946046146246346446546646746846947047147247347447547647747847948048148248348448548648748848949049149249349449549649749849950050150250350450550650750850951051151251351451551651751851952052152252352452552652752852953053153253353453553653753853954054154254354454554654754854955055155255355455555655755855956056156256356456556656756856957057157257357457557657757857958058158258358458558658758858959059159259359459559659759859960060160260360460560660760860961061161261361461561661761861962062162262362462562662762862963063163263363463563663763863964064164264364464564664764864965065165265365465565665765865966066166266366466566666766866967067167267367467567667767867968068168268368468568668768868969069169269369469569669769869970070170270370470570670770870971071171271371471571671771871972072172272372472572672772872973073173273373473573673773873974074174274374474574674774874975075175275375475575675775875976076176276376476576676776876977077177277377477577677777877978078178278378478578678778878979079179279379479579679779879980080180280380480580680780880981081181281381481581681781881982082182282382482582682782882983083183283383483583683783883984084184284384484584684784884985085185285385485585685785885986086186286386486586686786886987087187287387487587687787887988088188288388488588688788888989089189289389489589689789889990090190290390490590690790890991091191291391491591691791891992092192292392492592692792892993093193293393493593693793893994094194294394494594694794894995095195295395495595695795895996096196296396496596696796896997097197297397497597697797897998098198298398498598698798898999099199299399499599699799899910001001100210031004100510061007100810091010101110121013101410151016101710181019102010211022102310241025102610271028102910301031103210331034103510361037103810391040104110421043104410451046104710481049105010511052105310541055105610571058105910601061106210631064106510661067106810691070107110721073107410751076107710781079108010811082108310841085108610871088108910901091109210931094109510961097109810991100110111021103110411051106110711081109111011111112111311141115111611171118111911201121112211231124112511261127112811291130113111321133113411351136113711381139114011411142114311441145114611471148114911501151115211531154115511561157115811591160116111621163116411651166116711681169117011711172117311741175117611771178117911801181118211831184118511861187118811891190119111921193119411951196119711981199120012011202120312041205120612071208120912101211121212131214121512161217121812191220122112221223122412251226122712281229123012311232123312341235123612371238123912401241124212431244124512461247124812491250125112521253125412551256125712581259126012611262126312641265126612671268126912701271127212731274127512761277127812791280128112821283128412851286128712881289129012911292129312941295129612971298129913001301130213031304130513061307130813091310131113121313131413151316131713181319132013211322132313241325132613271328132913301331133213331334133513361337133813391340134113421343134413451346134713481349135013511352135313541355135613571358135913601361136213631364136513661367136813691370137113721373137413751376137713781379138013811382138313841385138613871388138913901391139213931394139513961397139813991400140114021403140414051406140714081409141014111412141314141415141614171418141914201421142214231424142514261427142814291430143114321433143414351436143714381439144014411442144314441445144614471448144914501451145214531454145514561457145814591460146114621463146414651466146714681469147014711472147314741475147614771478147914801481148214831484148514861487148814891490149114921493149414951496149714981499150015011502150315041505150615071508150915101511151215131514151515161517151815191520152115221523152415251526152715281529153015311532153315341535153615371538153915401541154215431544154515461547154815491550155115521553155415551556155715581559156015611562156315641565156615671568156915701571157215731574157515761577157815791580158115821583158415851586158715881589159015911592159315941595159615971598159916001601160216031604160516061607160816091610161116121613161416151616161716181619162016211622162316241625162616271628162916301631163216331634163516361637163816391640164116421643164416451646164716481649165016511652165316541655165616571658165916601661166216631664166516661667166816691670167116721673167416751676167716781679168016811682168316841685168616871688168916901691169216931694169516961697169816991700170117021703170417051706170717081709171017111712171317141715171617171718171917201721172217231724172517261727172817291730173117321733173417351736173717381739174017411742174317441745174617471748174917501751175217531754175517561757175817591760176117621763176417651766176717681769177017711772177317741775177617771778177917801781178217831784178517861787178817891790179117921793179417951796179717981799180018011802180318041805180618071808180918101811181218131814181518161817181818191820182118221823182418251826182718281829183018311832183318341835183618371838183918401841184218431844184518461847184818491850185118521853185418551856185718581859186018611862186318641865186618671868186918701871187218731874187518761877187818791880188118821883188418851886188718881889189018911892189318941895189618971898189919001901190219031904190519061907190819091910191119121913191419151916191719181919192019211922192319241925192619271928192919301931193219331934193519361937193819391940194119421943194419451946194719481949195019511952195319541955195619571958195919601961196219631964196519661967196819691970197119721973197419751976197719781979198019811982198319841985198619871988198919901991199219931994199519961997199819992000200120022003200420052006200720082009201020112012201320142015201620172018201920202021202220232024202520262027202820292030203120322033203420352036203720382039204020412042204320442045204620472048204920502051205220532054205520562057205820592060206120622063206420652066206720682069207020712072207320742075207620772078207920802081208220832084208520862087208820892090209120922093209420952096209720982099210021012102210321042105210621072108210921102111211221132114211521162117211821192120212121222123212421252126212721282129213021312132213321342135213621372138213921402141214221432144214521462147214821492150215121522153215421552156215721582159216021612162216321642165216621672168216921702171217221732174217521762177217821792180218121822183218421852186218721882189219021912192219321942195219621972198219922002201220222032204220522062207220822092210221122122213221422152216221722182219222022212222222322242225222622272228222922302231223222332234223522362237223822392240224122422243224422452246224722482249225022512252225322542255225622572258225922602261226222632264226522662267226822692270227122722273227422752276227722782279228022812282228322842285228622872288228922902291229222932294229522962297229822992300230123022303230423052306230723082309231023112312231323142315231623172318231923202321232223232324232523262327232823292330233123322333233423352336233723382339234023412342234323442345234623472348234923502351235223532354235523562357235823592360236123622363236423652366236723682369237023712372237323742375237623772378237923802381238223832384238523862387238823892390239123922393239423952396239723982399240024012402240324042405240624072408240924102411241224132414241524162417241824192420242124222423242424252426242724282429243024312432243324342435243624372438243924402441244224432444244524462447244824492450245124522453245424552456245724582459246024612462246324642465246624672468246924702471247224732474247524762477247824792480248124822483248424852486248724882489249024912492249324942495249624972498249925002501250225032504250525062507250825092510251125122513251425152516251725182519252025212522252325242525252625272528252925302531253225332534253525362537253825392540254125422543254425452546254725482549255025512552255325542555255625572558255925602561256225632564256525662567256825692570257125722573257425752576257725782579258025812582258325842585258625872588258925902591259225932594259525962597259825992600260126022603260426052606260726082609261026112612261326142615261626172618261926202621262226232624262526262627262826292630263126322633263426352636263726382639264026412642264326442645264626472648264926502651265226532654265526562657265826592660266126622663266426652666266726682669267026712672267326742675267626772678267926802681268226832684268526862687268826892690269126922693269426952696269726982699270027012702270327042705270627072708270927102711271227132714271527162717271827192720272127222723272427252726272727282729273027312732273327342735273627372738273927402741274227432744274527462747274827492750275127522753275427552756275727582759276027612762276327642765276627672768276927702771277227732774277527762777277827792780278127822783278427852786278727882789279027912792279327942795279627972798279928002801280228032804280528062807280828092810281128122813281428152816281728182819282028212822282328242825282628272828282928302831283228332834283528362837283828392840284128422843284428452846284728482849285028512852285328542855285628572858285928602861286228632864286528662867286828692870287128722873287428752876287728782879288028812882288328842885288628872888288928902891289228932894289528962897289828992900290129022903290429052906290729082909291029112912291329142915291629172918291929202921292229232924292529262927292829292930293129322933293429352936293729382939294029412942294329442945294629472948294929502951295229532954295529562957295829592960296129622963296429652966296729682969297029712972297329742975297629772978297929802981298229832984298529862987298829892990299129922993299429952996299729982999300030013002300330043005300630073008300930103011301230133014301530163017301830193020302130223023302430253026302730283029303030313032303330343035303630373038303930403041304230433044304530463047304830493050305130523053305430553056305730583059306030613062306330643065306630673068306930703071307230733074307530763077307830793080308130823083308430853086308730883089309030913092309330943095309630973098309931003101310231033104310531063107310831093110311131123113311431153116311731183119312031213122312331243125312631273128312931303131313231333134313531363137313831393140314131423143314431453146314731483149315031513152315331543155315631573158315931603161316231633164316531663167316831693170317131723173317431753176317731783179318031813182318331843185318631873188318931903191319231933194319531963197319831993200320132023203320432053206320732083209321032113212321332143215321632173218321932203221322232233224322532263227322832293230323132323233323432353236323732383239324032413242324332443245324632473248324932503251325232533254325532563257325832593260326132623263326432653266326732683269327032713272327332743275327632773278327932803281328232833284328532863287328832893290329132923293329432953296329732983299330033013302330333043305330633073308330933103311331233133314331533163317331833193320332133223323332433253326332733283329333033313332333333343335333633373338333933403341334233433344334533463347334833493350335133523353335433553356335733583359336033613362336333643365336633673368336933703371337233733374337533763377337833793380338133823383338433853386338733883389339033913392339333943395339633973398339934003401340234033404340534063407340834093410341134123413341434153416341734183419 |
- //
- // 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.1"
- #define CPPHTTPLIB_VERSION_NUM "0x001E01"
- /*
- * 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")
- #ifndef _SSIZE_T_DEFINED
- using ssize_t = __int64;
- #define _SSIZE_T_DEFINED
- #endif
- #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) {
- if (!s) { return std::wstring(); }
- auto len = static_cast<int>(strlen(s));
- if (!len) { return std::wstring(); }
- auto wlen = ::MultiByteToWideChar(CP_UTF8, 0, s, len, nullptr, 0);
- if (!wlen) { return std::wstring(); }
- std::wstring ws;
- 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
|