php8.5
Home/ Manual/ pgsql / functions/ pg_socket_poll

pg_socket_poll

PHP function Edit on GitHub ✎

(PHP 8 >= 8.4.0)

Poll a PostgreSQL connection socket for read/write readiness

Description

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

Source: reference/pgsql/functions/pg-socket-poll.xml · from the official PHP manual (php/doc-en)