php8.5
Home/ Manual/ stream / functions/ stream_socket_shutdown

stream_socket_shutdown

PHP function Edit on GitHub ✎

(PHP 5 >= 5.2.1, PHP 7, PHP 8)

Shutdown a full-duplex connection

Description

stream_socket_shutdown(resource $stream, int $mode): bool

Shutdowns (partially or not) a full-duplex connection.

Note

The associated buffer, or buffers, may or may not be emptied.

Parameters

stream

An open stream (opened with stream_socket_client(), for example)

mode

One of the following constants: STREAM_SHUT_RD (disable further receptions), STREAM_SHUT_WR (disable further transmissions) or STREAM_SHUT_RDWR (disable further receptions and transmissions).

Return Values

Success

Examples

A stream_socket_shutdown() example

php
<?php

$server = stream_socket_server('tcp://127.0.0.1:1337');
$client = stream_socket_client('tcp://127.0.0.1:1337');

var_dump(fputs($client, "hello"));

stream_socket_shutdown($client, STREAM_SHUT_WR);
var_dump(fputs($client, "hello")); // doesn't work now

?>

The above example will output something similar to:

output
int(5)

Notice: fputs(): send of 5 bytes failed with errno=32 Broken pipe in test.php on line 9
int(0)

See Also

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