nats

Documentation

Overview

Package nats provides a Vice implementation for NATS. Copied from the original project and modified to support broadcasting to multiple receivers, and encoded data format to avoid marshal/unmarshal error from go-nats.

Index

• Constants
• type Option
  • func WithConnection(c *nats.Conn) Option
• type Options
• type Transport
  • func New(opts ...Option) *Transport
  • func (t *Transport) Done() chan struct{}
  • func (t *Transport) ErrChan() <-chan error
  • func (t *Transport) Receive(name string) <-chan event.NormalizedEvent
  • func (t *Transport) ReceiveBool(name string) <-chan bool
  • func (t *Transport) Send(name string) chan<- event.NormalizedEvent
  • func (t *Transport) SendBool(name string) chan<- bool
  • func (t *Transport) Stop()

Constants

const DefaultAddr = nats.DefaultURL

DefaultAddr is the NATS default TCP address.

Types

type Option

type Option func(*Options)

Option is a function on the options for a nats transport.

func WithConnection

func WithConnection(c *nats.Conn) Option

WithConnection is an Option to set underlying nats connection.

type Options

type Options struct {
	Conn       *nats.Conn
	UseEncoded bool
}

Options can be used to create a customized transport.

type Transport

type Transport struct {
	sync.Mutex

	// exported fields
	NatsAddr       string
	NatsQueueGroup string
	// contains filtered or unexported fields
}

Transport implement VTransport

func New

func New(opts ...Option) *Transport

New returns a new Transport

func (*Transport) Done

func (t *Transport) Done() chan struct{}

Done gets a channel which is closed when the transport has successfully stopped.

func (*Transport) ErrChan

func (t *Transport) ErrChan() <-chan error

ErrChan gets the channel on which errors are sent.

func (*Transport) Receive

func (t *Transport) Receive(name string) <-chan event.NormalizedEvent

Receive gets a channel on which to receive messages

func (*Transport) ReceiveBool

func (t *Transport) ReceiveBool(name string) <-chan bool

ReceiveBool gets a channel on which to receive messages

func (*Transport) Send

func (t *Transport) Send(name string) chan<- event.NormalizedEvent

Send gets a channel on which messages with the specified name may be sent.

func (*Transport) SendBool

func (t *Transport) SendBool(name string) chan<- bool

SendBool gets a channel on which messages with the specified name may be sent.

func (*Transport) Stop

func (t *Transport) Stop()

Stop stops the transport. The channel returned from Done() will be closed when the transport has stopped.