2011-07-26 23:23:27 +08:00
|
|
|
#ifndef HEADER_CURL_URL_H
|
|
|
|
|
#define HEADER_CURL_URL_H
|
2002-09-03 19:52:59 +08:00
|
|
|
/***************************************************************************
|
2004-05-17 16:05:46 +08:00
|
|
|
* _ _ ____ _
|
|
|
|
|
* Project ___| | | | _ \| |
|
|
|
|
|
* / __| | | | |_) | |
|
|
|
|
|
* | (__| |_| | _ <| |___
|
2000-05-22 22:12:12 +08:00
|
|
|
* \___|\___/|_| \_\_____|
|
|
|
|
|
*
|
2023-01-02 20:51:48 +08:00
|
|
|
* Copyright (C) Daniel Stenberg, <daniel@haxx.se>, et al.
|
2000-05-22 22:12:12 +08:00
|
|
|
*
|
2002-09-03 19:52:59 +08:00
|
|
|
* This software is licensed as described in the file COPYING, which
|
|
|
|
|
* you should have received as part of this distribution. The terms
|
2020-11-04 21:02:01 +08:00
|
|
|
* are also available at https://curl.se/docs/copyright.html.
|
2004-05-17 16:05:46 +08:00
|
|
|
*
|
2001-01-03 17:29:33 +08:00
|
|
|
* 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
|
2002-09-03 19:52:59 +08:00
|
|
|
* furnished to do so, under the terms of the COPYING file.
|
2000-05-22 22:12:12 +08:00
|
|
|
*
|
2001-01-03 17:29:33 +08:00
|
|
|
* This software is distributed on an "AS IS" basis, WITHOUT WARRANTY OF ANY
|
|
|
|
|
* KIND, either express or implied.
|
2000-05-22 22:12:12 +08:00
|
|
|
*
|
2002-09-03 19:52:59 +08:00
|
|
|
* SPDX-License-Identifier: curl
|
2022-05-17 17:16:50 +08:00
|
|
|
*
|
2002-09-03 19:52:59 +08:00
|
|
|
***************************************************************************/
|
2013-01-07 02:06:49 +08:00
|
|
|
#include "curl_setup.h"
|
2001-01-05 18:11:41 +08:00
|
|
|
|
2001-08-15 14:53:34 +08:00
|
|
|
/*
|
2013-01-04 09:50:28 +08:00
|
|
|
* Prototypes for library-wide functions provided by url.c
|
2001-08-15 14:53:34 +08:00
|
|
|
*/
|
|
|
|
|
|
2016-06-21 21:47:12 +08:00
|
|
|
CURLcode Curl_init_do(struct Curl_easy *data, struct connectdata *conn);
|
|
|
|
|
CURLcode Curl_open(struct Curl_easy **curl);
|
2017-12-21 02:33:50 +08:00
|
|
|
CURLcode Curl_init_userdefined(struct Curl_easy *data);
|
2018-07-13 23:17:19 +08:00
|
|
|
|
2020-05-13 18:56:53 +08:00
|
|
|
void Curl_freeset(struct Curl_easy *data);
|
2018-10-22 06:09:49 +08:00
|
|
|
CURLcode Curl_uc_to_curlcode(CURLUcode uc);
|
2019-10-28 16:28:05 +08:00
|
|
|
CURLcode Curl_close(struct Curl_easy **datap); /* opposite of curl_open() */
|
2019-01-03 01:04:58 +08:00
|
|
|
CURLcode Curl_connect(struct Curl_easy *, bool *async, bool *protocol_connect);
|
2022-01-19 20:57:30 +08:00
|
|
|
void Curl_disconnect(struct Curl_easy *data,
|
lib: graceful connection shutdown
When libcurl discards a connection there are two phases this may go
through: "shutdown" and "closing". If a connection is aborted, the
shutdown phase is skipped and it is closed right away.
The connection filters attached to the connection implement the phases
in their `do_shutdown()` and `do_close()` callbacks. Filters carry now a
`shutdown` flags next to `connected` to keep track of the shutdown
operation.
Filters are shut down from top to bottom. If a filter is not connected,
its shutdown is skipped. Notable filters that *do* something during
shutdown are HTTP/2 and TLS. HTTP/2 sends the GOAWAY frame. TLS sends
its close notify and expects to receive a close notify from the server.
As sends and receives may EAGAIN on the network, a shutdown is often not
successful right away and needs to poll the connection's socket(s). To
facilitate this, such connections are placed on a new shutdown list
inside the connection cache.
Since managing this list requires the cooperation of a multi handle,
only the connection cache belonging to a multi handle is used. If a
connection was in another cache when being discarded, it is removed
there and added to the multi's cache. If no multi handle is available at
that time, the connection is shutdown and closed in a one-time,
best-effort attempt.
When a multi handle is destroyed, all connection still on the shutdown
list are discarded with a final shutdown attempt and close. In curl
debug builds, the environment variable `CURL_GRACEFUL_SHUTDOWN` can be
set to make this graceful with a timeout in milliseconds given by the
variable.
The shutdown list is limited to the max number of connections configured
for a multi cache. Set via CURLMOPT_MAX_TOTAL_CONNECTIONS. When the
limit is reached, the oldest connection on the shutdown list is
discarded.
- In multi_wait() and multi_waitfds(), collect all connection caches
involved (each transfer might carry its own) into a temporary list.
Let each connection cache on the list contribute sockets and
POLLIN/OUT events it's connections are waiting for.
- in multi_perform() collect the connection caches the same way and let
them peform their maintenance. This will make another non-blocking
attempt to shutdown all connections on its shutdown list.
- for event based multis (multi->socket_cb set), add the sockets and
their poll events via the callback. When `multi_socket()` is invoked
for a socket not known by an active transfer, forward this to the
multi's cache for processing. On closing a connection, remove its
socket(s) via the callback.
TLS connection filters MUST NOT send close nofity messages in their
`do_close()` implementation. The reason is that a TLS close notify
signals a success. When a connection is aborted and skips its shutdown
phase, the server needs to see a missing close notify to detect
something has gone wrong.
A graceful shutdown of FTP's data connection is performed implicitly
before regarding the upload/download as complete and continuing on the
control connection. For FTP without TLS, there is just the socket close
happening. But with TLS, the sent/received close notify signals that the
transfer is complete and healthy. Servers like `vsftpd` verify that and
reject uploads without a TLS close notify.
- added test_19_* for shutdown related tests
- test_19_01 and test_19_02 test for TCP RST packets
which happen without a graceful shutdown and should
no longer appear otherwise.
- add test_19_03 for handling shutdowns by the server
- add test_19_04 for handling shutdowns by curl
- add test_19_05 for event based shutdowny by server
- add test_30_06/07 and test_31_06/07 for shutdown checks
on FTP up- and downloads.
Closes #13976
2024-06-19 18:40:06 +08:00
|
|
|
struct connectdata *, bool aborted);
|
2021-01-25 06:32:24 +08:00
|
|
|
CURLcode Curl_setup_conn(struct Curl_easy *data,
|
2011-01-31 07:10:35 +08:00
|
|
|
bool *protocol_done);
|
lib: graceful connection shutdown
When libcurl discards a connection there are two phases this may go
through: "shutdown" and "closing". If a connection is aborted, the
shutdown phase is skipped and it is closed right away.
The connection filters attached to the connection implement the phases
in their `do_shutdown()` and `do_close()` callbacks. Filters carry now a
`shutdown` flags next to `connected` to keep track of the shutdown
operation.
Filters are shut down from top to bottom. If a filter is not connected,
its shutdown is skipped. Notable filters that *do* something during
shutdown are HTTP/2 and TLS. HTTP/2 sends the GOAWAY frame. TLS sends
its close notify and expects to receive a close notify from the server.
As sends and receives may EAGAIN on the network, a shutdown is often not
successful right away and needs to poll the connection's socket(s). To
facilitate this, such connections are placed on a new shutdown list
inside the connection cache.
Since managing this list requires the cooperation of a multi handle,
only the connection cache belonging to a multi handle is used. If a
connection was in another cache when being discarded, it is removed
there and added to the multi's cache. If no multi handle is available at
that time, the connection is shutdown and closed in a one-time,
best-effort attempt.
When a multi handle is destroyed, all connection still on the shutdown
list are discarded with a final shutdown attempt and close. In curl
debug builds, the environment variable `CURL_GRACEFUL_SHUTDOWN` can be
set to make this graceful with a timeout in milliseconds given by the
variable.
The shutdown list is limited to the max number of connections configured
for a multi cache. Set via CURLMOPT_MAX_TOTAL_CONNECTIONS. When the
limit is reached, the oldest connection on the shutdown list is
discarded.
- In multi_wait() and multi_waitfds(), collect all connection caches
involved (each transfer might carry its own) into a temporary list.
Let each connection cache on the list contribute sockets and
POLLIN/OUT events it's connections are waiting for.
- in multi_perform() collect the connection caches the same way and let
them peform their maintenance. This will make another non-blocking
attempt to shutdown all connections on its shutdown list.
- for event based multis (multi->socket_cb set), add the sockets and
their poll events via the callback. When `multi_socket()` is invoked
for a socket not known by an active transfer, forward this to the
multi's cache for processing. On closing a connection, remove its
socket(s) via the callback.
TLS connection filters MUST NOT send close nofity messages in their
`do_close()` implementation. The reason is that a TLS close notify
signals a success. When a connection is aborted and skips its shutdown
phase, the server needs to see a missing close notify to detect
something has gone wrong.
A graceful shutdown of FTP's data connection is performed implicitly
before regarding the upload/download as complete and continuing on the
control connection. For FTP without TLS, there is just the socket close
happening. But with TLS, the sent/received close notify signals that the
transfer is complete and healthy. Servers like `vsftpd` verify that and
reject uploads without a TLS close notify.
- added test_19_* for shutdown related tests
- test_19_01 and test_19_02 test for TCP RST packets
which happen without a graceful shutdown and should
no longer appear otherwise.
- add test_19_03 for handling shutdowns by the server
- add test_19_04 for handling shutdowns by curl
- add test_19_05 for event based shutdowny by server
- add test_30_06/07 and test_31_06/07 for shutdown checks
on FTP up- and downloads.
Closes #13976
2024-06-19 18:40:06 +08:00
|
|
|
void Curl_conn_free(struct Curl_easy *data, struct connectdata *conn);
|
2017-11-11 00:45:54 +08:00
|
|
|
CURLcode Curl_parse_login_details(const char *login, const size_t len,
|
|
|
|
|
char **userptr, char **passwdptr,
|
|
|
|
|
char **optionsptr);
|
2006-09-08 05:49:20 +08:00
|
|
|
|
2023-10-27 17:53:26 +08:00
|
|
|
/* Get protocol handler for a URI scheme
|
|
|
|
|
* @param scheme URI scheme, case-insensitive
|
|
|
|
|
* @return NULL of handler not found
|
|
|
|
|
*/
|
|
|
|
|
const struct Curl_handler *Curl_get_scheme_handler(const char *scheme);
|
|
|
|
|
const struct Curl_handler *Curl_getn_scheme_handler(const char *scheme,
|
|
|
|
|
size_t len);
|
2018-08-05 17:51:07 +08:00
|
|
|
|
2008-04-06 05:13:31 +08:00
|
|
|
#define CURL_DEFAULT_PROXY_PORT 1080 /* default proxy port unless specified */
|
2016-11-25 02:40:30 +08:00
|
|
|
#define CURL_DEFAULT_HTTPS_PROXY_PORT 443 /* default https proxy port unless
|
|
|
|
|
specified */
|
2008-04-06 05:13:31 +08:00
|
|
|
|
2010-05-08 05:49:29 +08:00
|
|
|
#ifdef CURL_DISABLE_VERBOSE_STRINGS
|
2024-03-08 17:45:14 +08:00
|
|
|
#define Curl_verboseconnect(x,y,z) Curl_nop_stmt
|
2010-05-08 05:49:29 +08:00
|
|
|
#else
|
2024-03-08 17:45:14 +08:00
|
|
|
void Curl_verboseconnect(struct Curl_easy *data, struct connectdata *conn,
|
|
|
|
|
int sockindex);
|
2010-05-08 05:49:29 +08:00
|
|
|
#endif
|
|
|
|
|
|
2022-12-30 16:14:55 +08:00
|
|
|
#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 /* !(defined(USE_HTTP2) || defined(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
|
|
|
|
|
|
2011-07-26 23:23:27 +08:00
|
|
|
#endif /* HEADER_CURL_URL_H */
|
