pubsub

Documentation

Overview

Package pubsub provides a foundation for implementing pub/sub clients for various message brokers such as google pub-sub, kafka and MQTT. It defines interfaces for publishing and subscribing to messages, managing topics, and handling messages.

Index

• type Client
• type Committer
• type Log
  • func (l *Log) PrettyPrint(writer io.Writer)
• type Logger
• type Message
  • func NewMessage(ctx context.Context) *Message
  • func (m *Message) Bind(i any) error
  • func (m *Message) Context() context.Context
  • func (*Message) HostName() string
  • func (m *Message) Param(p string) string
  • func (*Message) Params(string) []string
  • func (m *Message) PathParam(p string) string
• type Publisher
• type Subscriber

Types

type Client

type Client interface {
	Publisher
	Subscriber
	Health() datasource.Health

	CreateTopic(context context.Context, name string) error
	DeleteTopic(context context.Context, name string) error

	Close() error
}

type Committer

type Committer interface {
	Commit()
}

type Log

type Log struct {
	Mode          string `json:"mode"`
	CorrelationID string `json:"correlationID"`
	MessageValue  string `json:"messageValue"`
	Topic         string `json:"topic"`
	Host          string `json:"host"`
	PubSubBackend string `json:"pubSubBackend"`
	Time          int64  `json:"time"`
}

func (*Log) PrettyPrint

func (l *Log) PrettyPrint(writer io.Writer)

type Logger

type Logger interface {
	Debugf(format string, args ...interface{})
	Debug(args ...interface{})
	Logf(format string, args ...interface{})
	Log(args ...interface{})
	Errorf(format string, args ...interface{})
	Error(args ...interface{})
}

type Message

type Message struct {
	Topic    string
	Value    []byte
	MetaData interface{}

	Committer
	// contains filtered or unexported fields
}

func NewMessage

func NewMessage(ctx context.Context) *Message

func (*Message) Bind

func (m *Message) Bind(i any) error

Bind binds the message value to the input variable. The input should be a pointer to a variable.

func (*Message) Context

func (m *Message) Context() context.Context

func (*Message) HostName

func (*Message) HostName() string

func (*Message) Param

func (m *Message) Param(p string) string

func (*Message) Params

func (*Message) Params(string) []string

func (*Message) PathParam

func (m *Message) PathParam(p string) string

type Publisher

type Publisher interface {
	Publish(ctx context.Context, topic string, message []byte) error
}

type Subscriber

type Subscriber interface {
	Subscribe(ctx context.Context, topic string) (*Message, error)
}