mirror of
https://github.com/curl/curl.git
synced 2026-04-11 12:01:42 +08:00
c878160e9c
Discovered with clang-tidy checker `readability-inconsistent-declaration-parameter-name`. Also: - do not enforce the above because of inconsistencies still present between public API prototypes and definitions. (Also betwen man page protos, and man page examples, and other parts of the code, e.g. `easy` vs `curl` vs `d` vs `handle`) Perhaps subject for a future effort: https://github.com/curl/curl/actions/runs/22166472728/job/64094691653 - enable and fix `readability-named-parameter` where missing. Refs: https://clang.llvm.org/extra/clang-tidy/checks/readability/inconsistent-declaration-parameter-name.html https://clang.llvm.org/extra/clang-tidy/checks/readability/named-parameter.html Closes #20624
123 lines
4.8 KiB
C
123 lines
4.8 KiB
C
#ifndef HEADER_CURL_URL_H
|
|
#define HEADER_CURL_URL_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
|
|
*
|
|
***************************************************************************/
|
|
#include "curl_setup.h"
|
|
|
|
/*
|
|
* Prototypes for library-wide functions provided by url.c
|
|
*/
|
|
|
|
CURLcode Curl_init_do(struct Curl_easy *data, struct connectdata *conn);
|
|
CURLcode Curl_open(struct Curl_easy **curl);
|
|
void Curl_init_userdefined(struct Curl_easy *data);
|
|
|
|
void Curl_freeset(struct Curl_easy *data);
|
|
CURLcode Curl_uc_to_curlcode(CURLUcode uc);
|
|
CURLcode Curl_close(struct Curl_easy **datap); /* opposite of Curl_open() */
|
|
CURLcode Curl_connect(struct Curl_easy *data,
|
|
bool *asyncp,
|
|
bool *protocol_done);
|
|
CURLcode Curl_setup_conn(struct Curl_easy *data,
|
|
struct Curl_dns_entry *dns,
|
|
bool *protocol_done);
|
|
void Curl_conn_free(struct Curl_easy *data, struct connectdata *conn);
|
|
CURLcode Curl_parse_login_details(const char *login, const size_t len,
|
|
char **userp, char **passwdp,
|
|
char **optionsp);
|
|
|
|
/* Attach/Clear/Get meta data for an easy handle. Needs to provide
|
|
* a destructor, will be automatically called when the easy handle
|
|
* is reset or closed. */
|
|
typedef void Curl_meta_dtor(void *key, size_t key_len, void *meta_data);
|
|
|
|
/* Set the transfer meta data for the key. Any existing entry for that
|
|
* key will be destroyed.
|
|
* Takes ownership of `meta_data` and destroys it when the call fails. */
|
|
CURLcode Curl_meta_set(struct Curl_easy *data, const char *key,
|
|
void *meta_data, Curl_meta_dtor *meta_dtor);
|
|
void Curl_meta_remove(struct Curl_easy *data, const char *key);
|
|
void *Curl_meta_get(struct Curl_easy *data, const char *key);
|
|
void Curl_meta_reset(struct Curl_easy *data);
|
|
|
|
/* Set connection meta data for the key. Any existing entry for that
|
|
* key will be destroyed.
|
|
* Takes ownership of `meta_data` and destroys it when the call fails. */
|
|
CURLcode Curl_conn_meta_set(struct connectdata *conn, const char *key,
|
|
void *meta_data, Curl_meta_dtor *meta_dtor);
|
|
void Curl_conn_meta_remove(struct connectdata *conn, const char *key);
|
|
void *Curl_conn_meta_get(struct connectdata *conn, const char *key);
|
|
|
|
/* Get protocol handler for a URI scheme
|
|
* @param scheme URI scheme, case-insensitive
|
|
* @return NULL of handler not found
|
|
*/
|
|
const struct Curl_scheme *Curl_get_scheme(const char *scheme);
|
|
const struct Curl_scheme *Curl_getn_scheme(const char *scheme, size_t len);
|
|
|
|
#define CURL_DEFAULT_PROXY_PORT 1080 /* default proxy port unless specified */
|
|
#define CURL_DEFAULT_HTTPS_PROXY_PORT 443 /* default https proxy port unless
|
|
specified */
|
|
|
|
/**
|
|
* Return TRUE iff the given connection is considered dead.
|
|
*/
|
|
bool Curl_conn_seems_dead(struct connectdata *conn,
|
|
struct Curl_easy *data);
|
|
|
|
/**
|
|
* Perform upkeep operations on the connection.
|
|
*/
|
|
CURLcode Curl_conn_upkeep(struct Curl_easy *data,
|
|
struct connectdata *conn);
|
|
|
|
/**
|
|
* Always eval all arguments, return the first result != CURLE_OK.
|
|
* A non-short-circuit evaluation.
|
|
*/
|
|
CURLcode Curl_1st_err(CURLcode r1, CURLcode r2);
|
|
|
|
/**
|
|
* Always eval all arguments, return the first
|
|
* result != (CURLE_OK|CURLE_AGAIN) or `r1`.
|
|
* A non-short-circuit evaluation.
|
|
*/
|
|
CURLcode Curl_1st_fatal(CURLcode r1, CURLcode r2);
|
|
|
|
#if defined(USE_HTTP2) || defined(USE_HTTP3)
|
|
void Curl_data_priority_clear_state(struct Curl_easy *data);
|
|
#else
|
|
#define Curl_data_priority_clear_state(x)
|
|
#endif /* USE_HTTP2 || USE_HTTP3 */
|
|
|
|
#ifdef USE_NGHTTP2
|
|
CURLcode Curl_data_priority_add_child(struct Curl_easy *parent,
|
|
struct Curl_easy *child,
|
|
bool exclusive);
|
|
#else
|
|
#define Curl_data_priority_add_child(x, y, z) CURLE_NOT_BUILT_IN
|
|
#endif
|
|
|
|
#endif /* HEADER_CURL_URL_H */
|