Chilkat Examples

ChilkatHOMEAndroid™Classic ASPCC++C#Mono C#.NET Core C#C# UWP/WinRTDataFlexDelphi ActiveXDelphi DLLVisual FoxProJavaLianjaMFCObjective-CPerlPHP ActiveXPHP ExtensionPowerBuilderPowerShellPureBasicPythonRubySQL ServerSwiftTclUnicode CUnicode C++Visual Basic 6.0VB.NETVB.NET UWP/WinRTVBScriptXojo PluginNode.jsExcel

.NET Core C# Examples


ASN.1
Amazon S3
Amazon S3 (new)
Amazon SES
Amazon SNS
Amazon SQS
Async
Azure Cloud Storage
Azure Service Bus
Bounced Email
Box
CSR
CSV
Certificates
Compression
DKIM / DomainKey
DSA
Diffie-Hellman
Digital Signatures
Dropbox
Dynamics CRM
ECC
Email Object
Encryption
FTP
Facebook
Firebase
GeoOp
Google APIs
Google Calendar
Google Cloud Storage
Google Drive
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)

Jira
MHT / HTML Email
MIME
Microsoft Graph
NTLM
OAuth1
OAuth2
OneDrive
OpenSSL
Outlook
PEM
PFX/P12
POP3
PRNG
PayPal
Peoplevox
QuickBooks
REST
REST Misc
RSA Encryption
SCP
SFTP
SMTP
SSH
SSH Key
SSH Tunnel
SharePoint
Shopify
Socket/SSL/TLS
Spider
Stream
Stripe
SugarCRM
Tar Archive
Twitter
VoiceBase
Walmart
WebSocket
XAdES
XML
XML Digital Signatures
XMP
Xero
Zip
curl
eBay

 

 

 

(.NET Core C#) Send a WebSocket Ping Control Frame

Ping and Pong messages are the heartbeat of websockets. See Pings and Pongs

"At any point after the handshake, either the client or the server can choose to send a ping to the other party. When the ping is received, the recipient must send back a pong as soon as possible. You can use this to make sure that the client is still connected, for example. A ping or pong is just a regular frame, but it's a control frame. Pings have an opcode of 0x9, and pongs have an opcode of 0xA. When you get a ping, send back a pong with the exact same Payload Data as the ping (for pings and pongs, the max payload length is 125). You might also get a pong without ever sending a ping; ignore this if it happens."

This example demonstrates how to send a Ping in the midst of sending a message.

Chilkat .NET Downloads

Chilkat .NET Assemblies

Chilkat for .NET Core

Chilkat for Mono

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

Chilkat.WebSocket ws = new Chilkat.WebSocket();

//  The PongAutoConsume property is true by default.  This means that any Pong frames that are received
//  will automatically be consumed, and the ReadFrame method will continue reading the next incoming frame before it returns.
ws.PongAutoConsume = true;

//  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.

Chilkat.Rest rest = new Chilkat.Rest();
//  Connect to websockets.chilkat.io
//  (websockets.chilkat.io accepts frames of up to 16K in size and echoes them back)
bool success = rest.Connect("websockets.chilkat.io",80,false,false);
ws.UseConnection(rest);
ws.AddClientHeaders();
string responseBodyIgnored = rest.FullRequestNoBody("GET","/wsChilkatEcho.ashx");
success = ws.ValidateServerHandshake();
if (success != true) {
    Debug.WriteLine(ws.LastErrorText);
    return;
}

//  This example sends a multi-frame message to the Chilkat echo server, and reads the response.
//  In the midst of sending the message, we'll send a Ping control frame.  The server should respond with a Pong frame,
//  and we'll automatically consume it.

//  Send the 1st frame in the message.
bool finalFrame = false;
success = ws.SendFrame("This is the 1st frame\r\n",finalFrame);
if (success != true) {
    Debug.WriteLine(ws.LastErrorText);
    return;
}

//  Let's send a Ping frame here...
success = ws.SendPing("This is a ping");
if (success != true) {
    Debug.WriteLine(ws.LastErrorText);
    return;
}

//  Send the 2nd frame in the message.
success = ws.SendFrame("This is the 2nd frame\r\n",finalFrame);
if (success != true) {
    Debug.WriteLine(ws.LastErrorText);
    return;
}

//  Send the 3rd and final frame in the message.
finalFrame = true;
success = ws.SendFrame("This is the 3rd and final frame\r\n",finalFrame);
if (success != true) {
    Debug.WriteLine(ws.LastErrorText);
    return;
}

//  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.
// 
//  The Pong response will be consumed automatically because the PongAutoConsume property is true.
//  Therefore, we don't need to worry about handling an incoming Pong.
bool receivedFinalFrame = false;
while (receivedFinalFrame == false) {

    success = ws.ReadFrame();
    if (success != true) {
        Debug.WriteLine("Failed to receive a frame");
        Debug.WriteLine("ReadFrame fail reason = " + Convert.ToString(ws.ReadFrameFailReason));
        Debug.WriteLine(ws.LastErrorText);
        return;
    }

    receivedFinalFrame = ws.FinalFrame;

    //  Show the opcode and final frame bit for the frame just received:
    Debug.WriteLine("Frame opcode: " + ws.FrameOpcode);
    Debug.WriteLine("Final frame: " + Convert.ToString(receivedFinalFrame));
    Debug.WriteLine("--");
}

//  Return the message accumulated in the above calls to ReadFrame.
string receivedMsg = ws.GetFrameData();
Debug.WriteLine("Received: " + receivedMsg);

//  Close the websocket connection.
success = ws.SendClose(true,1000,"Closing this websocket.");
if (success != true) {
    Debug.WriteLine(ws.LastErrorText);
    return;
}

//  Read the Close response.
success = ws.ReadFrame();
if (success != true) {
    Debug.WriteLine("ReadFrame fail reason = " + Convert.ToString(ws.ReadFrameFailReason));
    Debug.WriteLine(ws.LastErrorText);
    return;
}

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

Debug.WriteLine("Success.");

 

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