cpl_vsil_curl_priv.h 2.5 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849
  1. /******************************************************************************
  2. * $Id: cpl_vsil_curl_priv.h 27044 2014-03-16 23:41:27Z rouault $
  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. #ifndef CPL_VSIL_CURL_PRIV_H_INCLUDED
  30. #define CPL_VSIL_CURL_PRIV_H_INCLUDED
  31. #include "cpl_vsi_virtual.h"
  32. /* NOTE: this is private API for GDAL internal use. May change without notice. */
  33. /* Used by the MBTiles driver for now */
  34. /* Return TRUE to go on downloading, FALSE to stop */
  35. typedef int (*VSICurlReadCbkFunc) (VSILFILE* fp, void *pabyBuffer, size_t nBufferSize, void* pfnUserData);
  36. /* fp must be a VSICurl file handle, otherwise bad things will happen ! */
  37. /* bStopOnInterrruptUntilUninstall must be set to TRUE if all downloads */
  38. /* must be cancelled after a first one has been stopped by the callback function. */
  39. /* In that case, downloads will restart after uninstalling the callback. */
  40. int VSICurlInstallReadCbk(VSILFILE* fp, VSICurlReadCbkFunc pfnReadCbk, void* pfnUserData,
  41. int bStopOnInterrruptUntilUninstall);
  42. int VSICurlUninstallReadCbk(VSILFILE* fp);
  43. #endif // CPL_VSIL_CURL_PRIV_H_INCLUDED