Java

Send and Receive WebSocket Messages

See more WebSocket Examples

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.

Java

import com.chilkatsoft.*;

public class ChilkatExample {

  static {
    try {
        System.loadLibrary("chilkat");
    } catch (UnsatisfiedLinkError e) {
      System.err.println("Native code library failed to load.\n" + e);
      System.exit(1);
    }
  }

  public static void main(String argv[])
  {
    boolean success = false;

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

    CkWebSocket ws = new CkWebSocket();

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

    CkRest rest = new CkRest();
    // 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,false,false);
    ws.UseConnection(rest);
    ws.AddClientHeaders();
    String responseBodyIgnored = rest.fullRequestNoBody("GET","/wsChilkatEcho.ashx");
    success = ws.ValidateServerHandshake();
    if (success != true) {
        System.out.println(ws.lastErrorText());
        return;
        }

    // 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.
    boolean finalFrame = false;
    success = ws.SendFrame("This is the 1st frame\r\n",finalFrame);
    if (success != true) {
        System.out.println(ws.lastErrorText());
        return;
        }

    // Send the 2nd frame in the message.
    success = ws.SendFrame("This is the 2nd frame\r\n",finalFrame);
    if (success != true) {
        System.out.println(ws.lastErrorText());
        return;
        }

    // Send the 3rd and final frame in the message.
    finalFrame = true;
    success = ws.SendFrame("This is the 3rd frame\r\n",finalFrame);
    if (success != true) {
        System.out.println(ws.lastErrorText());
        return;
        }

    // 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.
    boolean receivedFinalFrame = false;
    while (receivedFinalFrame == false) {

        success = ws.ReadFrame();
        if (success != true) {
            System.out.println("Failed to receive a frame");
            System.out.println("ReadFrame fail reason = " + ws.get_ReadFrameFailReason());
            System.out.println(ws.lastErrorText());
            return;
            }

        receivedFinalFrame = ws.get_FinalFrame();

        // Show the opcode and final frame bit for the frame just received:
        System.out.println("Frame opcode: " + ws.frameOpcode());
        System.out.println("Final frame: " + receivedFinalFrame);
        }

    // Return the message accumulated in the above calls to ReadFrame.
    String receivedMsg = ws.getFrameData();
    System.out.println("Received: " + receivedMsg);

    // Close the websocket connection.
    success = ws.SendClose(true,1000,"Closing this websocket.");
    if (success != true) {
        System.out.println(ws.lastErrorText());
        return;
        }

    // Read the Close response.
    success = ws.ReadFrame();
    if (success != true) {
        System.out.println("ReadFrame fail reason = " + ws.get_ReadFrameFailReason());
        System.out.println(ws.lastErrorText());
        return;
        }

    // Should receive the "Close" opcode.
    System.out.println("Received opcode: " + ws.frameOpcode());
    // Should be the same status code we sent (1000)
    System.out.println("Received close status code: " + ws.get_CloseStatusCode());
    // The server may echo the close reason.  If not, this will be empty.
    System.out.println("Echoed close reason: " + ws.closeReason());

    System.out.println("Success.");
  }
}