socket_set_block

(PHP 4 >= 4.2.0, PHP 5, PHP 7, PHP 8)

socket_set_block — Sets blocking mode on a socket

Description

socket_set_block(Socket $socket): bool

The socket_set_block() function removes the O_NONBLOCK flag on the socket specified by the socket parameter.

When an operation (e.g. receive, send, connect, accept, ...) is performed on a blocking socket, the script will pause its execution until it receives a signal or it can perform the operation.

Parameters

socket: A Socket instance created with socket_create() or socket_accept().

Return Values

Returns true on success or false on failure.

Changelog

Version	Description
8.0.0	`socket` is a Socket instance now; previously, it was a resource.

Examples

Example #1 socket_set_block() example

<?php
$socket = socket_create_listen(1223);
socket_set_block($socket);

socket_accept($socket);
?>

This example creates a listening socket on all interfaces on port 1223 and sets the socket to O_BLOCK mode. socket_accept() will hang until there is a connection to accept.

Found A Problem?

Learn How To Improve This Page • Submit a Pull Request • Report a Bug

＋add a note

User Contributed Notes 1 note

down

laacz at laacz dot lv ¶

10 years ago

Besides true and false socket_set_block might return NULL if you're not too careful. That would happen when passing non socket resource as first parameter. 

E.g. socket_set_block(false)) would return NULL and emit warning that you're trying to do things with non-socket.