PHP

WebSocket Send/Receive Binary Data

See more WebSocket Examples

Demonstrates how to send and receive binary data on a websocket. 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\BinData;
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();
} catch (\Chilkat2\Exception $e) {
    echo $e->getMessage(), "\n";
    exit;
}

// This example sends a small JPG file (about 7KB) in a websocket frame.
$jpgData = new BinData();
$jpgData->LoadFile('qa_data/jpg/starfish.jpg');

echo 'Number of bytes to send = ', $jpgData->NumBytes, "\n";

// Send a frame containing the JPG image data.
// This will be the first and final frame, and therefore this constitutes the entire message.
$finalFrame = true;
try {
    $ws->SendFrameBd($jpgData, $finalFrame);
} catch (\Chilkat2\Exception $e) {
    echo $e->getMessage(), "\n";
    exit;
}

// Read the echoed binary frame(s).
// (We sent the JPG file in a single frame, but we may receive the echo in multiple frames, but it will be one message.)
// Read an incoming frames until we receive the final frame.
$receivedFinalFrame = false;
while (!$receivedFinalFrame) {
    // The ws object is accumulating the received data internally.  Once we get the final frame, we'll get the
    // accumulated data which should constitute the entire JPG.
    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";
}

// Get the accumulated received data.
$jpgReceivedData = new BinData();
$ws->GetFrameDataBd($jpgReceivedData);
echo 'Received ', $jpgReceivedData->NumBytes, " bytes\n";

// Save the received JPG to a file so we can check it..
$jpgReceivedData->WriteFile('qa_output/starfish_ws.jpg');

// 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";