pubsub

Documentation

Index

• func FormatTopic(app, ns, topic string) string
• type Config
• type Consumer
• type Msg
• type PublishConfig
  • func (c *PublishConfig) Apply(pc *PublishConfig)
• type PublishOption
  • func WithPublishApp(value string) PublishOption
  • func WithPublishNamespace(value string) PublishOption
• type PublishOptionFunc
  • func (f PublishOptionFunc) Apply(config *PublishConfig)
• type Publisher
• type SubscribeConfig
• type SubscribeOption
  • func WithChannelHealthCheckInterval(value time.Duration) SubscribeOption
  • func WithChannelNamespace(value string) SubscribeOption
  • func WithChannelSendTimeout(value time.Duration) SubscribeOption
  • func WithChannelSize(value int) SubscribeOption
  • func WithTopics(topics ...string) SubscribeOption
• type SubscribeOptionFunc
  • func (f SubscribeOptionFunc) Apply(config *SubscribeConfig)
• type Subscriber

Functions

func FormatTopic

func FormatTopic(app, ns, topic string) string

Types

type Config

type Config struct {
	App       string
	Namespace string

	SendTimeout time.Duration
	ChannelSize int
}

type Consumer

type Consumer interface {
	Subscribe(ctx context.Context, topics ...string) error
	Unsubscribe(ctx context.Context, topics ...string) error
	Close() error
}

type Msg

type Msg struct {
	Topic   string
	Payload []byte
}

type PublishConfig

type PublishConfig struct {
	App       string
	Namespace string
}

func (*PublishConfig) Apply

func (c *PublishConfig) Apply(pc *PublishConfig)

type PublishOption

type PublishOption interface {
	Apply(*PublishConfig)
}

func WithPublishApp

func WithPublishApp(value string) PublishOption

WithPublishApp modifies publish config app identifier.

func WithPublishNamespace

func WithPublishNamespace(value string) PublishOption

WithPublishNamespace modifies publish config namespace.

type PublishOptionFunc

type PublishOptionFunc func(*PublishConfig)

PublishOptionFunc is a function that configures a publish config.

func (PublishOptionFunc) Apply

func (f PublishOptionFunc) Apply(config *PublishConfig)

Apply calls f(publishConfig).

type Publisher

type Publisher interface {
	// Publish topic to message broker with payload.
	Publish(ctx context.Context, topic string, payload []byte,
		options ...PublishOption) error
}

type SubscribeConfig

type SubscribeConfig struct {
	Topics         []string
	App            string
	Namespace      string
	HealthInterval time.Duration
	SendTimeout    time.Duration
	ChannelSize    int
}

type SubscribeOption

type SubscribeOption interface {
	Apply(*SubscribeConfig)
}

SubscribeOption configures a subscription config.

func WithChannelHealthCheckInterval

func WithChannelHealthCheckInterval(value time.Duration) SubscribeOption

WithChannelHealthCheckInterval specifies the channel health check interval. PubSub will ping Server if it does not receive any messages within the interval. To disable health check, use zero interval.

func WithChannelNamespace

func WithChannelNamespace(value string) SubscribeOption

WithNamespace returns an channel option that configures namespace.

func WithChannelSendTimeout

func WithChannelSendTimeout(value time.Duration) SubscribeOption

WithChannelSendTimeout specifies the channel send timeout after which the message is dropped.

func WithChannelSize

func WithChannelSize(value int) SubscribeOption

WithChannelSize specifies the Go chan size that is used to buffer incoming messages for subscriber.

func WithTopics

func WithTopics(topics ...string) SubscribeOption

WithTopics specifies the topics to subsribe.

type SubscribeOptionFunc

type SubscribeOptionFunc func(*SubscribeConfig)

SubscribeOptionFunc is a function that configures a subscription config.

func (SubscribeOptionFunc) Apply

func (f SubscribeOptionFunc) Apply(config *SubscribeConfig)

Apply calls f(subscribeConfig).

type Subscriber

type Subscriber interface {
	Subscribe(ctx context.Context, topic string,
		handler func(payload *Msg) error, options ...SubscribeOption) Consumer
	SubscribeChan(ctx context.Context, topic string,
		options ...SubscribeOption) (Consumer, <-chan *Msg)
}