PHP

Send and Receive WebSocket Frame

See more WebSocket Examples

Demonstrates how to send a websocket text frame to a websocket echo server. This example uses Chilkat's websocket test echo server at ws://websockets.chilkat.io/wsChilkatEcho.ashx

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 a frame and receiving a text frame.

    // Send a frame containing the string "Hello World!"
    // This will be the first and final frame, and therefore this constitutes the entire message.
    $finalFrame = true;
    $ws->SendFrame('Hello World!', $finalFrame);
} catch (\Chilkat2\Exception $e) {
    echo $e->getMessage(), "\n";
    exit;
}

// Read an incoming frame.
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;
}

// Show the string that was received.
$receivedStr = $ws->GetFrameData();
echo 'Received: ', $receivedStr, "\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";