romenskiy2012/curl
1
0
Fork 0
mirror of https://github.com/curl/curl.git synced 2026-06-15 09:45:36 +03:00
Code Issues Projects Releases Packages Wiki Activity

cf-ip-happy: update documentation

Browse source 
Reported-by: correctmost on github
Fixes #21957
Closes #21959
This commit is contained in:
Stefan Eissing 2026-06-11 08:29:22 +02:00 • committed by Daniel Stenberg
parent 30c9c79cf8
commit 946306b3e5
No known key found for this signature in database
GPG key ID: 5CC908FDB71E12C2
2 changed files with 11 additions and 18 deletions
Download patch file Download diff file Expand all files Collapse all files

10
lib/cf-ip-happy.c
View file

@ -989,16 +989,6 @@ struct Curl_cftype Curl_cft_ip_happy = {
cf_ip_happy_query,
};
/**
* Create an IP happy eyeball connection filter that uses the, once resolved,
* address information to connect on ip families based on connection
* configuration.
* @param pcf output, the created cfilter
* @param data easy handle used in creation
* @param conn connection the filter is created for
* @param cf_create method to create the sub-filters performing the
* actual connects.
*/
static CURLcode cf_ip_happy_create(struct Curl_cfilter **pcf,
struct Curl_easy *data,
struct Curl_peer *origin,

19
lib/cf-ip-happy.h
View file

@ -33,18 +33,15 @@ struct Curl_peer;
struct Curl_sockaddr_ex;
/**
* Create a cfilter for making an "ip" connect to a peer.
* Create a cfilter to connect to `origin` via an optional `peer`
* using `transport_peer` and `addr`.
* With a `tunnel_peer` present, the filter will be used to proxy tunnel
* to it and the tunnel will use `tunnel_transport`.
* `pcf`: the filter created on success
* `data`: the transfer initiating the connect
* `peer`: the peer to connect to
* `transport_peer': the transport used for the peer connect
* `conn`: the connection that gets connected
* `addr`: the socket address to connect to
* `tunnel_peer`: NULL or the peer to tunnel through
* `tunnel_transport`: the transport that goes through the tunnel
*
* Such a filter may be used in "happy eyeball" scenarios, and its
* `connect` implementation needs to support non-blocking. Once connected,
* The filter is used in "happy eyeball" scenarios. Once connected,
* it MAY be installed in the connection filter chain to serve transfers.
*/
typedef CURLcode cf_ip_connect_create(struct Curl_cfilter **pcf,
@ -57,6 +54,12 @@ typedef CURLcode cf_ip_connect_create(struct Curl_cfilter **pcf,
struct Curl_peer *tunnel_peer,
uint8_t tunnel_transport);
/**
* Create an IP happy eyeball connection filter that connects to `origin`
* via an optional `peer` using `transport_peer`.
* With a `tunnel_peer` present, the filter will be used to proxy tunnel
* to it and the tunnel will use `tunnel_transport`.
*/
CURLcode cf_ip_happy_insert_after(struct Curl_cfilter *cf_at,
struct Curl_easy *data,
struct Curl_peer *origin,