mirror of
https://github.com/curl/curl.git
synced 2026-04-18 04:11:40 +03: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
106 lines
4.3 KiB
C
106 lines
4.3 KiB
C
#ifndef HEADER_CURL_CSHUTDN_H
|
|
#define HEADER_CURL_CSHUTDN_H
|
|
/***************************************************************************
|
|
* _ _ ____ _
|
|
* Project ___| | | | _ \| |
|
|
* / __| | | | |_) | |
|
|
* | (__| |_| | _ <| |___
|
|
* \___|\___/|_| \_\_____|
|
|
*
|
|
* Copyright (C) Daniel Stenberg, <daniel@haxx.se>, et al.
|
|
* Copyright (C) Linus Nielsen Feltzing, <linus@haxx.se>
|
|
*
|
|
* 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
|
|
*
|
|
***************************************************************************/
|
|
struct connectdata;
|
|
struct Curl_easy;
|
|
struct curl_pollfds;
|
|
struct Curl_waitfds;
|
|
struct Curl_multi;
|
|
struct Curl_share;
|
|
struct Curl_sigpipe_ctx;
|
|
|
|
/* Run the shutdown of the connection once.
|
|
* Will shortly attach/detach `data` to `conn` while doing so.
|
|
* `done` will be set TRUE if any error was encountered or if
|
|
* the connection was shut down completely. */
|
|
void Curl_cshutdn_run_once(struct Curl_easy *data,
|
|
struct connectdata *conn,
|
|
bool *done);
|
|
|
|
/* Terminates the connection, e.g. closes and destroys it.
|
|
* If `do_shutdown` is TRUE, the shutdown will be run once before
|
|
* terminating it.
|
|
* Takes ownership of `conn`. */
|
|
void Curl_cshutdn_terminate(struct Curl_easy *data,
|
|
struct connectdata *conn,
|
|
bool do_shutdown);
|
|
|
|
/* A `cshutdown` is always owned by a multi handle to maintain
|
|
* the connections to be shut down. It registers timers and
|
|
* sockets to monitor via the multi handle. */
|
|
struct cshutdn {
|
|
struct Curl_llist list; /* connections being shut down */
|
|
struct Curl_multi *multi; /* the multi owning this */
|
|
BIT(initialised);
|
|
};
|
|
|
|
/* Init as part of the given multi handle. */
|
|
int Curl_cshutdn_init(struct cshutdn *cshutdn,
|
|
struct Curl_multi *multi);
|
|
|
|
/* Terminate all remaining connections and free resources. */
|
|
void Curl_cshutdn_destroy(struct cshutdn *cshutdn,
|
|
struct Curl_easy *data);
|
|
|
|
/* Number of connections being shut down. */
|
|
size_t Curl_cshutdn_count(struct Curl_easy *data);
|
|
|
|
/* Number of connections to the destination being shut down. */
|
|
size_t Curl_cshutdn_dest_count(struct Curl_easy *data,
|
|
const char *destination);
|
|
|
|
/* Close the oldest connection in shutdown to destination or,
|
|
* when destination is NULL for any destination.
|
|
* Return TRUE if a connection has been closed. */
|
|
bool Curl_cshutdn_close_oldest(struct Curl_easy *data,
|
|
const char *destination);
|
|
|
|
/* Add a connection to have it shut down. Will terminate the oldest
|
|
* connection when total connection limit of multi is being reached. */
|
|
void Curl_cshutdn_add(struct cshutdn *cshutdn,
|
|
struct connectdata *conn,
|
|
size_t conns_in_pool);
|
|
|
|
/* Add sockets and POLLIN/OUT flags for connections being shut down. */
|
|
CURLcode Curl_cshutdn_add_pollfds(struct cshutdn *cshutdn,
|
|
struct Curl_easy *data,
|
|
struct curl_pollfds *cpfds);
|
|
|
|
unsigned int Curl_cshutdn_add_waitfds(struct cshutdn *cshutdn,
|
|
struct Curl_easy *data,
|
|
struct Curl_waitfds *cwfds);
|
|
|
|
void Curl_cshutdn_setfds(struct cshutdn *cshutdn,
|
|
struct Curl_easy *data,
|
|
fd_set *read_fd_set, fd_set *write_fd_set,
|
|
int *maxfd);
|
|
|
|
/* Run maintenance on all connections. */
|
|
void Curl_cshutdn_perform(struct cshutdn *cshutdn,
|
|
struct Curl_easy *data,
|
|
struct Curl_sigpipe_ctx *sigpipe_ctx);
|
|
|
|
#endif /* HEADER_CURL_CSHUTDN_H */
|