array ( 0 => 'index.php', 1 => 'PHP Manual', ), 'head' => array ( 0 => 'UTF-8', 1 => 'en', ), 'this' => array ( 0 => 'function.pg-socket-poll.php', 1 => 'pg_socket_poll', 2 => 'Poll a PostgreSQL connection socket for read/write readiness', ), 'up' => array ( 0 => 'ref.pgsql.php', 1 => 'PostgreSQL Functions', ), 'prev' => array ( 0 => 'function.pg-socket.php', 1 => 'pg_socket', ), 'next' => array ( 0 => 'function.pg-trace.php', 1 => 'pg_trace', ), 'alternatives' => array ( ), 'source' => array ( 'lang' => 'en', 'path' => 'reference/pgsql/functions/pg-socket-poll.xml', ), 'history' => array ( ), ); $setup["toc"] = $TOC; $setup["toc_deprecated"] = $TOC_DEPRECATED; $setup["parents"] = $PARENTS; manual_setup($setup); contributors($setup); ?>

pg_socket_poll

(PHP 8 >= 8.4.0)

pg_socket_poll — Poll a PostgreSQL connection socket for read/write readiness

Description

function pg_socket_poll(
    resource $socket,
    int $read,
    int $write,
    int $timeout = -1
): int

Polls a PostgreSQL connection socket for read and/or write readiness. The socket can be obtained using pg_socket(). This function is useful for implementing non-blocking, asynchronous query workflows.

Parameters

socket
A socket resource obtained from pg_socket().
read
Whether to check for read readiness. Pass 1 to check, 0 to skip.
write
Whether to check for write readiness. Pass 1 to check, 0 to skip.
timeout
The maximum number of milliseconds to wait. Pass -1 to wait indefinitely, or 0 to not wait at all.

Return Values

Returns a positive value if the socket is ready, 0 if the timeout was reached, or -1 on error.

See Also