(PureBasic) 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 PureBasic Module Download Chilkat PureBasic Module

IncludeFile "CkWebSocket.pb"
IncludeFile "CkRest.pb"

Procedure ChilkatExample()

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

    ws.i = CkWebSocket::ckCreate()
    If ws.i = 0
        Debug "Failed to create object."
        ProcedureReturn
    EndIf

    ; 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.
    CkWebSocket::setCkPongAutoConsume(ws, 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.

    rest.i = CkRest::ckCreate()
    If rest.i = 0
        Debug "Failed to create object."
        ProcedureReturn
    EndIf

    ; 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.i = CkRest::ckConnect(rest,"websockets.chilkat.io",80,0,0)
    CkWebSocket::ckUseConnection(ws,rest)
    CkWebSocket::ckAddClientHeaders(ws)
    responseBodyIgnored.s = CkRest::ckFullRequestNoBody(rest,"GET","/wsChilkatEcho.ashx")
    success = CkWebSocket::ckValidateServerHandshake(ws)
    If success <> 1
        Debug CkWebSocket::ckLastErrorText(ws)
        CkWebSocket::ckDispose(ws)
        CkRest::ckDispose(rest)
        ProcedureReturn
    EndIf

    ; 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.i = 0
    success = CkWebSocket::ckSendFrame(ws,"This is the 1st frame" + Chr(13) + Chr(10),finalFrame)
    If success <> 1
        Debug CkWebSocket::ckLastErrorText(ws)
        CkWebSocket::ckDispose(ws)
        CkRest::ckDispose(rest)
        ProcedureReturn
    EndIf

    ; Let's send a Ping frame here...
    success = CkWebSocket::ckSendPing(ws,"This is a ping")
    If success <> 1
        Debug CkWebSocket::ckLastErrorText(ws)
        CkWebSocket::ckDispose(ws)
        CkRest::ckDispose(rest)
        ProcedureReturn
    EndIf

    ; Send the 2nd frame in the message.
    success = CkWebSocket::ckSendFrame(ws,"This is the 2nd frame" + Chr(13) + Chr(10),finalFrame)
    If success <> 1
        Debug CkWebSocket::ckLastErrorText(ws)
        CkWebSocket::ckDispose(ws)
        CkRest::ckDispose(rest)
        ProcedureReturn
    EndIf

    ; Send the 3rd and final frame in the message.
    finalFrame = 1
    success = CkWebSocket::ckSendFrame(ws,"This is the 3rd and final frame" + Chr(13) + Chr(10),finalFrame)
    If success <> 1
        Debug CkWebSocket::ckLastErrorText(ws)
        CkWebSocket::ckDispose(ws)
        CkRest::ckDispose(rest)
        ProcedureReturn
    EndIf

    ; 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.i = 0
    While receivedFinalFrame = 0

        success = CkWebSocket::ckReadFrame(ws)
        If success <> 1
            Debug "Failed to receive a frame"
            Debug "ReadFrame fail reason = " + Str(CkWebSocket::ckReadFrameFailReason(ws))
            Debug CkWebSocket::ckLastErrorText(ws)
            CkWebSocket::ckDispose(ws)
            CkRest::ckDispose(rest)
            ProcedureReturn
        EndIf

        receivedFinalFrame = CkWebSocket::ckFinalFrame(ws)

        ; Show the opcode and final frame bit for the frame just received:
        Debug "Frame opcode: " + CkWebSocket::ckFrameOpcode(ws)
        Debug "Final frame: " + Str(receivedFinalFrame)
        Debug "--"
    Wend

    ; Return the message accumulated in the above calls to ReadFrame.
    receivedMsg.s = CkWebSocket::ckGetFrameData(ws)
    Debug "Received: " + receivedMsg

    ; Close the websocket connection.
    success = CkWebSocket::ckSendClose(ws,1,1000,"Closing this websocket.")
    If success <> 1
        Debug CkWebSocket::ckLastErrorText(ws)
        CkWebSocket::ckDispose(ws)
        CkRest::ckDispose(rest)
        ProcedureReturn
    EndIf

    ; Read the Close response.
    success = CkWebSocket::ckReadFrame(ws)
    If success <> 1
        Debug "ReadFrame fail reason = " + Str(CkWebSocket::ckReadFrameFailReason(ws))
        Debug CkWebSocket::ckLastErrorText(ws)
        CkWebSocket::ckDispose(ws)
        CkRest::ckDispose(rest)
        ProcedureReturn
    EndIf

    ; Should receive the "Close" opcode.
    Debug "Received opcode: " + CkWebSocket::ckFrameOpcode(ws)
    ; Should be the same status code we sent (1000)
    Debug "Received close status code: " + Str(CkWebSocket::ckCloseStatusCode(ws))
    ; The server may echo the close reason.  If not, this will be empty.
    Debug "Echoed close reason: " + CkWebSocket::ckCloseReason(ws)

    Debug "Success."


    CkWebSocket::ckDispose(ws)
    CkRest::ckDispose(rest)


    ProcedureReturn
EndProcedure