pubsub

Documentation

Index

• type Adapter
  • func NewInmem() Adapter
  • func NewRedis(client *redis.Client) Adapter
• type Event
• type Subscription

Types

type Adapter

type Adapter interface {
	// Publish publishes a events to a channel.
	Publish(ctx context.Context, channel string, event Event) error
	// Subscribe subscribes to a channel.
	Subscribe(ctx context.Context, channel string) (Subscription, error)
	// HasSubscribers returns true if there are subscribers to the given pattern.
	HasSubscribers(ctx context.Context, pattern string) bool
}

Adapter is an interface for a pubsub adapter. It allows to publish and subscribe []PubsubEvent to views.

func NewInmem

func NewInmem() Adapter

NewInmem creates a new in-memory pubsub adapter.s

func NewRedis

func NewRedis(client *redis.Client) Adapter

NewRedis creates a new redis pubsub adapter.

type Event

type Event struct {
	ID         *string         `json:"id,omitempty"`
	State      eventstate.Type `json:"state,omitempty"`
	Target     *string         `json:"target,omitempty"`
	Detail     *dom.Detail     `json:"detail,omitempty"`
	SessionID  *string         `json:"session_id,omitempty"`
	ElementKey *string         `json:"element_key,omitempty"`
}

type Subscription

type Subscription interface {
	// C returns a receive-only go channel of events published
	C() <-chan Event
	// Close closes the subscription.
	Close()
}

Subscription is a subscription to a channel.