nats

README

Grav Transport: NATS

This is a streaming transport plugin for Grav that uses NATS.

Connections are managed by the Transport object.

Documentation

Index

• type Conn
  • func (c *Conn) Close()
  • func (c *Conn) Start(pod *grav.Pod)
• type Transport
  • func New(endpoint string) (*Transport, error)
  • func (t *Transport) ConnectTopic(topic string) (grav.BridgeConnection, error)
  • func (t *Transport) Setup(opts *grav.BridgeOptions) error

Types

type Conn

type Conn struct {
	// contains filtered or unexported fields
}

Conn implements transport.TopicConnection and represents a subscribe/send pair for a NATS topic

func (*Conn) Close

func (c *Conn) Close()

Close closes the underlying connection

func (*Conn) Start

func (c *Conn) Start(pod *grav.Pod)

Start begins the receiving of messages

type Transport

type Transport struct {
	// contains filtered or unexported fields
}

Transport is a transport that connects Grav nodes via NATS

func New

func New(endpoint string) (*Transport, error)

New creates a new NATS transport

func (*Transport) ConnectTopic

func (t *Transport) ConnectTopic(topic string) (grav.BridgeConnection, error)

ConnectTopic connects to a topic if the transport is a bridge

func (*Transport) Setup

func (t *Transport) Setup(opts *grav.BridgeOptions) error

Setup sets up the transport