OpenSwoole\Http\Response->push()

Latest version: pecl install openswoole-26.11.1 | composer require openswoole/core:26.11.1

Declaration

<?php OpenSwoole\Http\Response->push(OpenSwoole\WebSocket\Frame|string $data, int $opcode = OpenSwoole\WebSocket\Server::WEBSOCKET_OPCODE_TEXT, int $flags = OpenSwoole\WebSocket\Server::WEBSOCKET_FLAG_FIN): bool

Parameters

data

The data to send, a string or an OpenSwoole\WebSocket\Frame object. When a frame object is given, opcode and flags are taken from the object.

opcode

The WebSocket opcode, for example WEBSOCKET_OPCODE_TEXT or WEBSOCKET_OPCODE_BINARY.

flags

The WebSocket frame flags, for example WEBSOCKET_FLAG_FIN or WEBSOCKET_FLAG_FIN | WEBSOCKET_FLAG_COMPRESS.

Return

Returns true when the frame was sent, otherwise false.

Description

Send a WebSocket frame on a connection that was upgraded with upgrade().

Calling push() before a successful upgrade() returns false with the warning fd[...] is not a websocket conncetion.

This method is for a response bound to a coroutine socket, created with OpenSwoole\Http\Response::create([$socket, $request]). For a OpenSwoole\Http\Server use the OpenSwoole\WebSocket\Server instead.

Example

<?php
use OpenSwoole\Coroutine\Socket;
use OpenSwoole\Http\Request;
use OpenSwoole\Http\Response;
use OpenSwoole\WebSocket\Server as WebSocketServer;

co::run(function()
{
    $server = new Socket(AF_INET, SOCK_STREAM, 0);
    $server->bind("127.0.0.1", 9502);
    $server->listen(128);

    while ($conn = $server->accept()) {
        go(function() use ($conn)
        {
            // read and parse the HTTP request
            $request = Request::create([]);
            while (!$request->isCompleted()) {
                $data = $conn->recv();
                if ($data === "" || $data === false || $request->parse($data) === false) {
                    $conn->close();
                    return;
                }
            }

            $response = Response::create([$conn, $request]);
            if (!$response->upgrade()) {
                return;
            }

            while (true) {
                $frame = $response->recv(60);
                if ($frame === "" || $frame === false || $frame->opcode === WebSocketServer::WEBSOCKET_OPCODE_CLOSE) {
                    break;
                }
                $response->push("echo: {$frame->data}");
            }
            $response->close();
        });
    }
});
Last updated on November 20, 2026