embed

Documentation

Overview

Package embed starts and supervises a single NATS JetStream server in-process. Single-node only per D-55.

Index

• type Node
  • func StartNode(cfg NodeConfig) (*Node, error)
  • func (n *Node) ClientURL() string
  • func (n *Node) Server() *natsserver.Server
  • func (n *Node) Shutdown()
• type NodeConfig

Types

type Node

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

Node wraps a running NATS server instance.

func StartNode

func StartNode(cfg NodeConfig) (*Node, error)

StartNode starts a single-node embedded NATS JetStream server. Host defaults to "127.0.0.1", ReadyWait defaults to 10s. Port 0 or -1 selects a random available port.

func (*Node) ClientURL

func (n *Node) ClientURL() string

ClientURL returns the NATS client URL for connecting to this server.

func (*Node) Server

func (n *Node) Server() *natsserver.Server

Server returns the underlying NATS server instance.

func (*Node) Shutdown

func (n *Node) Shutdown()

Shutdown stops the embedded NATS server and waits for it to fully stop.

type NodeConfig

type NodeConfig struct {
	ServerName string
	Host       string
	Port       int
	StoreDir   string
	ReadyWait  time.Duration
}

NodeConfig configures an embedded NATS server. Zero values get sensible defaults via StartNode.