pubsub

Documentation

Overview

Package pubsub wraps nats calls

Index

• Variables
• func NewAssignmentMessage(actorURN string, tenantURN string, assignmentURN string, ...) (*pubsubx.Message, error)
• func NewAssignmentURN(assignmentID string) string
• func NewLoadBalancerMessage(actorURN string, tenantURN string, loadBalancerURN string, ...) (*pubsubx.Message, error)
• func NewLoadBalancerURN(loadBalancerID string) string
• type Client
  • func NewClient(opts ...Option) *Client
  • func (c *Client) AddStream() (*nats.StreamInfo, error)
  • func (c *Client) PublishCreate(ctx context.Context, actor, location string, data *pubsubx.Message) error
  • func (c *Client) PublishDelete(ctx context.Context, actor, location string, data *pubsubx.Message) error
  • func (c *Client) PublishUpdate(ctx context.Context, actor, location string, data *pubsubx.Message) error
• type Option
  • func WithJetreamContext(js nats.JetStreamContext) Option
  • func WithLogger(l *zap.SugaredLogger) Option
  • func WithStreamName(s string) Option
  • func WithSubjectPrefix(p string) Option

Variables

var (
	ErrInvalidActorURN      = errors.New("invalid actor urn")
	ErrInvalidTenantURN     = errors.New("invalid tenant urn")
	ErrInvalidAssignmentURN = errors.New("invalid assignment urn")
	ErrInvalidURN           = errors.New("invalid urn")
)

nolint

Functions

func NewAssignmentMessage

func NewAssignmentMessage(actorURN string, tenantURN string, assignmentURN string, additionalSubjectURNs ...string) (*pubsubx.Message, error)

NewAssignmentMessage creates a new assignment message

func NewAssignmentURN

func NewAssignmentURN(assignmentID string) string

NewAssignmentURN creates a new assignment URN

func NewLoadBalancerMessage

func NewLoadBalancerMessage(actorURN string, tenantURN string, loadBalancerURN string, additionalSubjectURNs ...string) (*pubsubx.Message, error)

NewLoadBalancerMessage creates a new loadbalancer message

func NewLoadBalancerURN

func NewLoadBalancerURN(loadBalancerID string) string

NewLoadBalancerURN creates a new loadbalancer URN

Types

type Client

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

Client is an event bus client with some configuration

func NewClient

func NewClient(opts ...Option) *Client

NewClient configures and establishes a new event bus client connection

func (*Client) AddStream

func (c *Client) AddStream() (*nats.StreamInfo, error)

AddStream checks if a stream exists and attempts to create it if it doesn't. Currently we don't currently check that the stream is configured identically to the desired configuration.

func (*Client) PublishCreate

func (c *Client) PublishCreate(ctx context.Context, actor, location string, data *pubsubx.Message) error

PublishCreate publishes a create event

func (*Client) PublishDelete

func (c *Client) PublishDelete(ctx context.Context, actor, location string, data *pubsubx.Message) error

PublishDelete publishes a delete event

func (*Client) PublishUpdate

func (c *Client) PublishUpdate(ctx context.Context, actor, location string, data *pubsubx.Message) error

PublishUpdate publishes an update event

type Option

type Option func(c *Client)

Option is a functional configuration option for governor eventing

func WithJetreamContext

func WithJetreamContext(js nats.JetStreamContext) Option

WithJetreamContext sets the nats jetstream context

func WithLogger

func WithLogger(l *zap.SugaredLogger) Option

WithLogger sets the client logger

func WithStreamName

func WithStreamName(s string) Option

WithStreamName sets the nats stream name

func WithSubjectPrefix

func WithSubjectPrefix(p string) Option

WithSubjectPrefix sets the nats subject prefix