README.md

Solace PubSub+ Messaging API for Go

This repository contains sample code to showcase how the Solace PubSub+ Go API could be used. You can find:

1. /patterns --> runnable code showcasing different message exchange patters with the PubSub+ Go API.
2. /howtos --> code snippets showcasing how to use different features of the API. All howtos are named how_to_*.go with some sampler files under sub-folders.

Environment Setup

1. Install the latest supported version of Go from https://go.dev/doc/install. Currently, the samples are run and tested against Go v1.17.
2. Install the Solace PubSub+ Messaging API for Go into the root of this directory. This is done by either:
   1. run go get solace.dev/go/messaging
   2. Downloading the API archive from the Solace Community
   3. Clone the source code into the root of this repo

Run Patterns

1. [Skip if existing] Initialize the directory with Go modules go mod init SolaceSamples.com/PubSub+Go.
2. [For local development] Modify the go.mod file to replace solace.dev/go/messaging with the local version of ./pubsubplus-go-client by adding the following line in your go.mod file

   replace solace.dev/go/messaging vX.Y.Z => ./pubsubplus-go-client
   

   where X.Y.Z refer to the version of the API being used.
3. [For local development] Unzip the contents of the PubSub+ Go API tar folder into a pubsubplus-go-client folder in this directory.
4. Run the samples. There are two way to run the samples:
   1. go run: Navigate to the patterns directory and execute go run <name_of_sample>.go
   2. go build: Navigate to the patterns directory and execute go build <name_of_sample>.go -o <name_of_sample>. This will produce an executable that can be run via ./<name_of_sample>
5. Note on environment variables: you can pass the hostname, VPN name, username, and password as environment variables before running the samples as follows:

SOLACE_HOST=<host_name> SOLACE_VPN=<vpn_name> SOLACE_USERNAME=<username> SOLACE_PASSWORD=<password> go run <name_of_sample>.go

Howtos

This directory contains code that showcases different features of the API

Supported Environments

• See the list of supported environments here: Solace Go API - Supported Environments
• Monitor the Solace Community for updates on supported environments.

Resources

• Solace Developer Portal is at solace.dev.
• Ask the Solace Community for further discussions and questions.
• Solace PubSub+ Messaging API for Go documentation