What is Ballerina?
Swan Lake

ballerinax/nats

 2.4.0

import ballerinax/nats;

Package Overview

This package provides the capability to send and receive messages by connecting to the NATS server.

NATS messaging enables the communication of data that is segmented into messages among computer applications and services. Data is encoded and framed as a message and sent by a publisher. The message is received, decoded, and processed by one or more subscribers. NATS makes it easy for programs to communicate across different environments, languages, cloud providers, and on-premise systems. Clients connect to the NATS system usually via a single URL and then subscribe or publish messages to a subject.

Basic usage

Set up the connection

First, you need to set up the connection with the NATS Basic server. The following ways can be used to connect to a NATS Basic server.

  1. Connect to a server using the default URL:
1nats:Client natsClient = check new(nats:DEFAULT_URL);
  1. Connect to a server using the URL:
1nats:Client natsClient = check new("nats://serverone:4222");
  1. Connect to one or more servers with custom configurations:
1nats:ConnectionConfiguration config = {
2 connectionName: "my-nats",
3 noEcho: true
4};
5nats:Client natsClient = check new(["nats://serverone:4222", "nats://servertwo:4222"], config);

Publish messages

Publish messages to the NATS basic server

Once connected, publishing is accomplished via one of the three methods below.

  1. Publish with the subject and the message content:
1string message = "hello world";
2nats:Error? result =
3 natsClient->publishMessage({ content: message.toBytes(), subject: "demo.nats.basic"});
  1. Publish as a request that expects a reply:
1string message = "hello world";
2nats:Message|nats:Error reqReply =
3 natsClient->requestMessage({ content: message.toBytes(), subject: "demo.nats.basic"}, 5);
  1. Publish messages with a replyTo subject:
1string message = "hello world";
2nats:Error? result = natsClient->publish({ content: message.toBytes(), subject: "demo.nats.basic",
3 replyTo: "demo.reply" });

Listen to incoming messages

Listen to messages from a NATS server
  1. Listen to incoming messages with the onMessage remote method:
1// Binds the consumer to listen to the messages published to the 'demo.example.*' subject
2@nats:ServiceConfig {
3 subject: "demo.example.*"
4}
5service nats:Service on new nats:Listener(nats:DEFAULT_URL) {
6
7 remote function onMessage(nats:Message message) {
8 }
9}
  1. Listen to incoming messages and reply directly with the onRequest remote method:
1// Binds the consumer to listen to the messages published to the 'demo.example.*' subject
2@nats:ServiceConfig {
3 subject: "demo.example.*"
4}
5service nats:Service on new nats:Listener(nats:DEFAULT_URL) {
6
7 // The returned message will be published to the replyTo subject of the consumed message
8 remote function onRequest(nats:Message message) returns string? {
9 return "Reply Message";
10 }
11}

Advanced usage

Set up TLS

The Ballerina NATS package allows the use of TLS in communication. This setting expects a secure socket to be set in the connection configuration as shown below.

Configure TLS in the nats:Listener
1nats:SecureSocket secured = {
2 cert: {
3 path: "<path>/truststore.p12",
4 password: "password"
5 },
6 key: {
7 path: "<path>/keystore.p12",
8 password: "password"
9 }
10};
11nats:Listener natsListener = check new("nats://serverone:4222", secureSocket = secured);
Configure TLS in the nats:Client
1nats:SecureSocket secured = {
2 cert: {
3 path: "<path>/truststore.p12",
4 password: "password"
5 },
6 key: {
7 path: "<path>/keystore.p12",
8 password: "password"
9 }
10};
11nats:Client natsClient = check new("nats://serverone:4222", secureSocket = secured);

Report issues

To report bugs, request new features, start new discussions, view project boards, etc., go to the Ballerina standard library parent repository.

Useful links

Exported modules

ballerinax/nats


Digest

sha-256:

b8be7897e39f72807f6f05386bc1c776e5ff52977279bfcf0af8c2667dc525f2


License: Apache-2.0

Created date: 08 September,2022


Ballerina compatibility

Platform: java11

Ballerina version: 2201.2.0


Keywords

service

client

messaging

network

pubsub


Contributors
B

Other versions