Go to the documentation of this file.
31 #ifndef CPL_HTTP_H_INCLUDED
32 #define CPL_HTTP_H_INCLUDED
36 #include "cpl_progress.h"
46 #define CPL_HTTP_MAX_RETRY 0
47 #define CPL_HTTP_RETRY_DELAY 30.0
53 typedef struct {
char **papszHeaders;
55 GByte *pabyData;
int nDataLen;
91 typedef size_t (*CPLHTTPFetchWriteFunc)(
void *pBuffer,
size_t nSize,
size_t nMemb,
void *pWriteArg);
97 GDALProgressFunc pfnProgress,
99 CPLHTTPFetchWriteFunc pfnWrite,
103 int nMaxSimultaneous,
121 const char *pszScope );
123 const char *pszScope );
126 const char* pszPrivateKey,
127 const char* pszClientEmail,
128 const char* pszScope,
136 #if defined(__cplusplus) && !defined(CPL_SUPRESS_CPLUSPLUS)
139 void* CPLHTTPSetOptions(
void *pcurl,
const char *
const* papszOptions);
140 char** CPLHTTPGetOptionsFromEnv();
141 double CPLHTTPGetNewRetryDelay(
int response_code,
double dfOldDelay);
142 void* CPLHTTPIgnoreSigPipe();
143 void CPLHTTPRestoreSigPipeHandler(
void* old_handler);
144 bool CPLMultiPerformWait(
void* hCurlMultiHandle,
int& repeats);
168 ACCESS_TOKEN_FROM_REFRESH,
174 const char* pszClientId,
175 const char* pszClientSecret,
178 const char* pszClientEmail,
179 const char* pszScope,
197 mutable time_t m_nExpirationTime;
215 #endif // __cplusplus
int nDataLen
Definition: cpl_http.h:57
CPLHTTPResult * CPLHTTPFetch(const char *pszURL, CSLConstList papszOptions)
Fetch a document from an url and return in a string.
Definition: cpl_http.cpp:620
const char * CPLReadLineL(VSILFILE *)
Definition: cpl_conv.cpp:630
GByte * pabyData
Definition: cpl_http.h:56
char ** CSLTokenizeString2(const char *pszString, const char *pszDelimiter, int nCSLTFlags)
Definition: cpl_string.cpp:836
unsigned char GByte
Definition: cpl_port.h:213
const char * GetBearer() const
Definition: cpl_google_oauth2.cpp:681
const CPLString & GetPrivateKey() const
Definition: cpl_http.h:189
char * GOA2GetAuthorizationURL(const char *pszScope)
Definition: cpl_google_oauth2.cpp:127
GByte * VSIGetMemFileBuffer(const char *pszFilename, vsi_l_offset *pnDataLength, int bUnlinkAndSeize)
Fetch buffer underlying memory file.
Definition: cpl_vsi_mem.cpp:986
void CPLHTTPDestroyMultiResult(CPLHTTPResult **papsResults, int nCount)
Clean the memory associated with the return value of CPLHTTPMultiFetch()
Definition: cpl_http.cpp:1350
Definition: cpl_http.h:157
int CPLHTTPParseMultipartMime(CPLHTTPResult *psResult)
Parses a MIME multipart message.
Definition: cpl_http.cpp:1965
void CPLHTTPDestroyResult(CPLHTTPResult *psResult)
Clean the memory associated with the return value of CPLHTTPFetch()
Definition: cpl_http.cpp:1932
void CPLHTTPCleanup(void)
Cleanup function to call at application termination.
Definition: cpl_http.cpp:1870
GOA2Manager()
Definition: cpl_google_oauth2.cpp:556
String list class designed around our use of C "char**" string lists.
Definition: cpl_string.h:447
void * CPLCalloc(size_t, size_t)
Definition: cpl_conv.cpp:138
void * VSIRealloc(void *, size_t)
Definition: cpl_vsisimple.cpp:677
const char * CSLFetchNameValueDef(CSLConstList papszStrList, const char *pszName, const char *pszDefault)
Definition: cpl_string.cpp:1646
char ** CSLSetNameValue(char **papszStrList, const char *pszName, const char *pszValue)
Definition: cpl_string.cpp:1877
Definition: cpl_http.cpp:337
bool CPLIsMachinePotentiallyGCEInstance()
Definition: cpl_google_cloud.cpp:110
int CSLCount(CSLConstList papszStrList)
Definition: cpl_string.cpp:147
char * pszContentType
Definition: cpl_http.h:66
Convenient string class based on std::string.
Definition: cpl_string.h:336
void * CPLRealloc(void *, size_t)
Definition: cpl_conv.cpp:225
#define EQUAL(a, b)
Definition: cpl_port.h:559
bool SetAuthFromRefreshToken(const char *pszRefreshToken, const char *pszClientId, const char *pszClientSecret, CSLConstList papszOptions)
Definition: cpl_google_oauth2.cpp:599
int VSIFCloseL(VSILFILE *) EXPERIMENTAL_CPL_WARN_UNUSED_RESULT
Close file.
Definition: cpl_vsil.cpp:928
CPLHTTPResult * CPLHTTPFetchEx(const char *pszURL, CSLConstList papszOptions, GDALProgressFunc pfnProgress, void *pProgressArg, CPLHTTPFetchWriteFunc pfnWrite, void *pWriteArg)
Definition: cpl_http.cpp:636
#define CPLAssert(expr)
Definition: cpl_error.h:182
#define CPL_C_START
Definition: cpl_port.h:335
bool CPLTestBool(const char *pszValue)
Definition: cpl_string.cpp:1526
int nMimePartCount
Definition: cpl_http.h:83
char ** GOA2GetAccessTokenFromCloudEngineVM(CSLConstList papszOptions)
Definition: cpl_google_oauth2.cpp:418
char ** CSLConstList
Definition: cpl_port.h:1184
CPLHTTPResult ** CPLHTTPMultiFetch(const char *const *papszURL, int nURLCount, int nMaxSimultaneous, CSLConstList papszOptions)
Fetch several documents at once.
Definition: cpl_http.cpp:1102
Definition: cpl_http.h:61
GByte * pabyData
Definition: cpl_http.h:77
Definition: cpl_http.cpp:417
#define CPL_C_END
Definition: cpl_port.h:337
void CPLDebug(const char *, const char *,...)
Definition: cpl_error.cpp:544
#define STARTS_WITH(a, b)
Definition: cpl_port.h:568
void * CPLMalloc(size_t)
Definition: cpl_conv.cpp:168
char ** papszHeaders
Definition: cpl_http.h:80
int CPLHTTPEnabled(void)
Return if CPLHTTP services can be useful.
Definition: cpl_http.cpp:1853
const char * CPLSPrintf(const char *fmt,...)
Definition: cpl_string.cpp:977
char ** papszHeaders
Definition: cpl_http.h:54
char ** CSLAddNameValue(char **papszStrList, const char *pszName, const char *pszValue)
Definition: cpl_string.cpp:1838
Definition: cpl_http.h:53
Definition: cpl_multiproc.h:139
void CPLError(CPLErr eErrClass, CPLErrorNum err_no, const char *fmt,...)
Definition: cpl_error.cpp:232
const char * CPLParseNameValue(const char *pszNameValue, char **ppszKey)
Definition: cpl_string.cpp:1754
Definition: cpl_http.cpp:451
GUIntBig vsi_l_offset
Definition: cpl_vsi.h:139
bool SetAuthFromServiceAccount(const char *pszPrivateKey, const char *pszClientEmail, const char *pszScope, CSLConstList papszAdditionalClaims, CSLConstList papszOptions)
Definition: cpl_google_oauth2.cpp:635
void VSIFree(void *)
Definition: cpl_vsisimple.cpp:823
char ** CSLTokenizeStringComplex(const char *pszString, const char *pszDelimiter, int bHonourStrings, int bAllowEmptyTokens)
Definition: cpl_string.cpp:769
#define CPLE_NotSupported
Definition: cpl_error.h:109
AuthMethod
Definition: cpl_http.h:164
bool CPLIsMachineForSureGCEInstance()
Definition: cpl_google_cloud.cpp:58
void CPLSetConfigOption(const char *, const char *)
Definition: cpl_conv.cpp:1830
#define CPL_ARRAYSIZE(array)
Definition: cpl_port.h:1035
char ** GOA2GetAccessTokenFromServiceAccount(const char *pszPrivateKey, const char *pszClientEmail, const char *pszScope, CSLConstList papszAdditionalClaims, CSLConstList papszOptions)
Definition: cpl_google_oauth2.cpp:459
char * GOA2GetAccessToken(const char *pszRefreshToken, const char *pszScope)
Definition: cpl_google_oauth2.cpp:387
bool SetAuthFromGCE(CSLConstList papszOptions)
Definition: cpl_google_oauth2.cpp:574
char * pszErrBuf
Definition: cpl_http.h:69
int nStatus
Definition: cpl_http.h:63
void CSLDestroy(char **papszStrList)
Definition: cpl_string.cpp:200
int nDataLen
Definition: cpl_http.h:72
VSILFILE * VSIFOpenL(const char *, const char *)
Open file.
Definition: cpl_vsil.cpp:818
const char * CSLFetchNameValue(CSLConstList papszStrList, const char *pszName)
Definition: cpl_string.cpp:1674
CPLErr
Definition: cpl_error.h:52
char * GOA2GetRefreshToken(const char *pszAuthToken, const char *pszScope)
Definition: cpl_google_oauth2.cpp:164
const CPLString & GetClientEmail() const
Definition: cpl_http.h:192
Definition: cpl_http.cpp:1074
char * CPLStrdup(const char *)
Definition: cpl_conv.cpp:293
double CPLAtof(const char *)
Definition: cpl_strtod.cpp:117
int nDataAlloc
Definition: cpl_http.h:74
CPLMimePart * pasMimePart
Definition: cpl_http.h:86
#define CPLE_FileIO
Definition: cpl_error.h:103
#define CPLFree
Definition: cpl_conv.h:81
AuthMethod GetAuthMethod() const
Definition: cpl_http.h:184
const char * CPLGetConfigOption(const char *, const char *)
Definition: cpl_conv.cpp:1690
FILE VSILFILE
Definition: cpl_vsi.h:155
#define CPLE_AppDefined
Definition: cpl_error.h:99
Generated for GDAL by
1.8.17.