Chilkat Examples

ChilkatHOMEAndroid™Classic ASPCC++C#Mono C#.NET Core C#C# UWP/WinRTDataFlexDelphi ActiveXDelphi DLLVisual FoxProJavaLianjaMFCObjective-CPerlPHP ActiveXPHP ExtensionPowerBuilderPowerShellPureBasicCkPythonChilkat2-PythonRubySQL ServerSwift 2Swift 3/4TclUnicode CUnicode C++Visual Basic 6.0VB.NETVB.NET UWP/WinRTVBScriptXojo PluginNode.jsExcelGo

Classic ASP Examples

Web API Categories

ASN.1
Amazon Glacier
Amazon S3
Amazon S3 (new)
Amazon SES
Amazon SNS
Amazon SQS
Async
Azure Cloud Storage
Azure Service Bus
Base64
Bounced Email
Box
CSR
CSV
Certificates
Compression
DKIM / DomainKey
DSA
Diffie-Hellman
Digital Signatures
Dropbox
Dynamics CRM
ECC
Email Object
Encryption
FTP
FileAccess
Firebase
GMail REST API
Geolocation
Google APIs
Google Calendar
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
Microsoft Graph
NTLM
OAuth1
OAuth2
OneDrive
OpenSSL
Outlook
PEM
PFX/P12
POP3
PRNG
REST
REST Misc
RSA Encryption
SCP
SFTP
SMTP
SSH
SSH Key
SSH Tunnel
SharePoint
Socket/SSL/TLS
Spider
Stream
Tar Archive
Upload
WebSocket
XAdES
XML
XML Digital Signatures
XMP
Zip
curl

 

 

 

(Classic ASP) 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.

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

<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
</head>
<body>
<%
' This example requires the Chilkat API to have been previously unlocked.
' See Global Unlock Sample for sample code.

set ws = Server.CreateObject("Chilkat_9_5_0.WebSocket")

' The PongAutoConsume property is 1 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 = 1

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

set rest = Server.CreateObject("Chilkat_9_5_0.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)
success = ws.UseConnection(rest)
success = ws.AddClientHeaders()
responseBodyIgnored = rest.FullRequestNoBody("GET","/wsChilkatEcho.ashx")
success = ws.ValidateServerHandshake()
If (success <> 1) Then
    Response.Write "<pre>" & Server.HTMLEncode( ws.LastErrorText) & "</pre>"
    Response.End
End If

' 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.
finalFrame = 0
success = ws.SendFrame("This is the 1st frame" & vbCrLf,finalFrame)
If (success <> 1) Then
    Response.Write "<pre>" & Server.HTMLEncode( ws.LastErrorText) & "</pre>"
    Response.End
End If

' Let's send a Ping frame here...
success = ws.SendPing("This is a ping")
If (success <> 1) Then
    Response.Write "<pre>" & Server.HTMLEncode( ws.LastErrorText) & "</pre>"
    Response.End
End If

' Send the 2nd frame in the message.
success = ws.SendFrame("This is the 2nd frame" & vbCrLf,finalFrame)
If (success <> 1) Then
    Response.Write "<pre>" & Server.HTMLEncode( ws.LastErrorText) & "</pre>"
    Response.End
End If

' Send the 3rd and final frame in the message.
finalFrame = 1
success = ws.SendFrame("This is the 3rd and final frame" & vbCrLf,finalFrame)
If (success <> 1) Then
    Response.Write "<pre>" & Server.HTMLEncode( ws.LastErrorText) & "</pre>"
    Response.End
End If

' 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 1.
' Therefore, we don't need to worry about handling an incoming Pong.
receivedFinalFrame = 0
Do While receivedFinalFrame = 0

    success = ws.ReadFrame()
    If (success <> 1) Then
        Response.Write "<pre>" & Server.HTMLEncode( "Failed to receive a frame") & "</pre>"
        Response.Write "<pre>" & Server.HTMLEncode( "ReadFrame fail reason = " & ws.ReadFrameFailReason) & "</pre>"
        Response.Write "<pre>" & Server.HTMLEncode( ws.LastErrorText) & "</pre>"
        Response.End
    End If

    receivedFinalFrame = ws.FinalFrame

    ' Show the opcode and final frame bit for the frame just received:
    Response.Write "<pre>" & Server.HTMLEncode( "Frame opcode: " & ws.FrameOpcode) & "</pre>"
    Response.Write "<pre>" & Server.HTMLEncode( "Final frame: " & receivedFinalFrame) & "</pre>"
    Response.Write "<pre>" & Server.HTMLEncode( "--") & "</pre>"
Loop

' Return the message accumulated in the above calls to ReadFrame.
receivedMsg = ws.GetFrameData()
Response.Write "<pre>" & Server.HTMLEncode( "Received: " & receivedMsg) & "</pre>"

' Close the websocket connection.
success = ws.SendClose(1,1000,"Closing this websocket.")
If (success <> 1) Then
    Response.Write "<pre>" & Server.HTMLEncode( ws.LastErrorText) & "</pre>"
    Response.End
End If

' Read the Close response.
success = ws.ReadFrame()
If (success <> 1) Then
    Response.Write "<pre>" & Server.HTMLEncode( "ReadFrame fail reason = " & ws.ReadFrameFailReason) & "</pre>"
    Response.Write "<pre>" & Server.HTMLEncode( ws.LastErrorText) & "</pre>"
    Response.End
End If

' Should receive the "Close" opcode.
Response.Write "<pre>" & Server.HTMLEncode( "Received opcode: " & ws.FrameOpcode) & "</pre>"
' Should be the same status code we sent (1000)
Response.Write "<pre>" & Server.HTMLEncode( "Received close status code: " & ws.CloseStatusCode) & "</pre>"
' The server may echo the close reason.  If not, this will be empty.
Response.Write "<pre>" & Server.HTMLEncode( "Echoed close reason: " & ws.CloseReason) & "</pre>"

Response.Write "<pre>" & Server.HTMLEncode( "Success.") & "</pre>"

%>
</body>
</html>

 

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