Develop with Refinitiv Real-Time SDK Docker Image in VS Code 

Introduction

Last Updated: January 2022

Visual Studio Code (or just VS Code) is a free source code editor developed and maintained by Microsoft. This cross-platform editor rapidly gained popularity with developers as it is fast and lightweight, supports a variety of programming languages with IntelliSense (a feature that has originated with VS Code’s older sibling, Visual Studio IDE), and enables complete development operations like debugging, task running, and version control.

VS Code provides numerous extensions that add features and expand development workflows (Example: the REST Client and Thunder Client testing tools). VS Code also supports the remote development that lets you use a container, remote machine, or the Windows Subsystem for Linux (WSL) as a full-featured development environment with the Remote Development Extension Pack.

As part of the Remote Development Extension Pack, the Remote - Containers extension lets developers use a Docker container as a full-featured development environment. It allows the developer to open any folder inside (or mounted into) a container and take advantage of Visual Studio Code's full feature set (IntelliSense, code navigation, debugging, etc) as a local-quality development experience.

This article demonstrates how to use VS Code Remote - Containers extension with the Refinitiv Real-Time SDK  Docker images. Developers can explore the RTSDK, build and run the provided examples codes directly in VS Code IDE.

Note: Please note that the Refinitiv Real-Time SDK isn't qualified for the Docker platform. This article and example projects are intended for development and testing purposes only. If any problems are found while running the example code with RTSDK on with Docker platform, the suspected issues must be reproduced on a bare-metal machine prior to contacting the Refinitiv help-desk support team.

Refinitiv Real-Time SDK Introduction

Refinitiv Real-Time SDK (RTSDK, formerly known as Elektron SDK) is a suite of modern and open source APIs that aim to simplify development through a strong focus on ease of use and standardized access to a broad set of Refinitiv proprietary content and services via the proprietary TCP connection named RSSL and proprietary binary message encoding format named OMM Message.

The SDK source code is available on GitHub, developers can build the RTSDK C++ and Java libraries with the CMake and Gradle build automation tools, C++ and Java, respectively. If developers are new to the SDK, they can use the following RTSDK Docker images to set up and learn the SDK quickly.

• refinitivapis/realtimesdk_c: This docker image contains the latest version of the RTSDK C/C++ libraries and examples.
• refinitivapis/realtimesdk_java: This docker image contains the latest version of the RTSDK Java libraries and examples.

These images include all required dependencies and come with the build scripts and tools. You can check my colleague's Introduction to the refinitivapis/realtimesdk_c Docker Image and Introduction to the refinitivapis/realtimesdk_java Docker Image articles for step-by-step guidance on how to deploy and run the RTSDK Docker images via Docker command line. This article focuses on accessing RTSDK docker images from VS Code.

If you are using the WebSocket API, there is refinitivapis/websocket_api docker image that contains the latest version of WebSocket API Examples too.

Demo prerequisite

This example requires the following dependencies software and libraries.

1. Visual Studio Code editor.
2. Docker Desktop/Engine application.
3. VS Code - Remote Development extension pack
4. Access to the Refinitiv Refinitiv Data Platform and Refinitiv Real-Time - Optimized. (for the RTO example only)
5. Internet connection.

I highly recommend following System requirements and Installation sections to set up your environment.

A devcontainer.json file

The main configuration file that tells VS Code how to access (or create) a development container (aka "Dev container") with a well-defined tool and runtime stack is named devcontainer.json file. The dev container configuration is either located under .devcontainer/devcontainer.json or stored in a file named .devcontainer.json file (note the dot-prefix) in the root of the project.

Note: Make sure to commit a .devcontainer folder to your version control system.

The basic configuration parameters are as follows:

Let me explain these configurations:

• name: A display name for the container.
• image: The name of an image in a container registry that VS Code should use to create the dev container.

The development container lets you pull images from DockerHub, GitHub, and Azure Container Registry repositories, and then perform additional tasks such as installing development tools (Git, etc.), installing VS Code extensions, forward ports, set runtime arguments, etc.

The development container is not limited to Docker images, it supports Dockerfile and Docker Compose too. You can build your image(s) to match your development requirements, and then share Dockerfile and/or docker-compose.yml inside a .devcontainer folder (with a devcontainer.json file) with your colleagues to help them to set up the same development environment.

Please find more details about all devcontainer.json configuration parameters on VS Code - devcontainer.json reference page.

The RTSDK devcontainer.json file

Let's start by creating a devcontainer.json file that pulls the refinitivapis/realtimesdk_java from the DockerHub repository.

The devcontainer.json file above sets the following development properties:

