pubsub

package module

v1.0.0 Latest Latest Go to latest Published: Sep 27, 2022 License: MIT Imports: 5 Imported by: 0

Details

Valid go.mod file

The Go module system was introduced in Go 1.11 and is the official dependency management solution for Go.
Redistributable license

Redistributable licenses place minimal restrictions on how software can be used, modified, and redistributed.
Tagged version

Modules with tagged versions give importers more predictable builds.
Stable version

When a project reaches major version v1 it is considered stable.
Learn more about best practices

View Source

const TraceIDContextKey string = "trace_id"

TraceIDContextKey defines the trace id key in a context.

This section is empty.

This section is empty.

type PubSubClient[T any] struct {
	// contains filtered or unexported fields
}

PubSubClient is a client of Google Pubsub topic with schema of type T.

func MustNewPubSubClient[T any](params *PubSubClientParams[T]) *PubSubClient[T]

MustNewPubSubClient creates a new PubSubClient instance. It panics if any error is found.

func NewPubSubClient[T any](params *PubSubClientParams[T]) (*PubSubClient[T], error)

NewPubSubClient creates a new PubSubClient instance.

func (c PubSubClient[T]) Publish(ctx context.Context, in ...PublishInput[T]) []error

Publish publishes messages in a pubsub topic with schema of type T.

type PubSubClientParams[T any] struct {
	Topic Publisher
}

PubSubClientParams encapsulates the necessary params to build a PubSubClient.

type PublishInput[T any] struct {
	Data       T
	Attributes map[string]string
}

PublishInput is the input for publishing data into a topic with schema of type T.

type Publisher interface {
	Publish(ctx context.Context, msg *pubsub.Message) error
}

Publisher defines boundary interfaces of a pubsub topic.

type TopicWrapper struct {
	Topic *pubsub.Topic
}

TopicWrapper envelopes a pubsub topic type.

func (tw TopicWrapper) Publish(ctx context.Context, msg *pubsub.Message) error

Publish envelopes a pubsub topic publish method.