126 lines
3.9 KiB
C
126 lines
3.9 KiB
C
#ifndef CURLINC_EASY_H
|
|
#define CURLINC_EASY_H
|
|
/***************************************************************************
|
|
* _ _ ____ _
|
|
* Project ___| | | | _ \| |
|
|
* / __| | | | |_) | |
|
|
* | (__| |_| | _ <| |___
|
|
* \___|\___/|_| \_\_____|
|
|
*
|
|
* Copyright (C) Daniel Stenberg, <daniel@haxx.se>, et al.
|
|
*
|
|
* This software is licensed as described in the file COPYING, which
|
|
* you should have received as part of this distribution. The terms
|
|
* are also available at https://curl.se/docs/copyright.html.
|
|
*
|
|
* You may opt to use, copy, modify, merge, publish, distribute and/or sell
|
|
* copies of the Software, and permit persons to whom the Software is
|
|
* furnished to do so, under the terms of the COPYING file.
|
|
*
|
|
* This software is distributed on an "AS IS" basis, WITHOUT WARRANTY OF ANY
|
|
* KIND, either express or implied.
|
|
*
|
|
* SPDX-License-Identifier: curl
|
|
*
|
|
***************************************************************************/
|
|
#ifdef __cplusplus
|
|
extern "C" {
|
|
#endif
|
|
|
|
/* Flag bits in the curl_blob struct: */
|
|
#define CURL_BLOB_COPY 1 /* tell libcurl to copy the data */
|
|
#define CURL_BLOB_NOCOPY 0 /* tell libcurl to NOT copy the data */
|
|
|
|
struct curl_blob {
|
|
void *data;
|
|
size_t len;
|
|
unsigned int flags; /* bit 0 is defined, the rest are reserved and should be
|
|
left zeroes */
|
|
};
|
|
|
|
CURL_EXTERN CURL *curl_easy_init(void);
|
|
CURL_EXTERN CURLcode curl_easy_setopt(CURL *curl, CURLoption option, ...);
|
|
CURL_EXTERN CURLcode curl_easy_perform(CURL *curl);
|
|
CURL_EXTERN void curl_easy_cleanup(CURL *curl);
|
|
|
|
/*
|
|
* NAME curl_easy_getinfo()
|
|
*
|
|
* DESCRIPTION
|
|
*
|
|
* Request internal information from the curl session with this function.
|
|
* The third argument MUST be pointing to the specific type of the used option
|
|
* which is documented in each man page of the option. The data pointed to
|
|
* will be filled in accordingly and can be relied upon only if the function
|
|
* returns CURLE_OK. This function is intended to get used *AFTER* a performed
|
|
* transfer, all results from this function are undefined until the transfer
|
|
* is completed.
|
|
*/
|
|
CURL_EXTERN CURLcode curl_easy_getinfo(CURL *curl, CURLINFO info, ...);
|
|
|
|
|
|
/*
|
|
* NAME curl_easy_duphandle()
|
|
*
|
|
* DESCRIPTION
|
|
*
|
|
* Creates a new curl session handle with the same options set for the handle
|
|
* passed in. Duplicating a handle could only be a matter of cloning data and
|
|
* options, internal state info and things like persistent connections cannot
|
|
* be transferred. It is useful in multithreaded applications when you can run
|
|
* curl_easy_duphandle() for each new thread to avoid a series of identical
|
|
* curl_easy_setopt() invokes in every thread.
|
|
*/
|
|
CURL_EXTERN CURL *curl_easy_duphandle(CURL *curl);
|
|
|
|
/*
|
|
* NAME curl_easy_reset()
|
|
*
|
|
* DESCRIPTION
|
|
*
|
|
* Re-initializes a CURL handle to the default values. This puts back the
|
|
* handle to the same state as it was in when it was just created.
|
|
*
|
|
* It does keep: live connections, the Session ID cache, the DNS cache and the
|
|
* cookies.
|
|
*/
|
|
CURL_EXTERN void curl_easy_reset(CURL *curl);
|
|
|
|
/*
|
|
* NAME curl_easy_recv()
|
|
*
|
|
* DESCRIPTION
|
|
*
|
|
* Receives data from the connected socket. Use after successful
|
|
* curl_easy_perform() with CURLOPT_CONNECT_ONLY option.
|
|
*/
|
|
CURL_EXTERN CURLcode curl_easy_recv(CURL *curl, void *buffer, size_t buflen,
|
|
size_t *n);
|
|
|
|
/*
|
|
* NAME curl_easy_send()
|
|
*
|
|
* DESCRIPTION
|
|
*
|
|
* Sends data over the connected socket. Use after successful
|
|
* curl_easy_perform() with CURLOPT_CONNECT_ONLY option.
|
|
*/
|
|
CURL_EXTERN CURLcode curl_easy_send(CURL *curl, const void *buffer,
|
|
size_t buflen, size_t *n);
|
|
|
|
|
|
/*
|
|
* NAME curl_easy_upkeep()
|
|
*
|
|
* DESCRIPTION
|
|
*
|
|
* Performs connection upkeep for the given session handle.
|
|
*/
|
|
CURL_EXTERN CURLcode curl_easy_upkeep(CURL *curl);
|
|
|
|
#ifdef __cplusplus
|
|
} /* end of extern "C" */
|
|
#endif
|
|
|
|
#endif
|