Delphi ActiveX

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.

Delphi ActiveX

uses
    Winapi.Windows, Winapi.Messages, System.SysUtils, System.Variants, System.Classes, Vcl.Graphics,
    Vcl.Controls, Vcl.Forms, Vcl.Dialogs, Vcl.StdCtrls, Chilkat_TLB;

...

procedure TForm1.Button1Click(Sender: TObject);
var
success: Integer;
ws: TChilkatWebSocket;
rest: TChilkatRest;
responseBodyIgnored: WideString;
jpgData: TChilkatBinData;
finalFrame: Integer;
receivedFinalFrame: Integer;
jpgReceivedData: TChilkatBinData;

begin
success := 0;

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

ws := TChilkatWebSocket.Create(Self);

// 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 := TChilkatRest.Create(Self);
// 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.
success := rest.Connect('websockets.chilkat.io',80,0,0);
ws.UseConnection(rest.ControlInterface);
ws.AddClientHeaders();
responseBodyIgnored := rest.FullRequestNoBody('GET','/wsChilkatEcho.ashx');
success := ws.ValidateServerHandshake();
if (success <> 1) then
  begin
    Memo1.Lines.Add(ws.LastErrorText);
    Exit;
  end;

// This example sends a small JPG file (about 7KB) in a websocket frame.
jpgData := TChilkatBinData.Create(Self);
success := jpgData.LoadFile('qa_data/jpg/starfish.jpg');

Memo1.Lines.Add('Number of bytes to send = ' + IntToStr(jpgData.NumBytes));

// Send a frame containing the JPG image data.
// This will be the first and final frame, and therefore this constitutes the entire message.
finalFrame := 1;
success := ws.SendFrameBd(jpgData.ControlInterface,finalFrame);
if (success <> 1) then
  begin
    Memo1.Lines.Add(ws.LastErrorText);
    Exit;
  end;

// 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 := 0;
while receivedFinalFrame = 0 do
  begin

    // 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.
    success := ws.ReadFrame();
    if (success <> 1) then
      begin
        Memo1.Lines.Add('Failed to receive a frame');
        Memo1.Lines.Add('ReadFrame fail reason = ' + IntToStr(ws.ReadFrameFailReason));
        Memo1.Lines.Add(ws.LastErrorText);
        Exit;
      end;

    receivedFinalFrame := ws.FinalFrame;

    // Show the opcode and final frame bit for the frame just received:
    Memo1.Lines.Add('Frame opcode: ' + ws.FrameOpcode);
    Memo1.Lines.Add('Final frame: ' + IntToStr(Ord(receivedFinalFrame)));
  end;

// Get the accumulated received data.
jpgReceivedData := TChilkatBinData.Create(Self);
ws.GetFrameDataBd(jpgReceivedData.ControlInterface);
Memo1.Lines.Add('Received ' + IntToStr(jpgReceivedData.NumBytes) + ' bytes');

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

// Close the websocket connection.
success := ws.SendClose(1,1000,'Closing this websocket.');
if (success <> 1) then
  begin
    Memo1.Lines.Add(ws.LastErrorText);
    Exit;
  end;

// Read the Close response.
success := ws.ReadFrame();
if (success <> 1) then
  begin
    Memo1.Lines.Add('ReadFrame fail reason = ' + IntToStr(ws.ReadFrameFailReason));
    Memo1.Lines.Add(ws.LastErrorText);
    Exit;
  end;

// Should receive the "Close" opcode.
Memo1.Lines.Add('Received opcode: ' + ws.FrameOpcode);
// Should be the same status code we sent (1000)
Memo1.Lines.Add('Received close status code: ' + IntToStr(ws.CloseStatusCode));
// The server may echo the close reason.  If not, this will be empty.
Memo1.Lines.Add('Echoed close reason: ' + ws.CloseReason);

Memo1.Lines.Add('Success.');
end;