Skip site navigation (1)Skip section navigation (2)

FreeBSD Manual Pages

  
 
  

home | help
CURLOPT_UPKEEP_INTERVAL_MS(curl_easy_setopt optioCURLOPT_UPKEEP_INTERVAL_MS(3)

NAME
       CURLOPT_UPKEEP_INTERVAL_MS - connection upkeep interval

SYNOPSIS
       #include	<curl/curl.h>

       CURLcode	  curl_easy_setopt(CURL	 *handle,  CURLOPT_UPKEEP_INTERVAL_MS,
       long upkeep_interval_ms);

DESCRIPTION
       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  overzeal-
       ous firewalls, for example.

       The  user needs to explicitly call curl_easy_upkeep(3) in order to per-
       form the	upkeep work.

       Currently the only protocol  with  a  connection	 upkeep	 mechanism  is
       HTTP/2:	 when	the   connection   upkeep  interval  is	 exceeded  and
       curl_easy_upkeep(3) is called, an HTTP/2	PING frame is sent on the con-
       nection.

DEFAULT
       CURL_UPKEEP_INTERVAL_DEFAULT  (currently	defined	as 60000L, which is 60
       seconds)

EXAMPLE
       CURL *curl = curl_easy_init();
       if(curl)	{
	 /* Make a connection to an HTTP/2 server. */
	 curl_easy_setopt(curl,	CURLOPT_URL, "https://example.com");

	 /* Set	the interval to	30000ms	/ 30s */
	 curl_easy_setopt(curl,	CURLOPT_UPKEEP_INTERVAL_MS, 30000L);

	 curl_easy_perform(curl);

	 /* Perform more work here. */

	 /* While the connection is being held open, curl_easy_upkeep()	can be
	    called. If curl_easy_upkeep() is called and	the time since the last
	    upkeep exceeds the interval, then an HTTP/2	PING is	sent. */
	 curl_easy_upkeep(curl);

	 /* Perform more work here. */

	 /* always cleanup */
	 curl_easy_cleanup(curl);
       }

AVAILABILITY
       Added in	7.62.0

RETURN VALUE
       Returns CURLE_OK

libcurl	7.62.0			  31 Oct 2018	 CURLOPT_UPKEEP_INTERVAL_MS(3)

NAME | SYNOPSIS | DESCRIPTION | DEFAULT | EXAMPLE | AVAILABILITY | RETURN VALUE

Want to link to this manual page? Use this URL:
<https://www.freebsd.org/cgi/man.cgi?query=CURLOPT_UPKEEP_INTERVAL_MS&sektion=3&manpath=FreeBSD+12.1-RELEASE+and+Ports>

home | help