Unicode C

Send and Receive WebSocket Frame

See more WebSocket Examples

Demonstrates how to send a websocket text frame to a websocket echo server. This example uses Chilkat's websocket test echo server at ws://websockets.chilkat.io/wsChilkatEcho.ashx

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.

Unicode C

#include <C_CkWebSocketW.h>
#include <C_CkRestW.h>

void ChilkatSample(void)
    {
    BOOL success;
    HCkWebSocketW ws;
    HCkRestW rest;
    const wchar_t *responseBodyIgnored;
    BOOL finalFrame;
    const wchar_t *receivedStr;

    success = FALSE;

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

    ws = CkWebSocketW_Create();

    // 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 = CkRestW_Create();
    // 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 = CkRestW_Connect(rest,L"websockets.chilkat.io",80,FALSE,FALSE);
    CkWebSocketW_UseConnection(ws,rest);
    CkWebSocketW_AddClientHeaders(ws);
    responseBodyIgnored = CkRestW_fullRequestNoBody(rest,L"GET",L"/wsChilkatEcho.ashx");
    success = CkWebSocketW_ValidateServerHandshake(ws);
    if (success != TRUE) {
        wprintf(L"%s\n",CkWebSocketW_lastErrorText(ws));
        CkWebSocketW_Dispose(ws);
        CkRestW_Dispose(rest);
        return;
    }

    // This example demonstrates sending a frame and receiving a text frame.

    // Send a frame containing the string "Hello World!"
    // This will be the first and final frame, and therefore this constitutes the entire message.
    finalFrame = TRUE;
    success = CkWebSocketW_SendFrame(ws,L"Hello World!",finalFrame);
    if (success != TRUE) {
        wprintf(L"%s\n",CkWebSocketW_lastErrorText(ws));
        CkWebSocketW_Dispose(ws);
        CkRestW_Dispose(rest);
        return;
    }

    // Read an incoming frame.
    success = CkWebSocketW_ReadFrame(ws);
    if (success != TRUE) {
        wprintf(L"Failed to receive a frame\n");
        wprintf(L"ReadFrame fail reason = %d\n",CkWebSocketW_getReadFrameFailReason(ws));
        wprintf(L"%s\n",CkWebSocketW_lastErrorText(ws));
        CkWebSocketW_Dispose(ws);
        CkRestW_Dispose(rest);
        return;
    }

    // Show the string that was received.
    receivedStr = CkWebSocketW_getFrameData(ws);
    wprintf(L"Received: %s\n",receivedStr);

    // Close the websocket connection.
    success = CkWebSocketW_SendClose(ws,TRUE,1000,L"Closing this websocket.");
    if (success != TRUE) {
        wprintf(L"%s\n",CkWebSocketW_lastErrorText(ws));
        CkWebSocketW_Dispose(ws);
        CkRestW_Dispose(rest);
        return;
    }

    // Read the Close response.
    success = CkWebSocketW_ReadFrame(ws);
    if (success != TRUE) {
        wprintf(L"ReadFrame fail reason = %d\n",CkWebSocketW_getReadFrameFailReason(ws));
        wprintf(L"%s\n",CkWebSocketW_lastErrorText(ws));
        CkWebSocketW_Dispose(ws);
        CkRestW_Dispose(rest);
        return;
    }

    // Should receive the "Close" opcode.
    wprintf(L"Received opcode: %s\n",CkWebSocketW_frameOpcode(ws));
    // Should be the same status code we sent (1000)
    wprintf(L"Received close status code: %d\n",CkWebSocketW_getCloseStatusCode(ws));
    // The server may echo the close reason.  If not, this will be empty.
    wprintf(L"Echoed close reason: %s\n",CkWebSocketW_closeReason(ws));

    wprintf(L"Success.\n");


    CkWebSocketW_Dispose(ws);
    CkRestW_Dispose(rest);

    }