OGR
cpl_vsil_curl_priv.h
1 /******************************************************************************
2  * $Id: cpl_vsil_curl_priv.h 36772 2016-12-10 06:29:22Z goatbar $
3  *
4  * Project: CPL - Common Portability Library
5  * Purpose: Private API for VSICurl
6  * Author: Even Rouault, even.rouault at mines-paris.org
7  *
8  ******************************************************************************
9  * Copyright (c) 2012, Even Rouault <even dot rouault at mines-paris dot org>
10  *
11  * Permission is hereby granted, free of charge, to any person obtaining a
12  * copy of this software and associated documentation files (the "Software"),
13  * to deal in the Software without restriction, including without limitation
14  * the rights to use, copy, modify, merge, publish, distribute, sublicense,
15  * and/or sell copies of the Software, and to permit persons to whom the
16  * Software is furnished to do so, subject to the following conditions:
17  *
18  * The above copyright notice and this permission notice shall be included
19  * in all copies or substantial portions of the Software.
20  *
21  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS
22  * OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
23  * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL
24  * THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
25  * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
26  * FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
27  * DEALINGS IN THE SOFTWARE.
28  ****************************************************************************/
29 
30 #ifndef CPL_VSIL_CURL_PRIV_H_INCLUDED
31 #define CPL_VSIL_CURL_PRIV_H_INCLUDED
32 
33 #include "cpl_vsi_virtual.h"
34 
35 /* NOTE: this is private API for GDAL internal use. */
36 /* May change without notice. */
37 /* Used by the MBTiles driver for now. */
38 
39 /* Return TRUE to go on downloading, FALSE to stop. */
40 typedef int (*VSICurlReadCbkFunc) (VSILFILE* fp, void *pabyBuffer,
41  size_t nBufferSize, void* pfnUserData);
42 
43 /* fp must be a VSICurl file handle, otherwise bad things will happen. */
44 /* bStopOnInterruptUntilUninstall must be set to TRUE if all downloads */
45 /* must be canceled after a first one has been stopped by the callback */
46 /* function. In that case, downloads will restart after uninstalling the */
47 /* callback. */
48 int VSICurlInstallReadCbk( VSILFILE* fp, VSICurlReadCbkFunc pfnReadCbk,
49  void* pfnUserData,
50  int bStopOnInterruptUntilUninstall );
51 int VSICurlUninstallReadCbk( VSILFILE* fp );
52 
53 #endif // CPL_VSIL_CURL_PRIV_H_INCLUDED
VSIFPutcL
int VSIFPutcL(int, VSILFILE *) EXPERIMENTAL_CPL_WARN_UNUSED_RESULT
Write a single byte to the file.
Definition: cpl_vsil.cpp:1187
CPLGetXMLValue
const char * CPLGetXMLValue(CPLXMLNode *poRoot, const char *pszPath, const char *pszDefault)
Fetch element/attribute value.
Definition: cpl_minixml.cpp:1645
CXT_Element
@ CXT_Element
Definition: cpl_minixml.h:46
CSLTokenizeString2
char ** CSLTokenizeString2(const char *pszString, const char *pszDelimiter, int nCSLTFlags)
Definition: cpl_string.cpp:834
CPLGetLastErrorMsg
const char * CPLGetLastErrorMsg(void)
Definition: cpl_error.cpp:788
GByte
unsigned char GByte
Definition: cpl_port.h:207
VSIFReadL
size_t VSIFReadL(void *, size_t, size_t, VSILFILE *) EXPERIMENTAL_CPL_WARN_UNUSED_RESULT
Read bytes from file.
Definition: cpl_vsil.cpp:922
cpl_error.h
CPL_LSBWORD16
#define CPL_LSBWORD16(x)
Definition: cpl_port.h:875
CPLEscapeString
char * CPLEscapeString(const char *pszString, int nLength, int nScheme)
Definition: cpl_string.cpp:2018
VSIVirtualHandle::Truncate
virtual int Truncate(vsi_l_offset nNewSize)
Truncate/expand the file to the specified size.
CPLString::Printf
CPLString & Printf(const char *pszFormat,...)
Definition: cplstring.cpp:59
VSIInstallStdoutHandler
void VSIInstallStdoutHandler(void)
Install /vsistdout/ file system handler.
Definition: cpl_vsil_stdout.cpp:434
cpl_hash_set.h
CPLStringList
String list class designed around our use of C "char**" string lists.
Definition: cpl_string.h:449
CPLCalloc
void * CPLCalloc(size_t, size_t)
Definition: cpl_conv.cpp:128
GPtrDiff_t
GIntBig GPtrDiff_t
Definition: cpl_port.h:294
VSIRealloc
void * VSIRealloc(void *, size_t)
Definition: cpl_vsisimple.cpp:671
cpl_minixml.h
CPLPopErrorHandler
void CPLPopErrorHandler(void)
Definition: cpl_error.cpp:1141
VSIInstallSubFileHandler
void VSIInstallSubFileHandler(void)
Definition: cpl_vsil_subfile.cpp:496
cpl_vsi.h
CPLAtoGIntBig
GIntBig CPLAtoGIntBig(const char *pszString)
Definition: cpl_conv.cpp:953
VSIRangeStatus
VSIRangeStatus
Definition: cpl_vsi.h:173
VSI_ISREG
#define VSI_ISREG(x)
Definition: cpl_vsi.h:122
VSIVirtualHandle::Close
virtual int Close()=0
Close file.
CPLString
Convenient string class based on std::string.
Definition: cpl_string.h:338
VSIRename
int VSIRename(const char *oldpath, const char *newpath)
Rename a file.
Definition: cpl_vsil.cpp:388
VSIFOpenExL
VSILFILE * VSIFOpenExL(const char *, const char *, int)
Open file.
Definition: cpl_vsil.cpp:662
VSIRewindL
void VSIRewindL(VSILFILE *)
Rewind the file pointer to the beginning of the file.
Definition: cpl_vsil.cpp:829
VSI_STAT_NATURE_FLAG
#define VSI_STAT_NATURE_FLAG
Definition: cpl_vsi.h:201
CPLParseXMLString
CPLXMLNode * CPLParseXMLString(const char *)
Parse an XML string into tree form.
Definition: cpl_minixml.cpp:614
CPL_LSBPTR64
#define CPL_LSBPTR64(x)
Definition: cpl_port.h:891
VSIIsCaseSensitiveFS
int VSIIsCaseSensitiveFS(const char *pszFilename)
Returns if the filenames of the filesystem are case sensitive.
Definition: cpl_vsil.cpp:540
VSIFWriteL
size_t VSIFWriteL(const void *, size_t, size_t, VSILFILE *) EXPERIMENTAL_CPL_WARN_UNUSED_RESULT
Write bytes to file.
Definition: cpl_vsil.cpp:1036
VSIVirtualHandle::Flush
virtual int Flush()
Flush pending writes to disk.
Definition: cpl_vsi_virtual.h:97
CPLRealloc
void * CPLRealloc(void *, size_t)
Definition: cpl_conv.cpp:215
VSIVirtualHandle::ReadMultiRange
virtual int ReadMultiRange(int nRanges, void **ppData, const vsi_l_offset *panOffsets, const size_t *panSizes)
Read several ranges of bytes from file.
VSI_ISDIR
#define VSI_ISDIR(x)
Definition: cpl_vsi.h:124
CPLXMLNode
Definition: cpl_minixml.h:66
CSLFindString
int CSLFindString(const char *const *papszList, const char *pszTarget)
Definition: cpl_string.cpp:668
CPL_FRMT_GIB
#define CPL_FRMT_GIB
Definition: cpl_port.h:326
EQUAL
#define EQUAL(a, b)
Definition: cpl_port.h:622
VSIFCloseL
int VSIFCloseL(VSILFILE *) EXPERIMENTAL_CPL_WARN_UNUSED_RESULT
Close file.
Definition: cpl_vsil.cpp:712
VSIVirtualHandle::Tell
virtual vsi_l_offset Tell()=0
Tell current file offset.
cpl_http.h
VSIInstallSparseFileHandler
void VSIInstallSparseFileHandler(void)
Definition: cpl_vsil_sparsefile.cpp:588
CPLStringList::AddString
CPLStringList & AddString(const char *pszNewString)
Definition: cplstringlist.cpp:319
CPLPushErrorHandler
void CPLPushErrorHandler(CPLErrorHandler)
Definition: cpl_error.cpp:1084
CSLDuplicate
char ** CSLDuplicate(char **papszStrList)
Definition: cpl_string.cpp:228
CPLAssert
#define CPLAssert(expr)
Definition: cpl_error.h:182
CPL_C_START
#define CPL_C_START
Definition: cpl_port.h:352
CPLString::back
const char & back() const
Definition: cpl_string.h:385
VSIFGetRangeStatusL
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:1241
VSIFEofL
int VSIFEofL(VSILFILE *) EXPERIMENTAL_CPL_WARN_UNUSED_RESULT
Test for end of file.
Definition: cpl_vsil.cpp:1082
CPLE_OutOfMemory
#define CPLE_OutOfMemory
Definition: cpl_error.h:102
VSIInstallS3FileHandler
void VSIInstallS3FileHandler(void)
Install /vsis3/ Amazon S3 file system handler (requires libcurl)
Definition: cpl_vsil_curl.cpp:5017
CPLTestBool
bool CPLTestBool(const char *pszValue)
Definition: cpl_string.cpp:1522
VSIInstallGZipFileHandler
void VSIInstallGZipFileHandler(void)
Install GZip file system handler.
Definition: cpl_vsil_gzip.cpp:1805
CPLGetXMLNode
CPLXMLNode * CPLGetXMLNode(CPLXMLNode *poRoot, const char *pszPath)
Find node by path.
Definition: cpl_minixml.cpp:1557
VSIReadDirEx
char ** VSIReadDirEx(const char *pszPath, int nMaxFiles)
Read names in a directory.
Definition: cpl_vsil.cpp:116
CSLCount
int CSLCount(const char *const *papszStrList)
Definition: cpl_string.cpp:147
VSIVirtualHandle::Read
virtual size_t Read(void *pBuffer, size_t nSize, size_t nCount)=0
Read bytes from file.
CPL_FRMT_GUIB
#define CPL_FRMT_GUIB
Definition: cpl_port.h:328
VSIFTellL
vsi_l_offset VSIFTellL(VSILFILE *)
Tell current file offset.
Definition: cpl_vsil.cpp:807
CPLGetDirname
const char * CPLGetDirname(const char *)
Definition: cpl_path.cpp:208
CPLES_URL
#define CPLES_URL
Definition: cpl_string.h:202
GUIntBig
unsigned long long GUIntBig
Definition: cpl_port.h:253
CPLReadDir
#define CPLReadDir
Definition: cpl_vsi.h:289
CPLBase64Encode
char * CPLBase64Encode(int nBytes, const GByte *pabyData)
Definition: cpl_base64.cpp:199
VSIFFlushL
int VSIFFlushL(VSILFILE *) EXPERIMENTAL_CPL_WARN_UNUSED_RESULT
Flush pending writes to disk.
Definition: cpl_vsil.cpp:870
CPLXMLNode::eType
CPLXMLNodeType eType
Node type.
Definition: cpl_minixml.h:74
CSLFetchNameValue
const char * CSLFetchNameValue(const char *const *papszStrList, const char *pszName)
Definition: cpl_string.cpp:1670
CPLDestroyXMLNode
void CPLDestroyXMLNode(CPLXMLNode *)
Destroy a tree.
Definition: cpl_minixml.cpp:1412
VSIInstallGSFileHandler
void VSIInstallGSFileHandler(void)
Install /vsigs/ Google Cloud Storage file system handler (requires libcurl)
Definition: cpl_vsil_curl.cpp:5068
CPL_C_END
#define CPL_C_END
Definition: cpl_port.h:354
CPLDebug
void CPLDebug(const char *, const char *,...)
Definition: cpl_error.cpp:492
VSIInstallStdinHandler
void VSIInstallStdinHandler(void)
Install /vsistdin/ file system handler.
Definition: cpl_vsil_stdin.cpp:421
VSIVirtualHandle::GetRangeStatus
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
VSIStatL
int VSIStatL(const char *, VSIStatBufL *)
Get filesystem object info.
Definition: cpl_vsil.cpp:451
STARTS_WITH
#define STARTS_WITH(a, b)
Definition: cpl_port.h:631
CPLMalloc
void * CPLMalloc(size_t)
Definition: cpl_conv.cpp:158
VSIInstallCryptFileHandler
void VSIInstallCryptFileHandler(void)
Install /vsicrypt/ encrypted file system handler (requires libcrypto++)
Definition: cpl_vsil_crypt.cpp:2033
VSIInstallGSStreamingFileHandler
void VSIInstallGSStreamingFileHandler(void)
Install /vsigs_streaming/ Google Cloud Storage file system handler (requires libcurl)
Definition: cpl_vsil_curl_streaming.cpp:2031
VSISupportsSparseFiles
int VSISupportsSparseFiles(const char *pszPath)
Returns if the filesystem supports sparse files.
Definition: cpl_vsil.cpp:570
VSIFTruncateL
int VSIFTruncateL(VSILFILE *, vsi_l_offset) EXPERIMENTAL_CPL_WARN_UNUSED_RESULT
Truncate/expand the file to the specified size.
Definition: cpl_vsil.cpp:1124
VSIRmdir
int VSIRmdir(const char *pathname)
Delete a directory.
Definition: cpl_vsil.cpp:417
VSIInstallCurlStreamingFileHandler
void VSIInstallCurlStreamingFileHandler(void)
Install /vsicurl_streaming/ HTTP/FTP file system handler (requires libcurl).
Definition: cpl_vsil_curl_streaming.cpp:1928
cpl_conv.h
VSIInstallCurlFileHandler
void VSIInstallCurlFileHandler(void)
Install /vsicurl/ HTTP/FTP file system handler (requires libcurl)
Definition: cpl_vsil_curl.cpp:4950
cpl_string.h
VSIInstallTarFileHandler
void VSIInstallTarFileHandler(void)
Install /vsitar/ file system handler.
Definition: cpl_vsil_tar.cpp:538
VSIUnlink
int VSIUnlink(const char *pathname)
Delete a file.
Definition: cpl_vsil.cpp:357
CPLErrorReset
void CPLErrorReset(void)
Definition: cpl_error.cpp:653
VSIFSeekL
int VSIFSeekL(VSILFILE *, vsi_l_offset, int) EXPERIMENTAL_CPL_WARN_UNUSED_RESULT
Seek to requested offset.
Definition: cpl_vsil.cpp:764
CPLSPrintf
const char * CPLSPrintf(const char *fmt,...)
Definition: cpl_string.cpp:975
VSIVirtualHandle::Write
virtual size_t Write(const void *pBuffer, size_t nSize, size_t nCount)=0
Write bytes to file.
CPLMutexHolder
Definition: cpl_multiproc.h:139
CPLError
void CPLError(CPLErr eErrClass, CPLErrorNum err_no, const char *fmt,...)
Definition: cpl_error.cpp:215
VSIInstallMemFileHandler
void VSIInstallMemFileHandler(void)
Install "memory" file system handler.
Definition: cpl_vsi_mem.cpp:903
VSIInstallZipFileHandler
void VSIInstallZipFileHandler(void)
Install ZIP file system handler.
Definition: cpl_vsil_gzip.cpp:2634
vsi_l_offset
GUIntBig vsi_l_offset
Definition: cpl_vsi.h:138
VSIFree
void VSIFree(void *)
Definition: cpl_vsisimple.cpp:817
CPLE_NotSupported
#define CPLE_NotSupported
Definition: cpl_error.h:110
CPLUnescapeString
char * CPLUnescapeString(const char *pszString, int *pnLength, int nScheme)
Definition: cpl_string.cpp:2227
VSIFReadMultiRangeL
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:982
CPLSetConfigOption
void CPLSetConfigOption(const char *, const char *)
Definition: cpl_conv.cpp:1765
VSIVirtualHandle::Eof
virtual int Eof()=0
Test for end of file.
CPLString::Trim
CPLString & Trim()
Definition: cplstring.cpp:203
VSI_STAT_EXISTS_FLAG
#define VSI_STAT_EXISTS_FLAG
Definition: cpl_vsi.h:199
VSIMalloc
void * VSIMalloc(size_t)
Definition: cpl_vsisimple.cpp:548
CSLDestroy
void CSLDestroy(char **papszStrList)
Definition: cpl_string.cpp:200
CPL_FINAL
#define CPL_FINAL
Definition: cpl_port.h:1078
VSIReadDirRecursive
char ** VSIReadDirRecursive(const char *pszPath)
Read names in a directory recursively.
Definition: cpl_vsil.cpp:159
GIntBig
long long GIntBig
Definition: cpl_port.h:250
VSIStatExL
int VSIStatExL(const char *pszFilename, VSIStatBufL *psStatBuf, int nFlags)
Get filesystem object info.
Definition: cpl_vsil.cpp:490
CPLString::vPrintf
CPLString & vPrintf(const char *pszFormat, va_list args)
Definition: cplstring.cpp:76
VSI_STAT_SET_ERROR_FLAG
#define VSI_STAT_SET_ERROR_FLAG
Definition: cpl_vsi.h:205
CPLStringList::Count
int Count() const
Definition: cplstringlist.cpp:204
VSISetCryptKey
void VSISetCryptKey(const GByte *pabyKey, int nKeySize)
Definition: cpl_vsil_crypt.cpp:197
CPLXMLNode::psNext
struct CPLXMLNode * psNext
Next sibling.
Definition: cpl_minixml.h:106
VSIGetDiskFreeSpace
GIntBig VSIGetDiskFreeSpace(const char *pszDirname)
Return free disk space available on the filesystem.
Definition: cpl_vsil.cpp:1495
CPL_FORMAT_STRING
#define CPL_FORMAT_STRING(arg)
Definition: cpl_port.h:989
VSIStatBufL
struct stat64 VSIStatBufL
Definition: cpl_vsi.h:190
cpl_port.h
EQUALN
#define EQUALN(a, b, n)
Definition: cpl_port.h:620
CPLStringList::StealList
char ** StealList()
Definition: cplstringlist.cpp:475
VSIInstallS3StreamingFileHandler
void VSIInstallS3StreamingFileHandler(void)
Install /vsis3_streaming/ Amazon S3 file system handler (requires libcurl).
Definition: cpl_vsil_curl_streaming.cpp:1980
VSIVirtualHandle
Definition: cpl_vsi_virtual.h:56
VSIFOpenL
VSILFILE * VSIFOpenL(const char *, const char *)
Open file.
Definition: cpl_vsil.cpp:608
VSIMkdir
int VSIMkdir(const char *pathname, long mode)
Create a directory.
Definition: cpl_vsil.cpp:329
VSIReadDir
char ** VSIReadDir(const char *)
Read names in a directory.
Definition: cpl_vsil.cpp:82
VSI_L_OFFSET_MAX
#define VSI_L_OFFSET_MAX
Definition: cpl_vsi.h:140
VSIVirtualHandle::GetNativeFileDescriptor
virtual void * GetNativeFileDescriptor()
Returns the "native" file descriptor for the virtual handle.
Definition: cpl_vsi_virtual.h:101
CPLStrdup
char * CPLStrdup(const char *)
Definition: cpl_conv.cpp:284
CPLXMLNode::pszValue
char * pszValue
Node value.
Definition: cpl_minixml.h:97
VSICurlClearCache
void VSICurlClearCache(void)
Clean local cache associated with /vsicurl/ (and related file systems)
Definition: cpl_vsil_curl.cpp:5088
CPLScanUIntBig
GUIntBig CPLScanUIntBig(const char *, int)
Definition: cpl_conv.cpp:921
CPLXMLNode::psChild
struct CPLXMLNode * psChild
Child node.
Definition: cpl_minixml.h:118
VSIIngestFile
int VSIIngestFile(VSILFILE *fp, const char *pszFilename, GByte **ppabyRet, vsi_l_offset *pnSize, GIntBig nMaxSize)
Ingest a file into memory.
Definition: cpl_vsil.cpp:1278
VSIReadDirRecursiveTask
Definition: cpl_vsil.cpp:128
CPLQuietErrorHandler
void CPLQuietErrorHandler(CPLErr, CPLErrorNum, const char *)
Definition: cpl_error.cpp:866
CPLE_FileIO
#define CPLE_FileIO
Definition: cpl_error.h:104
CPLBase64DecodeInPlace
int CPLBase64DecodeInPlace(GByte *pszBase64)
Definition: cpl_base64.cpp:93
GUInt16
unsigned short GUInt16
Definition: cpl_port.h:205
CPLFree
#define CPLFree
Definition: cpl_conv.h:81
CPLGetExtension
const char * CPLGetExtension(const char *)
Definition: cpl_path.cpp:345
CPLGetFilename
const char * CPLGetFilename(const char *)
Definition: cpl_path.cpp:260
VSI_STAT_SIZE_FLAG
#define VSI_STAT_SIZE_FLAG
Definition: cpl_vsi.h:203
VSIFGetNativeFileDescriptorL
void * VSIFGetNativeFileDescriptorL(VSILFILE *)
Returns the "native" file descriptor for the virtual handle.
Definition: cpl_vsil.cpp:1474
VSIFPrintfL
int VSIFPrintfL(VSILFILE *, const char *,...) EXPERIMENTAL_CPL_WARN_UNUSED_RESULT
Formatted write to file.
Definition: cpl_vsil.cpp:1150
CPLGetConfigOption
const char * CPLGetConfigOption(const char *, const char *)
Definition: cpl_conv.cpp:1625
VSILFILE
FILE VSILFILE
Definition: cpl_vsi.h:154
VSIVirtualHandle::Seek
virtual int Seek(vsi_l_offset nOffset, int nWhence)=0
Seek to requested offset.
STARTS_WITH_CI
#define STARTS_WITH_CI(a, b)
Definition: cpl_port.h:633
CPLE_AppDefined
#define CPLE_AppDefined
Definition: cpl_error.h:100
CPLHashSetHashStr
unsigned long CPLHashSetHashStr(const void *pszStr)
Definition: cpl_hash_set.cpp:550

Generated for GDAL by doxygen 1.8.17.