xref: /curl/lib/url.h (revision 1be704e1)
1 #ifndef HEADER_CURL_URL_H
2 #define HEADER_CURL_URL_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 #include "curl_setup.h"
27 
28 /*
29  * Prototypes for library-wide functions provided by url.c
30  */
31 
32 CURLcode Curl_init_do(struct Curl_easy *data, struct connectdata *conn);
33 CURLcode Curl_open(struct Curl_easy **curl);
34 CURLcode Curl_init_userdefined(struct Curl_easy *data);
35 
36 void Curl_freeset(struct Curl_easy *data);
37 CURLcode Curl_uc_to_curlcode(CURLUcode uc);
38 CURLcode Curl_close(struct Curl_easy **datap); /* opposite of curl_open() */
39 CURLcode Curl_connect(struct Curl_easy *, bool *async, bool *protocol_connect);
40 bool Curl_on_disconnect(struct Curl_easy *data,
41                         struct connectdata *, bool aborted);
42 CURLcode Curl_setup_conn(struct Curl_easy *data,
43                          bool *protocol_done);
44 void Curl_conn_free(struct Curl_easy *data, struct connectdata *conn);
45 CURLcode Curl_parse_login_details(const char *login, const size_t len,
46                                   char **userptr, char **passwdptr,
47                                   char **optionsptr);
48 
49 /* Get protocol handler for a URI scheme
50  * @param scheme URI scheme, case-insensitive
51  * @return NULL of handler not found
52  */
53 const struct Curl_handler *Curl_get_scheme_handler(const char *scheme);
54 const struct Curl_handler *Curl_getn_scheme_handler(const char *scheme,
55                                                     size_t len);
56 
57 #define CURL_DEFAULT_PROXY_PORT 1080 /* default proxy port unless specified */
58 #define CURL_DEFAULT_HTTPS_PROXY_PORT 443 /* default https proxy port unless
59                                              specified */
60 
61 #ifdef CURL_DISABLE_VERBOSE_STRINGS
62 #define Curl_verboseconnect(x,y,z)  Curl_nop_stmt
63 #else
64 void Curl_verboseconnect(struct Curl_easy *data, struct connectdata *conn,
65                          int sockindex);
66 #endif
67 
68 /**
69  * Return TRUE iff the given connection is considered dead.
70  * @param nowp      NULL or pointer to time being checked against.
71  */
72 bool Curl_conn_seems_dead(struct connectdata *conn,
73                           struct Curl_easy *data,
74                           struct curltime *nowp);
75 
76 /**
77  * Perform upkeep operations on the connection.
78  */
79 CURLcode Curl_conn_upkeep(struct Curl_easy *data,
80                           struct connectdata *conn,
81                           struct curltime *now);
82 
83 #if defined(USE_HTTP2) || defined(USE_HTTP3)
84 void Curl_data_priority_clear_state(struct Curl_easy *data);
85 #else
86 #define Curl_data_priority_clear_state(x)
87 #endif /* !(defined(USE_HTTP2) || defined(USE_HTTP3)) */
88 
89 #ifdef USE_NGHTTP2
90 CURLcode Curl_data_priority_add_child(struct Curl_easy *parent,
91                                       struct Curl_easy *child,
92                                       bool exclusive);
93 #else
94 #define Curl_data_priority_add_child(x, y, z) CURLE_NOT_BUILT_IN
95 #endif
96 
97 #endif /* HEADER_CURL_URL_H */
98