easy.h 3.9 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125
  1. #ifndef CURLINC_EASY_H
  2. #define CURLINC_EASY_H
  3. /***************************************************************************
  4. * _ _ ____ _
  5. * Project ___| | | | _ \| |
  6. * / __| | | | |_) | |
  7. * | (__| |_| | _ <| |___
  8. * \___|\___/|_| \_\_____|
  9. *
  10. * Copyright (C) Daniel Stenberg, <daniel@haxx.se>, et al.
  11. *
  12. * This software is licensed as described in the file COPYING, which
  13. * you should have received as part of this distribution. The terms
  14. * are also available at https://curl.se/docs/copyright.html.
  15. *
  16. * You may opt to use, copy, modify, merge, publish, distribute and/or sell
  17. * copies of the Software, and permit persons to whom the Software is
  18. * furnished to do so, under the terms of the COPYING file.
  19. *
  20. * This software is distributed on an "AS IS" basis, WITHOUT WARRANTY OF ANY
  21. * KIND, either express or implied.
  22. *
  23. * SPDX-License-Identifier: curl
  24. *
  25. ***************************************************************************/
  26. #ifdef __cplusplus
  27. extern "C" {
  28. #endif
  29. /* Flag bits in the curl_blob struct: */
  30. #define CURL_BLOB_COPY 1 /* tell libcurl to copy the data */
  31. #define CURL_BLOB_NOCOPY 0 /* tell libcurl to NOT copy the data */
  32. struct curl_blob {
  33. void *data;
  34. size_t len;
  35. unsigned int flags; /* bit 0 is defined, the rest are reserved and should be
  36. left zeroes */
  37. };
  38. CURL_EXTERN CURL *curl_easy_init(void);
  39. CURL_EXTERN CURLcode curl_easy_setopt(CURL *curl, CURLoption option, ...);
  40. CURL_EXTERN CURLcode curl_easy_perform(CURL *curl);
  41. CURL_EXTERN void curl_easy_cleanup(CURL *curl);
  42. /*
  43. * NAME curl_easy_getinfo()
  44. *
  45. * DESCRIPTION
  46. *
  47. * Request internal information from the curl session with this function.
  48. * The third argument MUST be pointing to the specific type of the used option
  49. * which is documented in each man page of the option. The data pointed to
  50. * will be filled in accordingly and can be relied upon only if the function
  51. * returns CURLE_OK. This function is intended to get used *AFTER* a performed
  52. * transfer, all results from this function are undefined until the transfer
  53. * is completed.
  54. */
  55. CURL_EXTERN CURLcode curl_easy_getinfo(CURL *curl, CURLINFO info, ...);
  56. /*
  57. * NAME curl_easy_duphandle()
  58. *
  59. * DESCRIPTION
  60. *
  61. * Creates a new curl session handle with the same options set for the handle
  62. * passed in. Duplicating a handle could only be a matter of cloning data and
  63. * options, internal state info and things like persistent connections cannot
  64. * be transferred. It is useful in multithreaded applications when you can run
  65. * curl_easy_duphandle() for each new thread to avoid a series of identical
  66. * curl_easy_setopt() invokes in every thread.
  67. */
  68. CURL_EXTERN CURL *curl_easy_duphandle(CURL *curl);
  69. /*
  70. * NAME curl_easy_reset()
  71. *
  72. * DESCRIPTION
  73. *
  74. * Re-initializes a CURL handle to the default values. This puts back the
  75. * handle to the same state as it was in when it was just created.
  76. *
  77. * It does keep: live connections, the Session ID cache, the DNS cache and the
  78. * cookies.
  79. */
  80. CURL_EXTERN void curl_easy_reset(CURL *curl);
  81. /*
  82. * NAME curl_easy_recv()
  83. *
  84. * DESCRIPTION
  85. *
  86. * Receives data from the connected socket. Use after successful
  87. * curl_easy_perform() with CURLOPT_CONNECT_ONLY option.
  88. */
  89. CURL_EXTERN CURLcode curl_easy_recv(CURL *curl, void *buffer, size_t buflen,
  90. size_t *n);
  91. /*
  92. * NAME curl_easy_send()
  93. *
  94. * DESCRIPTION
  95. *
  96. * Sends data over the connected socket. Use after successful
  97. * curl_easy_perform() with CURLOPT_CONNECT_ONLY option.
  98. */
  99. CURL_EXTERN CURLcode curl_easy_send(CURL *curl, const void *buffer,
  100. size_t buflen, size_t *n);
  101. /*
  102. * NAME curl_easy_upkeep()
  103. *
  104. * DESCRIPTION
  105. *
  106. * Performs connection upkeep for the given session handle.
  107. */
  108. CURL_EXTERN CURLcode curl_easy_upkeep(CURL *curl);
  109. #ifdef __cplusplus
  110. } /* end of extern "C" */
  111. #endif
  112. #endif