Components All New MacOS Windows Linux iOS
Examples Mac & Win Server Client Guides Statistic FMM Blog Deprecated Old

CURL.Upkeep

Perform any connection upkeep checks.

Component Version macOS Windows Linux Server iOS SDK
CURL 8.5 ✅ Yes ✅ Yes ✅ Yes ✅ Yes ✅ Yes
MBS( "CURL.Upkeep"; curl )   More

Parameters

Parameter Description Example
curl The CURL session handle. $curl

Result

Returns OK or error.

Description

Perform any connection upkeep checks.
Some protocols have "connection upkeep" mechanisms. These mechanisms usually send some traffic on existing connections in order to keep them alive; this can prevent connections from being closed due to overzealous firewalls, for example.
Currently the only protocol with a connection upkeep mechanism is HTTP/2: when the connection upkeep interval is exceeded and CURL.Upkeep is called, an HTTP/2 PING frame is sent on the connection.
This function must be explicitly called in order to perform the upkeep work. The connection upkeep interval is set with CURL.SetOptionUpkeepIntervalMS.

See also

Release notes

Blog Entries

This function checks for a license.

Created 31st October 2018, last changed 31st October 2018


CURL.SetupOAuth - CURL.UseSystemCertificates