nats

Documentation

Overview

Package nats hold the implementation of the Publisher and PubSub interfaces for the NATS messaging system, the internal messaging broker of the Mainflux IoT platform. Due to the practical requirements implementation Publisher is created alongside PubSub. The reason for this is that Subscriber implementation of NATS brings the burden of additional struct fields which are not used by Publisher. Subscriber is not implemented separately because PubSub can be used where Subscriber is needed.

Index

• Constants
• type PubSub
  • func NewPubSub(url, queue string, logger log.Logger) (PubSub, error)
• type Publisher
  • func NewPublisher(url string) (Publisher, error)

Constants

const SubjectAllChannels = "channels.>"

SubjectAllChannels represents subject to subscribe for all the channels.

Types

type PubSub

type PubSub interface {
	messaging.PubSub
	Close()
}

PubSub wraps messaging Publisher exposing Close() method for NATS connection.

func NewPubSub

func NewPubSub(url, queue string, logger log.Logger) (PubSub, error)

NewPubSub returns NATS message publisher/subscriber. Parameter queue specifies the queue for the Subscribe method. If queue is specified (is not an empty string), Subscribe method will execute NATS QueueSubscribe which is conceptually different from ordinary subscribe. For more information, please take a look here: https://docs.nats.io/developing-with-nats/receiving/queues. If the queue is empty, Subscribe will be used.

type Publisher

type Publisher interface {
	messaging.Publisher
	Close()
}

Publisher wraps messaging Publisher exposing Close() method for NATS connection.

func NewPublisher

func NewPublisher(url string) (Publisher, error)

NewPublisher returns NATS message Publisher.