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

VBScript 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
CAdES
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

 

 

 

(VBScript) 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

Dim fso, outFile
Set fso = CreateObject("Scripting.FileSystemObject")
Set outFile = fso.CreateTextFile("output.txt", True)

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

set ws = CreateObject("Chilkat_9_5_0.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.

set rest = 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
    outFile.WriteLine(ws.LastErrorText)
    WScript.Quit
End If

' 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" & vbCrLf,finalFrame)
If (success <> 1) Then
    outFile.WriteLine(ws.LastErrorText)
    WScript.Quit
End If

' Send the 2nd frame in the message.
success = ws.SendFrame("This is the 2nd frame" & vbCrLf,finalFrame)
If (success <> 1) Then
    outFile.WriteLine(ws.LastErrorText)
    WScript.Quit
End If

' Send the 3rd and final frame in the message.
finalFrame = 1
success = ws.SendFrame("This is the 3rd frame" & vbCrLf,finalFrame)
If (success <> 1) Then
    outFile.WriteLine(ws.LastErrorText)
    WScript.Quit
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.
receivedFinalFrame = 0
Do While receivedFinalFrame = 0

    success = ws.ReadFrame()
    If (success <> 1) Then
        outFile.WriteLine("Failed to receive a frame")
        outFile.WriteLine("ReadFrame fail reason = " & ws.ReadFrameFailReason)
        outFile.WriteLine(ws.LastErrorText)
        WScript.Quit
    End If

    receivedFinalFrame = ws.FinalFrame

    ' Show the opcode and final frame bit for the frame just received:
    outFile.WriteLine("Frame opcode: " & ws.FrameOpcode)
    outFile.WriteLine("Final frame: " & receivedFinalFrame)
Loop

' Return the message accumulated in the above calls to ReadFrame.
receivedMsg = ws.GetFrameData()
outFile.WriteLine("Received: " & receivedMsg)

' Close the websocket connection.
success = ws.SendClose(1,1000,"Closing this websocket.")
If (success <> 1) Then
    outFile.WriteLine(ws.LastErrorText)
    WScript.Quit
End If

' Read the Close response.
success = ws.ReadFrame()
If (success <> 1) Then
    outFile.WriteLine("ReadFrame fail reason = " & ws.ReadFrameFailReason)
    outFile.WriteLine(ws.LastErrorText)
    WScript.Quit
End If

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

outFile.WriteLine("Success.")

outFile.Close

 

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