cfc657a48d
Rework the event based handling of transfers and connections to be "localized" into a single source file with clearer dependencies. - add multi_ev.c and multi_ev.h - add docs/internal/MULTI-EV.md to explain the overall workings - only do event handling book keeping when the socket callback is set - add handling for "connection only" event tracking, when internal easy handles are used that are not really tied to a connection. Used in connection pool. - remove transfer member "last_poll" and connections "shutdown_poll" and keep all that internal to multi_ev.c - add CURL_TRC_M() for tracing of "multi" related things, including event handling and connection pool operations. Add new trace feature "multi" for trace config. multi traces will show exactly what is going on in regard to event handling. - multi: trace transfers "mstate" in every CURL_TRC_M() call - make internal trace buffer 2048 bytes and end the silliness with +n here -m there. Adjust test 1652 expectations of resulting length and input edge cases. - add trace feature "lib-ids" to perfix libcurl traces with transfer and connection ids. Useful for debugging libcurl applications. Closes #16308
80 lines
3.3 KiB
C
80 lines
3.3 KiB
C
#ifndef HEADER_CURL_MULTI_EV_H
|
|
#define HEADER_CURL_MULTI_EV_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
|
|
*
|
|
***************************************************************************/
|
|
|
|
struct Curl_easy;
|
|
struct Curl_multi;
|
|
struct easy_pollset;
|
|
|
|
struct curl_multi_ev {
|
|
struct Curl_hash sh_entries;
|
|
struct Curl_hash xfer_pollsets;
|
|
struct Curl_hash conn_pollsets;
|
|
};
|
|
|
|
/* Setup/teardown of multi event book-keeping. */
|
|
void Curl_multi_ev_init(struct Curl_multi *multi, size_t hashsize);
|
|
void Curl_multi_ev_cleanup(struct Curl_multi *multi);
|
|
|
|
/* Assign a 'user_data' to be passed to the socket callback when
|
|
* invoked with the given socket. This will fail if this socket
|
|
* is not active, e.g. the application has not been told to monitor it. */
|
|
CURLMcode Curl_multi_ev_assign(struct Curl_multi *multi, curl_socket_t s,
|
|
void *user_data);
|
|
|
|
/* Assess the transfer by getting its current pollset, compute
|
|
* any changes to the last one and inform the application's socket
|
|
* callback if things have changed. */
|
|
CURLMcode Curl_multi_ev_assess_xfer(struct Curl_multi *multi,
|
|
struct Curl_easy *data);
|
|
/* Assess all easy handles on the list */
|
|
CURLMcode Curl_multi_ev_assess_xfer_list(struct Curl_multi *multi,
|
|
struct Curl_llist *list);
|
|
/* Assess the connection by getting its current pollset */
|
|
CURLMcode Curl_multi_ev_assess_conn(struct Curl_multi *multi,
|
|
struct Curl_easy *data,
|
|
struct connectdata *conn);
|
|
|
|
/* Expire all transfers tied to the given socket */
|
|
void Curl_multi_ev_expire_xfers(struct Curl_multi *multi,
|
|
curl_socket_t s,
|
|
const struct curltime *nowp,
|
|
bool *run_cpool);
|
|
|
|
/* Socket will be closed, forget anything we know about it. */
|
|
void Curl_multi_ev_socket_done(struct Curl_multi *multi,
|
|
struct Curl_easy *data, curl_socket_t s);
|
|
|
|
/* Transfer is removed from the multi */
|
|
void Curl_multi_ev_xfer_done(struct Curl_multi *multi,
|
|
struct Curl_easy *data);
|
|
|
|
/* Connection is being destroyed */
|
|
void Curl_multi_ev_conn_done(struct Curl_multi *multi,
|
|
struct Curl_easy *data,
|
|
struct connectdata *conn);
|
|
|
|
#endif /* HEADER_CURL_MULTI_EV_H */
|