cloud

Documentation

Overview

Package cloud implements an events.PubSub implementation that uses Go Cloud PubSub.

Example

package main

import (
	"context"

	"go.thethings.network/lorawan-stack/v3/pkg/events"
	"go.thethings.network/lorawan-stack/v3/pkg/events/cloud"
	"go.thethings.network/lorawan-stack/v3/pkg/task"

	_ "gocloud.dev/pubsub/mempubsub"
)

func main() {
	// The task starter is used for automatic re-subscription on failure.
	taskStarter := task.StartTaskFunc(task.DefaultStartTask)

	// Import the desired cloud pub-sub drivers (see godoc.org/gocloud.dev).
	// In this example we use "gocloud.dev/pubsub/mempubsub".

	cloudPubSub, err := cloud.NewPubSub(context.TODO(), taskStarter, "mem://events", "mem://events")
	if err != nil {
		panic(err)
	}

	// Replace the default pubsub so that we will now publish to a Go Cloud pub sub.
	events.SetDefaultPubSub(cloudPubSub)
}

Index

• type PubSub
  • func NewPubSub(ctx context.Context, taskStarter task.Starter, pubURL, subURL string) (*PubSub, error)
  • func (ps *PubSub) Close(ctx context.Context) error
  • func (ps *PubSub) Publish(evs ...events.Event)
  • func (ps *PubSub) Subscribe(ctx context.Context, names []string, ids []*ttnpb.EntityIdentifiers, ...) error

Examples

• Package

Types

type PubSub

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

PubSub with Go Cloud backend.

func NewPubSub

func NewPubSub(ctx context.Context, taskStarter task.Starter, pubURL, subURL string) (*PubSub, error)

NewPubSub creates a new PubSub that publishes and subscribes to Go Cloud. If the subURL is an empty string, this PubSub will only publish to Go Cloud.

func (*PubSub) Close

func (ps *PubSub) Close(ctx context.Context) error

Close the Go Cloud publisher.

func (*PubSub) Publish

func (ps *PubSub) Publish(evs ...events.Event)

Publish an event to Go Cloud.

func (*PubSub) Subscribe

func (ps *PubSub) Subscribe(
	ctx context.Context, names []string, ids []*ttnpb.EntityIdentifiers, hdl events.Handler,
) error

Subscribe to events from Go Cloud.