• name: Using "RTSDK_Java" as a display name of the container.
• image: Pull "refinitivapis/realtimesdk_java" Docker image from DockerHub https://hub.docker.com/r/refinitivapis/realtimesdk_java URL.
• workspaceFolder: Sets the default path that VS Code should open when connecting to the container. This devcontainer.json sets the default path to /opt/refinitiv/Real-Time-SDK/Java which is the RTSDK Java package location in the container.
• shutdownAction: set the VS Code stops the container when the editor window is closed / shut down.

Running the Development Container

Docker Desktop/engine should be running prior to the next step.

You can connect to the container and start developing within it by selecting the Remote-Containers: Reopen in Container command from the VS Code Command Palette (F1).

Alternatively, the VS Code can detect whether there is a folder containing a Dev container configuration file, and then asks you if you want to reopen the folder in a container.

Next, the VS Code window (instance) will reload, pull (or clone) the image, and start building the dev container.

There may be a message “Extension Pack for Java is recommended for this repository.” At this point, maybe good to install the Extension for Java, as we intend to use RTSDK Java.

Once this build completes, VS Code automatically connects to the container at the path we set to the workspaceFolder property which is the /opt/refinitiv/Real-Time-SDK/Java folder. You can check the VS Code Remote connection status from the button left toolbar.

If you click this toolbar, VS Code shows the Container Remote connection menu options at the top of the editor.

To close the remote connection, choose the "Close Remote Connection" from the drop-down menu.

Now your VS Code and Dev container are ready to run the RTSDK Java example applications.

Running the RTSDK Java Examples

All files and sub-folders are available in the VS Code explorer. If you open a terminal ( Ctrl+ ` or Ctrl+Shift+ ` - Windows), the current location is /opt/refinitiv/Real-Time-SDK/Java folder too (You can navigate to other locations in the container as well)

The refinitivapis/realtimesdk_java Docker image has built-in all RTSDK Java dependencies and build system, so you can run the SDK examples with the Gradle tool from the VS Code terminal. I am demonstrating with the EMA Java Consumer - Interactive Provider scenario example.

Firstly, open a terminal and run the EMA Java IProvider example 200.

