romenskiy2012/curl

mirror of https://github.com/curl/curl.git synced 2026-04-23 08:02:13 +03:00

Add infrastructure to colled and dispatch notifications for transfers
and the multi handle in general. Applications can register a callback
and en-/disable notification type the are interested in.

Without a callback installed, notifications are not collected. Same when
a notification type has not been enabled.

Memory allocation failures on adding notifications lead to a general
multi failure state and result in CURLM_OUT_OF_MEMORY returned from
curl_multi_perform() and curl_multi_socket*() invocations.

Closes #18432

2025-10-07 10:55:31 +02:00

1.5 KiB

Raw Blame History

SPDX-License-Identifier

Title

Section

Source

See-also

Protocol

Added-in

curl

curl_multi_notify_enable

libcurl

CURLMOPT_NOTIFYFUNCTION (3)

CURLMOPT_NOTIFYDATA (3)

curl_multi_notify_disable (3)

All

8.17.0

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%

EXAMPLE

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

  rc = curl_multi_notify_enable(multi, CURLM_NTFY_INFO_READ);
}

%AVAILABILITY%

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.

1.5 KiB Raw Blame History