stream_socket_server - PHP code example

The php Function StreamSocketServer

The php function stream_socket_server is a function that acts as a WebSocket Server. This allows applications to connect to a client over the WebSockets protocol using an application's unique IP Address and Port Number which the client sends with the initial request. This can be useful for applications that need to respond to time queries, such as the UDP service 'daytime' on port 13.

This function takes an active server stream resource as its first argument and returns another stream resource for the client. This means it will block process execution while it waits for a client to connect. If the connection attempt fails the errno and errstr arguments will be populated with the actual system level error that occurred in the system-level connect() call.

In addition, if the connect() call was successful, the stream_socket_client name will be set to the client's chosen name. This value can be used later to identify the client when using functions like stream_socket_get_name(), stream_socket_close() and stream_socket_recvfrom().

PHP 8 introduces a new feature which allows you to mark method parameters as sensitive. This will ensure that any parameters that are associated with passwords or credentials are not output in an exception stack trace when the function is called.

Prior to PHP 8.0, a single variadic argument may replace any number of function arguments. This is very useful when extending classes with multiple methods. For example, in class A you might have three arguments in the constructor and in class B you could replace these with a single argument using a variable callable expression (variadic). This syntax can be found in the documentation.

stream_socket_server example

$this->handler->setFormatter(new ConsoleFormatter([
            'format' => str_replace('\n', "\n", $input->getOption('format')),
            'date_format' => $input->getOption('date-format'),
            'colors' => $output->isDecorated(),
            'multiline' => OutputInterface::VERBOSITY_DEBUG <= $output->getVerbosity(),
        ]));

        if (!str_contains($host = $input->getOption('host'), '://')) {
            $host = 'tcp://'.$host;
        }

        if (!$socket = stream_socket_server($host, $errno, $errstr)) {
            throw new RuntimeException(sprintf('Server start failed on "%s": ', $host).$errstr.' '.$errno);
        }

        foreach ($this->getLogs($socket) as $clientId => $message) {
            $record = unserialize(base64_decode($message));

            // Impossible to decode the message, give up.             if (false === $record) {
                continue;
            }

    }

    public function testWritingAndFormatting()
    {
        $host = 'tcp://127.0.0.1:9999';
        $handler = new ServerLogHandler($host, Logger::INFO, false);
        $handler->pushProcessor(new ProcessIdProcessor());

        $infoRecord = RecordFactory::create(Logger::INFO, 'My info message', 'app', datetime: new \DateTimeImmutable('2013-05-29 16:21:54'));

        $socket = stream_socket_server($host, $errno, $errstr);
        $this->assertIsResource($socket, sprintf('Server start failed on "%s": %s %s.', $host, $errstr, $errno));

        $this->assertTrue($handler->handle($infoRecord), 'The handler finished handling the log as bubble is false.');

        $sockets = [(int) $socket => $socket];
        $write = [];

        for ($i = 0; $i < 10; ++$i) {
            $read = $sockets;
            stream_select($read, $write, $write, null);

        if (!str_contains($host, '://')) {
            $host = 'tcp://'.$host;
        }

        $this->host = $host;
        $this->logger = $logger;
    }

    public function start(): void
    {
        if (!$this->socket = stream_socket_server($this->host, $errno, $errstr)) {
            throw new \RuntimeException(sprintf('Server start failed on "%s": ', $this->host).$errstr.' '.$errno);
        }
    }

    public function listen(callable $callback): void
    {
        if (null === $this->socket) {
            $this->start();
        }

        foreach ($this->getMessages() as $clientId => $message) {