Installation

To install a Solace Messaging API, unzip the archive file for your supported platform.

Solace Java RTO API

The extracted package contains the following subdirectories in the /solclientj directory

  • docs — Solace Java RTO API developer reference documentation
  • lib — Solace Java RTO API libraries
  • license — contains the Apache license version 2.0 agreement and JZlib license for use with Solace Java RTO API
  • samples — contains Solace Java RTO API sample applications that provide a basic introduction to how to use JCSMP for messaging applications; for detailed information, see the readme.txt file included in this directory

Solace C API

The extracted package contains the following subdirectories in the solclient directory:

ex — Solace C API sample applications that provide a basic introduction to how to use the Solace C API for messaging applications; for detailed information on how to run these sample applications, see the README.txt file included in this directory

include — Solace C API header files

Intro — introductory Solace C API sample applications to clearly illustrate message concepts; these sample applications do not include error checking no handling

lib — Solace C API runtime libraries

 

The Solace C API developer online reference documentation for all platforms is found in a separate solclient-doc.tar.gz archive.

Solace .NET API

The extracted manually downloaded package contains the following subdirectories in the /solclient-dotnet directory:

docs — Solace .NET API developer online reference help file (.chm)

ex — Solace .NET API sample applications that provide a basic introduction to how to use the Solace .NET API for messaging applications; for detailed information on how to run these sample applications, see the README.txt file included in this directory

intro — introductory Solace .NET API sample applications to clearly illustrate message concepts; these sample applications do not include error checking no handling.

lib — contains Solace .NET API assemblies and Solace C API runtime libraries

The NuGet package contains the following subdirectories:

Solace JavaScript API

To install the web browser-based Solace JavaScript API, unzip the solclientjs-<version>.zip file on any supported platform. The resulting solclientjs directory contains the following directories:

  • docs—Contains the Solace JavaScript API Reference.

    The API developer online reference is an online help application describing the classes, interfaces, constructors, methods, and fields.

  • lib—Contains the release and debug versions of the Solace JavaScript API library files.

Solace Node.js API

The API is available as a Node.js module, solclientjs. To install the Solace Messaging API for Node.js from the npm registry, ensure that Node.js and the npm package manager for Node.js are properly installed, and then execute the following command from your project's root folder:

npm install solclientjs

The resulting node_modules/solclientjs directory contains the following directories:

  • docs—Contains the Solace JavaScript API reference.

  • lib—Contains the Node.js module files.