pubsub

Documentation

Index

• type Filter
• type Handler
• type PubSub
  • func NewPubSub() PubSub
• type SubOpt
  • func WithFilter(filter Filter) SubOpt
• type SubOptions

Types

type Filter

type Filter func(msg interface{}) bool

Filter is a function to filter out messages before they reach a subscriptions primary Handler

type Handler

type Handler func(msg interface{}) bool

Handler is the function executed against the inbound message in a subscription

type PubSub

type PubSub interface {
	// Publish publishes the object to the channel by name
	Publish(channel string, obj interface{}) error
	// Subscribe subscribes to the given channel until the context is cancelled.
	Subscribe(ctx context.Context, channel string, handler Handler, opts ...SubOpt) error
	// Close closes all subscriptions
	Close()
}

PubSub is used to asynchronously pass messages between routines.

func NewPubSub

func NewPubSub() PubSub

type SubOpt

type SubOpt func(options *SubOptions)

func WithFilter

func WithFilter(filter Filter) SubOpt

type SubOptions

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