PHP

Send and Receive WebSocket Messages

See more WebSocket Examples

This example how to send and receive websocket messages.

A WebSocket message can be composed of one or more frames. The simple case is where a single frame is both the first and last frame in a message. This is the case where the 1st frame in the message has the "final frame" bit set.

This example demonstrates sending and receiving multi-frame messages.

Note: The websockets.chilkat.io server imposes the following limitations:
Messages must be 16K or less, and each connection is limited to a max of 16 echoed messages.

Chilkat2 PHP

<?php

use Chilkat2\Rest;
use Chilkat2\WebSocket;

// This example requires the Chilkat API to have been previously unlocked.
// See Global Unlock Sample for sample code.

$ws = new WebSocket();

// For brevity, this example does not check for errors when etablishing the WebSocket connection.
// See Establish WebSocket Connection for more complete sample code for making the connection.

$rest = new Rest();
// Connect to websockets.chilkat.io
// IMPORTANT: websockets.chilkat.io accepts frames of up to 16K in size and echoes them back.
// IMPORTANT: The websockets.chilkat.io server imposes the following limitations:
// ---------- Messages must be 16K or less, and each connection is limited to a max of 16 echoed messages.
$rest->Connect('websockets.chilkat.io', 80, false, false);
$ws->UseConnection($rest);
$ws->AddClientHeaders();
$responseBodyIgnored = $rest->FullRequestNoBody('GET', '/wsChilkatEcho.ashx');
try {
    $ws->ValidateServerHandshake();

    // This example demonstrates sending and receiving a multi-frame message.

    // The websocket message will be composed of three text lines, each frame will contain a single line.

    // Send the 1st frame in the message.
    $finalFrame = false;
    $ws->SendFrame("This is the 1st frame\r\n", $finalFrame);

    // Send the 2nd frame in the message.
    $ws->SendFrame("This is the 2nd frame\r\n", $finalFrame);

    // Send the 3rd and final frame in the message.
    $finalFrame = true;
    $ws->SendFrame("This is the 3rd frame\r\n", $finalFrame);
} catch (\Chilkat2\Exception $e) {
    echo $e->getMessage(), "\n";
    exit;
}

// Read an incoming frames until we receive the final frame.
// Note: It may be that the echo server (websockets.chilkat.io) responds with
// the full message in a single final frame.
$receivedFinalFrame = false;
while (!$receivedFinalFrame) {
    try {
        $ws->ReadFrame();
    } catch (\Chilkat2\Exception $e) {
        echo "Failed to receive a frame\n";
        echo 'ReadFrame fail reason = ', $ws->ReadFrameFailReason, "\n";
        echo $e->getMessage(), "\n";
        exit;
    }

    $receivedFinalFrame = $ws->FinalFrame;

    // Show the opcode and final frame bit for the frame just received:
    echo 'Frame opcode: ', $ws->FrameOpcode, "\n";
    echo 'Final frame: ', ($receivedFinalFrame ? 'true' : 'false'), "\n";
}

// Return the message accumulated in the above calls to ReadFrame.
$receivedMsg = $ws->GetFrameData();
echo 'Received: ', $receivedMsg, "\n";

// Close the websocket connection.
try {
    $ws->SendClose(true, 1000, 'Closing this websocket.');
} catch (\Chilkat2\Exception $e) {
    echo $e->getMessage(), "\n";
    exit;
}

// Read the Close response.
try {
    $ws->ReadFrame();
} catch (\Chilkat2\Exception $e) {
    echo 'ReadFrame fail reason = ', $ws->ReadFrameFailReason, "\n";
    echo $e->getMessage(), "\n";
    exit;
}

// Should receive the "Close" opcode.
echo 'Received opcode: ', $ws->FrameOpcode, "\n";
// Should be the same status code we sent (1000)
echo 'Received close status code: ', $ws->CloseStatusCode, "\n";
// The server may echo the close reason.  If not, this will be empty.
echo 'Echoed close reason: ', $ws->CloseReason, "\n";

echo "Success.\n";