easy.h 3.4 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103
  1. #ifndef __CURL_EASY_H
  2. #define __CURL_EASY_H
  3. /***************************************************************************
  4. * _ _ ____ _
  5. * Project ___| | | | _ \| |
  6. * / __| | | | |_) | |
  7. * | (__| |_| | _ <| |___
  8. * \___|\___/|_| \_\_____|
  9. *
  10. * Copyright (C) 1998 - 2008, 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 http://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. * $Id: easy.h,v 1.14 2008-05-12 21:43:28 bagder Exp $
  24. ***************************************************************************/
  25. #ifdef __cplusplus
  26. extern "C" {
  27. #endif
  28. CURL_EXTERN CURL *curl_easy_init(void);
  29. CURL_EXTERN CURLcode curl_easy_setopt(CURL *curl, CURLoption option, ...);
  30. CURL_EXTERN CURLcode curl_easy_perform(CURL *curl);
  31. CURL_EXTERN void curl_easy_cleanup(CURL *curl);
  32. /*
  33. * NAME curl_easy_getinfo()
  34. *
  35. * DESCRIPTION
  36. *
  37. * Request internal information from the curl session with this function. The
  38. * third argument MUST be a pointer to a long, a pointer to a char * or a
  39. * pointer to a double (as the documentation describes elsewhere). The data
  40. * pointed to will be filled in accordingly and can be relied upon only if the
  41. * function returns CURLE_OK. This function is intended to get used *AFTER* a
  42. * performed transfer, all results from this function are undefined until the
  43. * transfer is completed.
  44. */
  45. CURL_EXTERN CURLcode curl_easy_getinfo(CURL *curl, CURLINFO info, ...);
  46. /*
  47. * NAME curl_easy_duphandle()
  48. *
  49. * DESCRIPTION
  50. *
  51. * Creates a new curl session handle with the same options set for the handle
  52. * passed in. Duplicating a handle could only be a matter of cloning data and
  53. * options, internal state info and things like persistant connections cannot
  54. * be transfered. It is useful in multithreaded applications when you can run
  55. * curl_easy_duphandle() for each new thread to avoid a series of identical
  56. * curl_easy_setopt() invokes in every thread.
  57. */
  58. CURL_EXTERN CURL* curl_easy_duphandle(CURL *curl);
  59. /*
  60. * NAME curl_easy_reset()
  61. *
  62. * DESCRIPTION
  63. *
  64. * Re-initializes a CURL handle to the default values. This puts back the
  65. * handle to the same state as it was in when it was just created.
  66. *
  67. * It does keep: live connections, the Session ID cache, the DNS cache and the
  68. * cookies.
  69. */
  70. CURL_EXTERN void curl_easy_reset(CURL *curl);
  71. /*
  72. * NAME curl_easy_recv()
  73. *
  74. * DESCRIPTION
  75. *
  76. * Receives data from the connected socket. Use after successful
  77. * curl_easy_perform() with CURLOPT_CONNECT_ONLY option.
  78. */
  79. CURL_EXTERN CURLcode curl_easy_recv(CURL *curl, void *buffer, size_t buflen,
  80. size_t *n);
  81. /*
  82. * NAME curl_easy_send()
  83. *
  84. * DESCRIPTION
  85. *
  86. * Sends data over the connected socket. Use after successful
  87. * curl_easy_perform() with CURLOPT_CONNECT_ONLY option.
  88. */
  89. CURL_EXTERN CURLcode curl_easy_send(CURL *curl, const void *buffer,
  90. size_t buflen, size_t *n);
  91. #ifdef __cplusplus
  92. }
  93. #endif
  94. #endif