Chilkat Examples

ChilkatHOME.NET Core C#Android™AutoItCC#C++Chilkat2-PythonCkPythonClassic ASPDataFlexDelphi ActiveXDelphi DLLGoJavaLianjaMono C#Node.jsObjective-CPHP ActiveXPHP ExtensionPerlPowerBuilderPowerShellPureBasicRubySQL ServerSwift 2Swift 3,4,5...TclUnicode CUnicode C++VB.NETVBScriptVisual Basic 6.0Visual FoxProXojo Plugin

PHP ActiveX Examples

Web API Categories

ASN.1
AWS KMS
AWS Misc
Amazon EC2
Amazon Glacier
Amazon S3
Amazon S3 (new)
Amazon SES
Amazon SNS
Amazon SQS
Async
Azure Cloud Storage
Azure Key Vault
Azure Service Bus
Azure Table Service
Base64
Bounced Email
Box
CAdES
CSR
CSV
Certificates
Cloud Signature CSC
Code Signing
Compression
DKIM / DomainKey
DNS
DSA
Diffie-Hellman
Digital Signatures
Dropbox
Dynamics CRM
EBICS
ECC
Ed25519
Email Object
Encryption
FTP
FileAccess
Firebase
GMail REST API
GMail SMTP/IMAP/POP
Geolocation
Google APIs
Google Calendar
Google Cloud SQL
Google Cloud Storage
Google Drive
Google Photos
Google Sheets
Google Tasks
Gzip
HTML-to-XML/Text
HTTP

HTTP Misc
IMAP
JSON
JSON Web Encryption (JWE)
JSON Web Signatures (JWS)
JSON Web Token (JWT)
Java KeyStore (JKS)
MHT / HTML Email
MIME
MS Storage Providers
Microsoft Graph
Misc
NTLM
OAuth1
OAuth2
OIDC
Office365
OneDrive
OpenSSL
Outlook
Outlook Calendar
Outlook Contact
PDF Signatures
PEM
PFX/P12
PKCS11
POP3
PRNG
REST
REST Misc
RSA
SCP
SCard
SFTP
SMTP
SSH
SSH Key
SSH Tunnel
ScMinidriver
SharePoint
SharePoint Online
Signing in the Cloud
Socket/SSL/TLS
Spider
Stream
Tar Archive
ULID/UUID
Upload
WebSocket
XAdES
XML
XML Digital Signatures
XMP
Zip
curl
uncategorized

 

 

 

(PHP ActiveX) Send and Receive WebSocket Messages

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.

Chilkat ActiveX Downloads

ActiveX for 32-bit and 64-bit Windows

Note: The php_com_dotnet.dll may need to be enabled inside of php.ini.

<?php

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

// For versions of Chilkat < 10.0.0, use new COM('Chilkat_9_5_0.Chilkat.WebSocket')
$ws = new COM("Chilkat.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.

// For versions of Chilkat < 10.0.0, use new COM('Chilkat_9_5_0.Chilkat.Rest')
$rest = new COM("Chilkat.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.
$success = $rest->Connect('websockets.chilkat.io',80,0,0);
$ws->UseConnection($rest);
$ws->AddClientHeaders();
$responseBodyIgnored = $rest->fullRequestNoBody('GET','/wsChilkatEcho.ashx');
$success = $ws->ValidateServerHandshake();
if ($success != 1) {
    print $ws->LastErrorText . "\n";
    exit;
}

// 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 = 0;
$success = $ws->SendFrame('This is the 1st frame\r\n',$finalFrame);
if ($success != 1) {
    print $ws->LastErrorText . "\n";
    exit;
}

// Send the 2nd frame in the message.
$success = $ws->SendFrame('This is the 2nd frame\r\n',$finalFrame);
if ($success != 1) {
    print $ws->LastErrorText . "\n";
    exit;
}

// Send the 3rd and final frame in the message.
$finalFrame = 1;
$success = $ws->SendFrame('This is the 3rd frame\r\n',$finalFrame);
if ($success != 1) {
    print $ws->LastErrorText . "\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 = 0;
while ($receivedFinalFrame == 0) {

    $success = $ws->ReadFrame();
    if ($success != 1) {
        print 'Failed to receive a frame' . "\n";
        print 'ReadFrame fail reason = ' . $ws->ReadFrameFailReason . "\n";
        print $ws->LastErrorText . "\n";
        exit;
    }

    $receivedFinalFrame = $ws->FinalFrame;

    // Show the opcode and final frame bit for the frame just received:
    print 'Frame opcode: ' . $ws->FrameOpcode . "\n";
    print 'Final frame: ' . $receivedFinalFrame . "\n";
}

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

// Close the websocket connection.
$success = $ws->SendClose(1,1000,'Closing this websocket.');
if ($success != 1) {
    print $ws->LastErrorText . "\n";
    exit;
}

// Read the Close response.
$success = $ws->ReadFrame();
if ($success != 1) {
    print 'ReadFrame fail reason = ' . $ws->ReadFrameFailReason . "\n";
    print $ws->LastErrorText . "\n";
    exit;
}

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

print 'Success.' . "\n";

?>

 

© 2000-2024 Chilkat Software, Inc. All Rights Reserved.