www.LinuxHowtos.org

curl_multi_notify_enable

Section: C Library Functions (3)
Updated: 202-0-19
Index Return to Main Contents

NAME

curl_multi_notify_enable - enable a notification type

SYNOPSIS

#include <curl/curl.h>
CURLMcode curl_multi_notify_enable(CURLM *multi_handle,
                                   unsigned int notification);

DESCRIPTION

Enables collecting the given notification type in the multi handle. A callback function installed via CURLMOPT_NOTIFYFUNCTION(3) is called when this notification happens.

Only when a notification callback is installed and a notification is enabled are these collected and dispatched to the callback.

Several notification types can be enabled at the same time. Enabling an already enabled notification is not an error.

A notification can be disabled again via curl_multi_notify_disable(3).

PROTOCOLS

This functionality affects all supported protocols

EXAMPLE

int main(void)
{
  int rc;
  CURLM *multi = curl_multi_init();

  rc = curl_multi_notify_enable(multi, CURLMNOTIFY_INFO_READ);
}

AVAILABILITY

Added in curl 8.17.0

RETURN VALUE

This function returns a CURLMcode indicating success or error.

CURLM_OK (0) means everything was OK, non-zero means an error occurred, see libcurl-errors(3).

The return code is for the whole multi stack. Problems still might have occurred on individual transfers even when one of these functions return OK.