array ( 0 => 'index.php', 1 => 'PHP Manual', ), 'head' => array ( 0 => 'UTF-8', 1 => 'en', ), 'this' => array ( 0 => 'function.ssh2-poll.php', 1 => 'ssh2_poll', 2 => 'Poll the channels/listeners/streams for events', ), 'up' => array ( 0 => 'ref.ssh2.php', 1 => 'SSH2 Functions', ), 'prev' => array ( 0 => 'function.ssh2-methods-negotiated.php', 1 => 'ssh2_methods_negotiated', ), 'next' => array ( 0 => 'function.ssh2-publickey-add.php', 1 => 'ssh2_publickey_add', ), 'alternatives' => array ( ), 'source' => array ( 'lang' => 'en', 'path' => 'reference/ssh2/functions/ssh2-poll.xml', ), 'history' => array ( ), ); $setup["toc"] = $TOC; $setup["toc_deprecated"] = $TOC_DEPRECATED; $setup["parents"] = $PARENTS; manual_setup($setup); contributors($setup); ?>

ssh2_poll

(PECL ssh2 >= 0.9.0)

ssh2_poll — Poll the channels/listeners/streams for events

Description

ssh2_poll(array &$desc, int $timeout = 30): int

Polls the channels/listeners/streams for events, and returns the number of descriptors which returned non-zero revents.

Warning

This function is currently not documented; only its argument list is available.

Parameters

desc
An indexed array of subarrays with the keys 'resource' and 'events'. The value of the resource is a (channel) stream or an SSH2 Listener resource. The value of the event are SSH2_POLL* flags bitwise ORed together. Each subarray will be populated with an 'revents' element on return, whose values are SSH2_POLL* flags bitwise ORed together of the events that occurred.
timeout
The timeout in seconds.

Return Values

Returns the number of descriptors which returned non-zero revents.