easy.h 3.9 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123
  1. #ifndef CURLINC_EASY_H
  2. #define CURLINC_EASY_H
  3. /***************************************************************************
  4. * _ _ ____ _
  5. * Project ___| | | | _ \| |
  6. * / __| | | | |_) | |
  7. * | (__| |_| | _ <| |___
  8. * \___|\___/|_| \_\_____|
  9. *
  10. * Copyright (C) 1998 - 2020, 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.haxx.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. ***************************************************************************/
  24. #ifdef __cplusplus
  25. extern "C" {
  26. #endif
  27. /* Flag bits in the curl_blob struct: */
  28. #define CURL_BLOB_COPY 1 /* tell libcurl to copy the data */
  29. #define CURL_BLOB_NOCOPY 0 /* tell libcurl to NOT copy the data */
  30. struct curl_blob {
  31. void *data;
  32. size_t len;
  33. unsigned int flags; /* bit 0 is defined, the rest are reserved and should be
  34. left zeroes */
  35. };
  36. CURL_EXTERN CURL *curl_easy_init(void);
  37. CURL_EXTERN CURLcode curl_easy_setopt(CURL *curl, CURLoption option, ...);
  38. CURL_EXTERN CURLcode curl_easy_perform(CURL *curl);
  39. CURL_EXTERN void curl_easy_cleanup(CURL *curl);
  40. /*
  41. * NAME curl_easy_getinfo()
  42. *
  43. * DESCRIPTION
  44. *
  45. * Request internal information from the curl session with this function. The
  46. * third argument MUST be a pointer to a long, a pointer to a char * or a
  47. * pointer to a double (as the documentation describes elsewhere). The data
  48. * pointed to will be filled in accordingly and can be relied upon only if the
  49. * function returns CURLE_OK. This function is intended to get used *AFTER* a
  50. * performed transfer, all results from this function are undefined until the
  51. * transfer is completed.
  52. */
  53. CURL_EXTERN CURLcode curl_easy_getinfo(CURL *curl, CURLINFO info, ...);
  54. /*
  55. * NAME curl_easy_duphandle()
  56. *
  57. * DESCRIPTION
  58. *
  59. * Creates a new curl session handle with the same options set for the handle
  60. * passed in. Duplicating a handle could only be a matter of cloning data and
  61. * options, internal state info and things like persistent connections cannot
  62. * be transferred. It is useful in multithreaded applications when you can run
  63. * curl_easy_duphandle() for each new thread to avoid a series of identical
  64. * curl_easy_setopt() invokes in every thread.
  65. */
  66. CURL_EXTERN CURL *curl_easy_duphandle(CURL *curl);
  67. /*
  68. * NAME curl_easy_reset()
  69. *
  70. * DESCRIPTION
  71. *
  72. * Re-initializes a CURL handle to the default values. This puts back the
  73. * handle to the same state as it was in when it was just created.
  74. *
  75. * It does keep: live connections, the Session ID cache, the DNS cache and the
  76. * cookies.
  77. */
  78. CURL_EXTERN void curl_easy_reset(CURL *curl);
  79. /*
  80. * NAME curl_easy_recv()
  81. *
  82. * DESCRIPTION
  83. *
  84. * Receives data from the connected socket. Use after successful
  85. * curl_easy_perform() with CURLOPT_CONNECT_ONLY option.
  86. */
  87. CURL_EXTERN CURLcode curl_easy_recv(CURL *curl, void *buffer, size_t buflen,
  88. size_t *n);
  89. /*
  90. * NAME curl_easy_send()
  91. *
  92. * DESCRIPTION
  93. *
  94. * Sends data over the connected socket. Use after successful
  95. * curl_easy_perform() with CURLOPT_CONNECT_ONLY option.
  96. */
  97. CURL_EXTERN CURLcode curl_easy_send(CURL *curl, const void *buffer,
  98. size_t buflen, size_t *n);
  99. /*
  100. * NAME curl_easy_upkeep()
  101. *
  102. * DESCRIPTION
  103. *
  104. * Performs connection upkeep for the given session handle.
  105. */
  106. CURL_EXTERN CURLcode curl_easy_upkeep(CURL *curl);
  107. #ifdef __cplusplus
  108. }
  109. #endif
  110. #endif