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

Excel Examples

ASN.1
Amazon S3
Amazon S3 (new)
Amazon SES
Amazon SNS
Amazon SQS
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
Facebook
Firebase
GMail REST API
GeoOp
Google APIs
Google Calendar
Google Cloud Storage
Google Drive
Google Sheets
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
Upload
VoiceBase
Walmart
WebSocket
XAdES
XML
XML Digital Signatures
XMP
Xero
Zip
curl
eBay

 

 

 

(Excel) 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.

Download Excel Class Modules

Chilkat Excel Class Modules

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

Dim ws As Chilkat.WebSocket
Set ws = Chilkat.NewWebSocket

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

Dim rest As Chilkat.Rest
Set rest = Chilkat.NewRest
'  Connect to websockets.chilkat.io
'  (websockets.chilkat.io accepts frames of up to 16K in size and echoes them back)

success = rest.Connect("websockets.chilkat.io",80,False,False)
success = ws.UseConnection(rest)
success = ws.AddClientHeaders()

responseBodyIgnored = rest.FullRequestNoBody("GET","/wsChilkatEcho.ashx")
success = ws.ValidateServerHandshake()
If (success <> True) Then
    Debug.Print ws.LastErrorText
    Exit Sub
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 = False
success = ws.SendFrame("This is the 1st frame" & vbCrLf,finalFrame)
If (success <> True) Then
    Debug.Print ws.LastErrorText
    Exit Sub
End If

'  Send the 2nd frame in the message.
success = ws.SendFrame("This is the 2nd frame" & vbCrLf,finalFrame)
If (success <> True) Then
    Debug.Print ws.LastErrorText
    Exit Sub
End If

'  Send the 3rd and final frame in the message.
finalFrame = True
success = ws.SendFrame("This is the 3rd frame" & vbCrLf,finalFrame)
If (success <> True) Then
    Debug.Print ws.LastErrorText
    Exit Sub
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 = False
Do While receivedFinalFrame = False

    success = ws.ReadFrame()
    If (success <> True) Then
        Debug.Print "Failed to receive a frame"
        Debug.Print "ReadFrame fail reason = "; ws.ReadFrameFailReason
        Debug.Print ws.LastErrorText
        Exit Sub
    End If

    receivedFinalFrame = ws.FinalFrame

    '  Show the opcode and final frame bit for the frame just received:
    Debug.Print "Frame opcode: "; ws.FrameOpcode
    Debug.Print "Final frame: "; receivedFinalFrame
Loop

'  Return the message accumulated in the above calls to ReadFrame.

receivedMsg = ws.GetFrameData()
Debug.Print "Received: "; receivedMsg

'  Close the websocket connection.
success = ws.SendClose(True,1000,"Closing this websocket.")
If (success <> True) Then
    Debug.Print ws.LastErrorText
    Exit Sub
End If

'  Read the Close response.
success = ws.ReadFrame()
If (success <> True) Then
    Debug.Print "ReadFrame fail reason = "; ws.ReadFrameFailReason
    Debug.Print ws.LastErrorText
    Exit Sub
End If

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

Debug.Print "Success."

 

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