Next, open a new terminal in the same VS Code editor with the  Ctrl+Shift+`  command, and run the EMA Java Consumer example 100.

The results of the EMA Java Consumer - Interactive Provider examples scenario are shown below.

You can run the RTO example, EMA Java ex450_MP_QueryServiceDiscovery with the following command.

The result is shown below.

If you have your own RTDS server in your environment, you can modify the example code to match your RTDS connection requirement. The following example shows the ex100_MP_Streaming example that has been changed the RTDS server endpoint, service name, and RIC name.

Then, developers can run this example application with the ./gradlew runconsumer100 command.

Please find more details regarding how to run the RTSDK Java examples on the RTSDK Java - Quick Start page.

File Sharing between the Host and Dev Container

Please note that all changes (newly created/modified files and folders) stay in the Dev container as long as the container exists (status Up/Running and Exited). However, if you remove the container (docker rm), that container and its data are destroyed. You can additionally mount points to add to the container when created for sharing files between the host and Dev container with a devcontainer.json's mounts attribute.

The devcontainer.json file above mounts the current <host workspace location>/log folder to the /opt/refinitiv/Real-Time-SDK/Java/log folder in a container. If the folder does not exist (either host or container), the VS Code automatically creates a folder(s) for you.

Caution: Please note that if you mount a host folder to an existing container folder (example: /opt/refinitiv/Real-Time-SDK/Java), the container folder will be replaced by a host folder.

Please find more details regarding the mounts property from the VS Code - Add another local file mount page.

Adding EMA Java Log

The best way to demonstrate this feature is enabling the EMA API log messages to capture the API and HTTP REST activities. You do not need to close the remote-connection before updating the devcontainer.json. You can choose the "Open Container Configuration File" in the remote connection menu to open the current devcontainer.json file.

The current devcontainer.json file will be shown in the VS Code editor, you can add the "mounts": ["source={localWorkspaceFolder}/log,target=localWorkspaceFolder/log,target={containerWorkspaceFolder}/log,type=bind,consistency=cached"] configuration to the file.

Next, choose the "Rebuild Container" from the remote connection menu.

After the re-build completes, VS Code automatically creates log folders on the host file system and /opt/refinitiv/Real-Time-SDK/Java/log container's folder.

The ls command helps verify the presence of the mounted folder:

To enable the EMA Java log file, create a Java Logging API logging.properties file in the /opt/refinitiv/Real-Time-SDK/Java/log folder with the following content:

A logging configuration file sets the EMA API to log all API messages to the /opt/refinitiv/Real-Time-SDK/Java/log/ema.log file.

Finally, run the EMA Java ex450_MP_QueryServiceDiscovery RTO example with the -PvmArgs="-Djava.util.logging.config.file=/opt/refinitiv/Real-Time-SDK/Java/log/logging.properties" argument.

Then the API activities, HTTP REST messages log messages are stored in the ema.log file, the logging.properties and log files are available in the host machine too.

You can mount other folders to keep the modified code from the Dev Container back to the host (note: do not mount folders to the container's existing folders).

Running the RTSDK C++ Image

To run the Dev container with the RTSDK C++ Docker image, you can set a devcontainer.json content to load the refinitivapis/realtimesdk_c from Docker Hub and change the workspaceFolder property to the /opt/refinitiv/Real-Time-SDK/Cpp-C folder as follows.

Then, run the "Remote-Containers: Rebuild and Reopen in Container" command (or "Remote-Containers: Reopen in Container" if you are running the Dev container for the first time). After the build completes, VS Code automatically connects to the container at the path we set to the workspaceFolder property which is the /opt/refinitiv/Real-Time-SDK/Cpp-c folder with all pre-installed dependencies and build system.

You can run the RTSDK C++ example in this Dev Container. If you make some changes to the RTSDK C++ example codes (either ETA or EMA), you can re-build the examples by running a make command in the container /opt/refinitiv/Real-Time-SDK/rtsdk folder.

Please find more details regarding how to run the RTSDK C++ examples on the RTSDK C++ - Quick Start page.

How to run the Examples

The first step is to unzip or download the example project folder into a directory of your choice, then set up RTSDK Java or C++ Docker Dev container in a devcontainer.json file based on your preference.

1. Start a Docker desktop or Docker engine in your machine.
2. Open the project folder in the VS Code editor
3. Install the VS Code - Remote Development extension pack.
4. Open the VS Code Command Palette with the F1 key, and then select the Remote-Containers: Reopen in Container command.

Now the VS Code editor is ready to run RTSDK Java (or C++) Dev container.

Conclusion and Next Steps

Docker is an open containerization platform for developing, testing, deploying, and running any software application. It helps developers create a consistent development environment without manually maintaining dependencies and toolsets for the project. The VS Code Remote - Containers extension makes developers work with Docker easier, by integrating VS Code into a Docker container as a full-featured development environment. The extension allows developers to open any folder inside (or mounted into) a container and take advantage of the VS Code's rich feature set.

This example project is just a brief introduction to the Remote - Containers extension. Developers can work with Dockerfile and Docker Compose to build a customized Docker image that matches the development requirements, debugging, install various VS Code extensions to use in the Dev Container (via the GUI or configuration file), clone Docker container from Git repository, attach the VS Code to a running container, port forwarding, and much more. I highly recommend you check the following VS Code resources for more details:

• Developing inside a Container
• Remote development in Containers tutorial
• Create a development container
• devcontainer.json reference

The refinitivapis/realtimesdk_c, refinitivapis/realtimesdk_java, and refinitivapis/websocket_api docker images are good starting points for developers who are new to the Refinitiv Real-Time SDK. Developers can use the Docker image with the Remote - Containers extensions to set up a development environment, that makes running RTSDK examples in VS Code.

If you are the developers who are already familiar with Maven, I highly recommend you check the How to deploy and run Real-Time Java Application with Maven in Docker that shows how to use Maven to set up an RTSDK Java development environment in a Docker container.

References

For further details, please reviewe the following resources:

• Refinitiv Real-Time SDK Java page on the Refinitiv Developer Community website.
• Refinitiv Real-Time SDK Family page.
• Enterprise Message API Java Quick Start
• Developer Webinar: Introduction to Enterprise App Creation With Open-Source Enterprise Message API
• Developer Article: 10 important things you need to know before you write an Enterprise Real Time application
• Introduction to the refinitivapis/realtimesdk_c Docker Image article
• Introduction to the refinitivapis/realtimesdk_java Docker Image article.
• Deploy and Run Refinitiv Real-Time SDK in Docker article.
• How to deploy and run Real-Time Java Application with Maven in Docker article.
• VS Code: Developing inside a Container page.
• VS Code: Remote development in Containers tutorial page.
• VS Code: Create a development container page.
• VS Code: devcontainer.json reference page.
• Setting up a VS Code Dev Container blog post.
• Hands-On with VSCode & "Dev Containers" blog post.
• Development Acceleration Through VS Code Remote Containers: An Introduction blog post.

For any questions related to this article or the RTSDK page, please use the Developer Community Q&A Forum.

GitHub

Refinitiv-API-Samples/Article.RTSDK.Java.Cpp.DevContainer