30 #ifndef CPL_VSIL_CURL_PRIV_H_INCLUDED
31 #define CPL_VSIL_CURL_PRIV_H_INCLUDED
33 #include "cpl_vsi_virtual.h"
40 typedef int (*VSICurlReadCbkFunc) (
VSILFILE* fp,
void *pabyBuffer,
41 size_t nBufferSize,
void* pfnUserData);
48 int VSICurlInstallReadCbk(
VSILFILE* fp, VSICurlReadCbkFunc pfnReadCbk,
50 int bStopOnInterruptUntilUninstall );
51 int VSICurlUninstallReadCbk(
VSILFILE* fp );
53 #endif // CPL_VSIL_CURL_PRIV_H_INCLUDED
int VSIFPutcL(int, VSILFILE *) EXPERIMENTAL_CPL_WARN_UNUSED_RESULT
Write a single byte to the file.
Definition: cpl_vsil.cpp:1411
The JSONArray class JSON array from JSONDocument.
Definition: cpl_json.h:159
void VSIInstallSwiftFileHandler(void)
Install /vsiswift/ OpenStack Swif Object Storage (Swift) file system handler (requires libcurl)
Definition: cpl_vsil_curl.cpp:8583
int VSIRmdirRecursive(const char *pszDirname)
Delete a directory recursively.
Definition: cpl_vsil.cpp:490
@ CXT_Element
Definition: cpl_minixml.h:46
void VSIInstallAzureFileHandler(void)
Install /vsiaz/ Microsoft Azure Blob file system handler (requires libcurl)
Definition: cpl_vsil_curl.cpp:8549
char ** CSLTokenizeString2(const char *pszString, const char *pszDelimiter, int nCSLTFlags)
Definition: cpl_string.cpp:836
int CSLFindStringCaseSensitive(CSLConstList papszList, const char *pszTarget)
Definition: cpl_string.cpp:704
const char * CPLGetLastErrorMsg(void)
Definition: cpl_error.cpp:847
unsigned char GByte
Definition: cpl_port.h:213
size_t VSIFReadL(void *, size_t, size_t, VSILFILE *) EXPERIMENTAL_CPL_WARN_UNUSED_RESULT
Read bytes from file.
Definition: cpl_vsil.cpp:1146
int VSIRmdir(const char *pszDirname)
Delete a directory.
Definition: cpl_vsil.cpp:468
#define CPL_LSBWORD16(x)
Definition: cpl_port.h:812
char * CPLEscapeString(const char *pszString, int nLength, int nScheme)
Definition: cpl_string.cpp:2032
bool LoadMemory(const std::string &osStr)
Definition: cpl_json.cpp:199
virtual int Truncate(vsi_l_offset nNewSize)
Truncate/expand the file to the specified size.
CPLSTRING_DLL CPLString & Printf(const char *pszFormat,...)
Definition: cplstring.cpp:67
void VSIInstallStdoutHandler(void)
Install /vsistdout/ file system handler.
Definition: cpl_vsil_stdout.cpp:435
char * VSIGetSignedURL(const char *pszFilename, CSLConstList papszOptions)
Returns a signed URL of a supplied filename.
Definition: cpl_vsil.cpp:780
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 VSIInstallAzureStreamingFileHandler(void)
Install /vsiaz_streaming/ Microsoft Azure Blob file system handler (requires libcurl)
Definition: cpl_vsil_curl_streaming.cpp:2153
void * VSIRealloc(void *, size_t)
Definition: cpl_vsisimple.cpp:677
void CPLPopErrorHandler(void)
Definition: cpl_error.cpp:1223
void VSIInstallSubFileHandler(void)
Definition: cpl_vsil_subfile.cpp:501
char ** CSLSetNameValue(char **papszStrList, const char *pszName, const char *pszValue)
Definition: cpl_string.cpp:1877
GIntBig CPLAtoGIntBig(const char *pszString)
Definition: cpl_conv.cpp:996
VSIRangeStatus
Definition: cpl_vsi.h:174
CPLJSONArray ToArray() const
Definition: cpl_json.cpp:984
int CSLCount(CSLConstList papszStrList)
Definition: cpl_string.cpp:147
#define VSI_ISREG(x)
Definition: cpl_vsi.h:123
int VSIMkdir(const char *pszPathname, long mode)
Create a directory.
Definition: cpl_vsil.cpp:333
virtual int Close()=0
Close file.
Convenient string class based on std::string.
Definition: cpl_string.h:336
int size() const
Definition: cpl_string.h:471
GIntBig GInt64
Definition: cpl_port.h:265
int VSIRename(const char *oldpath, const char *newpath)
Rename a file.
Definition: cpl_vsil.cpp:439
int VSIMkdirRecursive(const char *pszPathname, long mode)
Create a directory and all its ancestors.
Definition: cpl_vsil.cpp:356
VSILFILE * VSIFOpenExL(const char *, const char *, int)
Open file.
Definition: cpl_vsil.cpp:872
void VSIRewindL(VSILFILE *)
Rewind the file pointer to the beginning of the file.
Definition: cpl_vsil.cpp:1053
#define VSI_STAT_NATURE_FLAG
Definition: cpl_vsi.h:202
CPLXMLNode * CPLParseXMLString(const char *)
Parse an XML string into tree form.
Definition: cpl_minixml.cpp:614
#define CPL_LSBPTR64(x)
Definition: cpl_port.h:828
int GPtrDiff_t
Definition: cpl_port.h:287
int VSIIsCaseSensitiveFS(const char *pszFilename)
Returns if the filenames of the filesystem are case sensitive.
Definition: cpl_vsil.cpp:647
size_t VSIFWriteL(const void *, size_t, size_t, VSILFILE *) EXPERIMENTAL_CPL_WARN_UNUSED_RESULT
Write bytes to file.
Definition: cpl_vsil.cpp:1260
virtual int Flush()
Flush pending writes to disk.
Definition: cpl_vsi_virtual.h:97
std::string GetString(const std::string &osName, const std::string &osDefault="") const
Definition: cpl_json.cpp:804
void * CPLRealloc(void *, size_t)
Definition: cpl_conv.cpp:225
virtual int ReadMultiRange(int nRanges, void **ppData, const vsi_l_offset *panOffsets, const size_t *panSizes)
Read several ranges of bytes from file.
int VSIHasOptimizedReadMultiRange(const char *pszPath)
Returns if the filesystem supports efficient multi-range reading.
Definition: cpl_vsil.cpp:703
#define VSI_ISDIR(x)
Definition: cpl_vsi.h:125
Definition: cpl_minixml.h:66
#define CPL_FRMT_GIB
Definition: cpl_port.h:314
#define EQUAL(a, b)
Definition: cpl_port.h:559
const char * CPLGetPath(const char *)
Definition: cpl_path.cpp:153
int VSIFCloseL(VSILFILE *) EXPERIMENTAL_CPL_WARN_UNUSED_RESULT
Close file.
Definition: cpl_vsil.cpp:928
virtual vsi_l_offset Tell()=0
Tell current file offset.
void VSIInstallSparseFileHandler(void)
Definition: cpl_vsil_sparsefile.cpp:559
CPLStringList & AddString(const char *pszNewString)
Definition: cplstringlist.cpp:353
void CPLPushErrorHandler(CPLErrorHandler)
Definition: cpl_error.cpp:1166
#define CPLAssert(expr)
Definition: cpl_error.h:182
const char * VSIGetFileSystemOptions(const char *pszFilename)
Return the list of options associated with a virtual file system handler as a serialized XML string.
Definition: cpl_vsil.cpp:1759
#define CPL_C_START
Definition: cpl_port.h:335
VSIRangeStatus VSIFGetRangeStatusL(VSILFILE *fp, vsi_l_offset nStart, vsi_l_offset nLength)
Return if a given file range contains data or holes filled with zeroes.
Definition: cpl_vsil.cpp:1463
int VSIFEofL(VSILFILE *) EXPERIMENTAL_CPL_WARN_UNUSED_RESULT
Test for end of file.
Definition: cpl_vsil.cpp:1306
#define CPLE_OutOfMemory
Definition: cpl_error.h:101
void VSIInstallS3FileHandler(void)
Install /vsis3/ Amazon S3 file system handler (requires libcurl)
Definition: cpl_vsil_curl.cpp:8513
bool CPLTestBool(const char *pszValue)
Definition: cpl_string.cpp:1526
void VSIInstallGZipFileHandler(void)
Install GZip file system handler.
Definition: cpl_vsil_gzip.cpp:1822
CPLXMLNode * CPLGetXMLNode(CPLXMLNode *poRoot, const char *pszPath)
Find node by path.
Definition: cpl_minixml.cpp:1557
char ** VSIReadDirEx(const char *pszPath, int nMaxFiles)
Read names in a directory.
Definition: cpl_vsil.cpp:117
virtual size_t Read(void *pBuffer, size_t nSize, size_t nCount)=0
Read bytes from file.
char ** CSLConstList
Definition: cpl_port.h:1184
The CPLJSONArray class holds JSON object from CPLJSONDocument.
Definition: cpl_json.h:53
#define CPL_FRMT_GUIB
Definition: cpl_port.h:316
vsi_l_offset VSIFTellL(VSILFILE *)
Tell current file offset.
Definition: cpl_vsil.cpp:1031
const char * CPLGetDirname(const char *)
Definition: cpl_path.cpp:208
#define CPLES_URL
Definition: cpl_string.h:171
unsigned long long GUIntBig
Definition: cpl_port.h:249
#define CPLReadDir
Definition: cpl_vsi.h:300
char * CPLBase64Encode(int nBytes, const GByte *pabyData)
Definition: cpl_base64.cpp:199
int VSIFFlushL(VSILFILE *) EXPERIMENTAL_CPL_WARN_UNUSED_RESULT
Flush pending writes to disk.
Definition: cpl_vsil.cpp:1094
CPLXMLNodeType eType
Node type.
Definition: cpl_minixml.h:74
void CPLDestroyXMLNode(CPLXMLNode *)
Destroy a tree.
Definition: cpl_minixml.cpp:1412
void VSIInstallGSFileHandler(void)
Install /vsigs/ Google Cloud Storage file system handler (requires libcurl)
Definition: cpl_vsil_curl.cpp:8531
#define CPL_C_END
Definition: cpl_port.h:337
void CPLDebug(const char *, const char *,...)
Definition: cpl_error.cpp:544
void VSIInstallStdinHandler(void)
Install /vsistdin/ file system handler.
Definition: cpl_vsil_stdin.cpp:434
virtual VSIRangeStatus GetRangeStatus(vsi_l_offset nOffset, vsi_l_offset nLength)
Return if a given file range contains data or holes filled with zeroes.
Definition: cpl_vsi_virtual.h:102
const char * CPLFormFilename(const char *pszPath, const char *pszBasename, const char *pszExtension)
Definition: cpl_path.cpp:535
int VSIStatL(const char *, VSIStatBufL *)
Get filesystem object info.
Definition: cpl_vsil.cpp:558
int VSIUnlink(const char *pszFilename)
Delete a file.
Definition: cpl_vsil.cpp:408
#define STARTS_WITH(a, b)
Definition: cpl_port.h:568
void * CPLMalloc(size_t)
Definition: cpl_conv.cpp:168
void VSIInstallCryptFileHandler(void)
Install /vsicrypt/ encrypted file system handler (requires libcrypto++)
Definition: cpl_vsil_crypt.cpp:2036
void VSIInstallGSStreamingFileHandler(void)
Install /vsigs_streaming/ Google Cloud Storage file system handler (requires libcurl)
Definition: cpl_vsil_curl_streaming.cpp:2135
int VSISupportsSparseFiles(const char *pszPath)
Returns if the filesystem supports sparse files.
Definition: cpl_vsil.cpp:677
int VSIFTruncateL(VSILFILE *, vsi_l_offset) EXPERIMENTAL_CPL_WARN_UNUSED_RESULT
Truncate/expand the file to the specified size.
Definition: cpl_vsil.cpp:1348
char ** VSIGetFileSystemsPrefixes(void)
Return the list of prefixes for virtual file system handlers currently registered.
Definition: cpl_vsil.cpp:1739
int CSLFindString(CSLConstList papszList, const char *pszTarget)
Definition: cpl_string.cpp:670
void VSIInstallCurlStreamingFileHandler(void)
Install /vsicurl_streaming/ HTTP/FTP file system handler (requires libcurl).
Definition: cpl_vsil_curl_streaming.cpp:2098
void VSIInstallCurlFileHandler(void)
Install /vsicurl/ HTTP/FTP file system handler (requires libcurl)
Definition: cpl_vsil_curl.cpp:8480
void VSIInstallTarFileHandler(void)
Install /vsitar/ file system handler.
Definition: cpl_vsil_tar.cpp:586
void CPLErrorReset(void)
Definition: cpl_error.cpp:710
int VSIFSeekL(VSILFILE *, vsi_l_offset, int) EXPERIMENTAL_CPL_WARN_UNUSED_RESULT
Seek to requested offset.
Definition: cpl_vsil.cpp:988
const char * CPLSPrintf(const char *fmt,...)
Definition: cpl_string.cpp:977
virtual size_t Write(const void *pBuffer, size_t nSize, size_t nCount)=0
Write bytes to file.
const char * CPLGetXMLValue(const CPLXMLNode *poRoot, const char *pszPath, const char *pszDefault)
Fetch element/attribute value.
Definition: cpl_minixml.cpp:1645
Definition: cpl_multiproc.h:139
int Size() const
Definition: cpl_json.cpp:1169
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
void VSIInstallMemFileHandler(void)
Install "memory" file system handler.
Definition: cpl_vsi_mem.cpp:895
void VSIInstallZipFileHandler(void)
Install ZIP file system handler.
Definition: cpl_vsil_gzip.cpp:2659
GUIntBig vsi_l_offset
Definition: cpl_vsi.h:139
void VSIFree(void *)
Definition: cpl_vsisimple.cpp:823
GInt64 GetLong(const std::string &osName, GInt64 nDefault=0) const
Definition: cpl_json.cpp:898
#define CPLE_NotSupported
Definition: cpl_error.h:109
void VSIInstallOSSFileHandler(void)
Install /vsioss/ Alibaba Cloud Object Storage Service (OSS) file system handler (requires libcurl)
Definition: cpl_vsil_curl.cpp:8566
char * CPLUnescapeString(const char *pszString, int *pnLength, int nScheme)
Definition: cpl_string.cpp:2243
int VSIFReadMultiRangeL(int nRanges, void **ppData, const vsi_l_offset *panOffsets, const size_t *panSizes, VSILFILE *) EXPERIMENTAL_CPL_WARN_UNUSED_RESULT
Read several ranges of bytes from file.
Definition: cpl_vsil.cpp:1206
void CPLSetConfigOption(const char *, const char *)
Definition: cpl_conv.cpp:1830
#define CPL_ARRAYSIZE(array)
Definition: cpl_port.h:1035
OGRLayer::FeatureIterator end(OGRLayer *poLayer)
Definition: ogrsf_frmts.h:290
size_t CPLStrnlen(const char *pszStr, size_t nMaxLen)
Definition: cpl_string.cpp:2790
virtual int Eof()=0
Test for end of file.
char ** CSLDuplicate(CSLConstList papszStrList)
Definition: cpl_string.cpp:228
CPLSTRING_DLL CPLString & Trim()
Definition: cplstring.cpp:214
#define VSI_STAT_EXISTS_FLAG
Definition: cpl_vsi.h:200
CPLJSONObject GetRoot()
Definition: cpl_json.cpp:119
void * VSIMalloc(size_t)
Definition: cpl_vsisimple.cpp:554
void CSLDestroy(char **papszStrList)
Definition: cpl_string.cpp:200
char ** VSIReadDirRecursive(const char *pszPath)
Read names in a directory recursively.
Definition: cpl_vsil.cpp:160
long long GIntBig
Definition: cpl_port.h:246
int VSIStatExL(const char *pszFilename, VSIStatBufL *psStatBuf, int nFlags)
Get filesystem object info.
Definition: cpl_vsil.cpp:597
CPLSTRING_DLL CPLString & vPrintf(const char *pszFormat, va_list args)
Definition: cplstring.cpp:85
#define VSI_STAT_SET_ERROR_FLAG
Definition: cpl_vsi.h:206
int Count() const
Definition: cplstringlist.cpp:238
void VSISetCryptKey(const GByte *pabyKey, int nKeySize)
Definition: cpl_vsil_crypt.cpp:205
struct CPLXMLNode * psNext
Next sibling.
Definition: cpl_minixml.h:106
GIntBig VSIGetDiskFreeSpace(const char *pszDirname)
Return free disk space available on the filesystem.
Definition: cpl_vsil.cpp:1717
#define CPL_FORMAT_STRING(arg)
Definition: cpl_port.h:919
struct stat64 VSIStatBufL
Definition: cpl_vsi.h:191
void VSIInstallOSSStreamingFileHandler(void)
Install /vsioss_streaming/ Alibaba Cloud Object Storage Service (OSS) file system handler (requires l...
Definition: cpl_vsil_curl_streaming.cpp:2172
void VSIInstallSwiftStreamingFileHandler(void)
Install /vsiswift_streamin/ OpenStack Swif Object Storage (Swift) file system handler (requires libcu...
Definition: cpl_vsil_curl_streaming.cpp:2191
#define EQUALN(a, b, n)
Definition: cpl_port.h:557
char ** StealList()
Definition: cplstringlist.cpp:509
void VSIInstallS3StreamingFileHandler(void)
Install /vsis3_streaming/ Amazon S3 file system handler (requires libcurl).
Definition: cpl_vsil_curl_streaming.cpp:2116
The CPLJSONDocument class Wrapper class around json-c library.
Definition: cpl_json.h:188
Definition: cpl_vsi_virtual.h:56
VSILFILE * VSIFOpenL(const char *, const char *)
Open file.
Definition: cpl_vsil.cpp:818
#define CPLE_None
Definition: cpl_error.h:97
char ** CSLAddString(char **papszStrList, const char *pszNewString)
Definition: cpl_string.cpp:83
char ** VSIReadDir(const char *)
Read names in a directory.
Definition: cpl_vsil.cpp:83
#define VSI_L_OFFSET_MAX
Definition: cpl_vsi.h:141
virtual void * GetNativeFileDescriptor()
Returns the "native" file descriptor for the virtual handle.
Definition: cpl_vsi_virtual.h:101
char * CPLStrdup(const char *)
Definition: cpl_conv.cpp:293
double CPLAtof(const char *)
Definition: cpl_strtod.cpp:117
CPLErr CPLGetLastErrorType(void)
Definition: cpl_error.cpp:823
char * pszValue
Node value.
Definition: cpl_minixml.h:97
void VSICurlClearCache(void)
Clean local cache associated with /vsicurl/ (and related file systems)
Definition: cpl_vsil_curl.cpp:8604
#define CPLE_IllegalArg
Definition: cpl_error.h:107
GUIntBig CPLScanUIntBig(const char *, int)
Definition: cpl_conv.cpp:964
struct CPLXMLNode * psChild
Child node.
Definition: cpl_minixml.h:118
int VSIIngestFile(VSILFILE *fp, const char *pszFilename, GByte **ppabyRet, vsi_l_offset *pnSize, GIntBig nMaxSize)
Ingest a file into memory.
Definition: cpl_vsil.cpp:1500
Definition: cpl_vsil.cpp:129
void CPLQuietErrorHandler(CPLErr, CPLErrorNum, const char *)
Definition: cpl_error.cpp:948
const char * VSIGetActualURL(const char *pszFilename)
Returns the actual URL of a supplied filename.
Definition: cpl_vsil.cpp:733
#define CPLE_FileIO
Definition: cpl_error.h:103
int CPLBase64DecodeInPlace(GByte *pszBase64)
Definition: cpl_base64.cpp:93
unsigned short GUInt16
Definition: cpl_port.h:211
#define CPLFree
Definition: cpl_conv.h:81
const char * CPLGetExtension(const char *)
Definition: cpl_path.cpp:345
const char * CPLGetFilename(const char *)
Definition: cpl_path.cpp:260
#define VSI_STAT_SIZE_FLAG
Definition: cpl_vsi.h:204
void * VSIFGetNativeFileDescriptorL(VSILFILE *)
Returns the "native" file descriptor for the virtual handle.
Definition: cpl_vsil.cpp:1696
int VSIFPrintfL(VSILFILE *, const char *,...) EXPERIMENTAL_CPL_WARN_UNUSED_RESULT
Formatted write to file.
Definition: cpl_vsil.cpp:1374
const char * CPLGetConfigOption(const char *, const char *)
Definition: cpl_conv.cpp:1690
FILE VSILFILE
Definition: cpl_vsi.h:155
virtual int Seek(vsi_l_offset nOffset, int nWhence)=0
Seek to requested offset.
#define STARTS_WITH_CI(a, b)
Definition: cpl_port.h:570
#define CPLE_AppDefined
Definition: cpl_error.h:99
unsigned long CPLHashSetHashStr(const void *pszStr)
Definition: cpl_hash_set.cpp:551
Generated for GDAL by
1.8.17.