WebSocket Client Read and Write Samples

About The Samples

In this sample, the Spotfire Streaming WebSocket Client Read adapter and the StreamBase® WebSocket Client Write adapter work together to read data from a server, modify it, and write it back to the server.

When this sample is started a web server is created on port 8080.

Importing This Sample into StreamBase Studio

In StreamBase Studio, import this sample with the following steps:

  • From the top-level menu, select File>Import Samples and Community Content.

  • Enter websoc to narrow the list of options.

  • Select WebSocket Client Read Write adapters from the StreamBase Standard Adapters category.

  • Click Import Now.

StreamBase Studio creates a project for the sample.

Running This Sample in StreamBase Studio

  1. In the Project Explorer view, open the sample you just loaded.

    If you see red marks on a project folder, wait a moment for the project to load its features.

    If the red marks do not resolve themselves after a minute, select the project, right-click, and select Maven>Update Project from the context menu.

  2. Open the src/main/eventflow/packageName folder.

  3. To enable WebSocket Secure (wss), open the WebSocketClient.sbapp file and double click to open the ReadAdapter. Otherwise, continue to step 4.

    Open the Advanced tab and configure wss settings as needed.

  4. Click the Run button. This opens the SB Test/Debug perspective and starts the module.

  5. In the Manual Input window under the WebSocketControl stream, enter connect as command, click send. WebSocketStatus will indicate successful connection to server.

  6. Then under the Feed stream, enter Equity, Bid, BidSize, Ask, and AskSize data and click send.

  7. In the Output Streams view, observe a tuple emitted on the ReadAdapterDataOut stream indicating that the WebSocket Client Read adapter successfully read data from the server. Also notice that on the WebSocketDataIn stream, a tuple is entered with the Data field reading This data was written by an adapter followed by the data entered in the manual input window. This indicates that the WebSocket Client Write adapter successfully wrote data to the server.

  8. Press F9 or click the Terminate EventFlow Fragment button.

Sample Location

When you load the sample into StreamBase® Studio, Studio copies the sample project's files to your Studio workspace, which is normally part of your home directory, with full access rights.


Load this sample in StreamBase® Studio, and thereafter use the Studio workspace copy of the sample to run and test it, even when running from the command prompt.

Using the workspace copy of the sample avoids permission problems. The default workspace location for this sample is:


See Default Installation Directories for the default location of studio-workspace on your system.