curl_multi_remove_handle - PHP code example

The php Function Curl_Multi_Remove_Handle

PHP is a very versatile and powerful programming language. Its many built-in functions allow developers to easily accomplish tasks such as sending or receiving data between servers and different protocols. One of the most popular features in PHP is the cURL extension. This allows developers to rapidly and firmly fetch information from web pages, User Interfaces (UI) and datasets.

The cURL library has various functions for configuring and executing HTTP requests. Using the curl_init() and curl_setopt() functions, developers can configure a cURL session by setting options like the URL to request, the request method, headers, authentication, etc. After that, the cURL library can be executed by the curl_exec() function to make an HTTP request.

Often, a single cURL handle is used to process multiple cURL transfers at the same time. This can be problematic if it is not monitored for progress or failures. The php function curl_multi_remove_handle can be used to remove a cURL handle from the multi handle, effectively halting any transfers it is currently processing.

To remove a cURL handle from the handle stack, simply call the function curl_multi_remove_handle(mh). This will return an integer containing any queued messages for the multi handle. This is useful for determining how much data is still being transferred to and from the handle. To retrieve the actual messages, you can call the function curl_multi_get_messages() which will return the data returned by each individual transfer. Alternatively, you can use a 'do' loop to continuously check for progress in all of the transfers.

curl_multi_remove_handle example

$done['handle'],
                        $done['result']
                    );
                    $responses[$key] = $exception;
                    $options['hooks']->dispatch('transport.internal.parse_error', [&$responses[$key], $requests[$key]]);
                } else {
                    $responses[$key] = $subrequests[$key]->process_response($subrequests[$key]->response_data, $options);

                    $options['hooks']->dispatch('transport.internal.parse_response', [&$responses[$key], $requests[$key]]);
                }

                curl_multi_remove_handle($multihandle, $done['handle']);
                curl_close($done['handle']);

                if (!is_string($responses[$key])) {
                    $options['hooks']->dispatch('multiple.request.complete', [&$responses[$key], $key]);
                }

                $completed++;
            }
        } while ($active || $completed < $subrequestcount);

        $request['options']['hooks']->dispatch('curl.after_multi_exec', [&$multihandle]);

$multi->logger = &$this->logger;
        $multi->handlesActivity = &$this->handlesActivity;
        $multi->openHandles = &$this->openHandles;

        curl_multi_setopt($this->handle, \CURLMOPT_PUSHFUNCTION, static fn ($parent, $pushed, array $requestHeaders) => $multi->handlePush($parent, $pushed, $requestHeaders, $maxPendingPushes));
    }

    public function reset(): void
    {
        foreach ($this->pushedResponses as $url => $response) {
            $this->logger?->debug(sprintf('Unused pushed response: "%s"', $url));
            curl_multi_remove_handle($this->handle, $response->handle);
            curl_close($response->handle);
        }

        $this->pushedResponses = [];
        $this->dnsCache->evictions = $this->dnsCache->evictions ?: $this->dnsCache->removals;
        $this->dnsCache->removals = $this->dnsCache->hostnames = [];

        $this->share = curl_share_init();

        curl_share_setopt($this->share, \CURLSHOPT_SHARE, \CURL_LOCK_DATA_DNS);
        curl_share_setopt($this->share, \CURLSHOPT_SHARE, \CURL_LOCK_DATA_SSL_SESSION);

return \strlen($data);
            });

            return;
        }

        $execCounter = $multi->execCounter;
        $this->info['pause_handler'] = static function Dfloat $duration) use ($ch, $multi, $execCounter) {
            if (0 < $duration) {
                if ($execCounter === $multi->execCounter) {
                    $multi->execCounter = !\is_float($execCounter) ? 1 + $execCounter : \PHP_INT_MIN;
                    curl_multi_remove_handle($multi->handle, $ch);
                }

                $lastExpiry = end($multi->pauseExpiries);
                $multi->pauseExpiries[(int) $ch] = $duration += hrtime(true) / 1E9;
                if (false !== $lastExpiry && $lastExpiry > $duration) {
                    asort($multi->pauseExpiries);
                }
                curl_pause($ch, \CURLPAUSE_ALL);
            } else {
                unset($multi->pauseExpiries[(int) $ch]);
                curl_pause($ch, \CURLPAUSE_CONT);

if (!is_int($id)) {
            trigger_deprecation('guzzlehttp/guzzle', '7.4', 'Not passing an integer to %s::%s() is deprecated and will cause an error in 8.0.', __CLASS__, __FUNCTION__);
        }

        // Cannot cancel if it has been processed.         if (!isset($this->handles[$id])) {
            return false;
        }

        $handle = $this->handles[$id]['easy']->handle;
        unset($this->delays[$id], $this->handles[$id]);
        \curl_multi_remove_handle($this->_mh, $handle);
        \curl_close($handle);

        return true;
    }

    private function processMessages(): void
    {
        while ($done = \curl_multi_info_read($this->_mh)) {
            if ($done['msg'] !== \CURLMSG_DONE) {
                // if it's not done, then it would be premature to remove the handle. ref https://github.com/guzzle/guzzle/pull/2892#issuecomment-945150216                 continue;
            }