pubsub

Documentation

Overview

Package pubsub contains types to deal with subscriptions.

Index

• type PubSub
  • func New(historyCap int) *PubSub
  • func (p *PubSub) LastMessageID() uint64
  • func (p *PubSub) Publish(messageType string, message interface{})
  • func (p *PubSub) Subscribe(ctx context.Context, messageType string, since uint64, fn func(interface{}))

Types

type PubSub

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

PubSub deals with subscribing and publishing messages.

func New

func New(historyCap int) *PubSub

New creates a new PubSub. It will keep a history for each message type with at least the given cap.

func (*PubSub) LastMessageID

func (p *PubSub) LastMessageID() uint64

LastMessageID returns the ID of the last message.

func (*PubSub) Publish

func (p *PubSub) Publish(messageType string, message interface{})

Publish will publish a message of the given type to all subscribers for that type.

func (*PubSub) Subscribe

func (p *PubSub) Subscribe(
	ctx context.Context,
	messageType string,
	since uint64,
	fn func(interface{}),
)

Subscribe register a function that will receive messages of the given type. To unsubscribe the context must be closed.