pubsub

type Func func(o *Options) error

type IPubSub interface {
	// Publish sends a message to a topic.
	Publish(ctx context.Context, messages []*message.Message, opts ...Func) ([]*message.Message, concurrentloop.Errors)

	// MustPublish sends a message to a topic. In case of error it will panic.
	MustPublish(ctx context.Context, msgs ...*message.Message) []*message.Message

	// MustPublishAsync sends a message to a topic asynchronously. In case of
	// error it will panic.
	MustPublishAsync(ctx context.Context, messages ...*message.Message)

	// Subscribe to a topic.
	Subscribe(ctx context.Context, subscriptions []*subscription.Subscription, opts ...Func) ([]*subscription.Subscription, concurrentloop.Errors)

	// MustSubscribe to a topic. In case of error it will panic.
	MustSubscribe(ctx context.Context, subscriptions ...*subscription.Subscription) []*subscription.Subscription

	// MustSubscribeAsync to a topic asynchronously. In case of error it will panic.
	MustSubscribeAsync(ctx context.Context, subscriptions ...*subscription.Subscription)

	// Unsubscribe from a topic.
	Unsubscribe(ctx context.Context, subscriptions ...*subscription.Subscription) error

	// Close the connection to the Pub Sub broker.
	Close() error

	// GetClient returns the storage client. Use that to interact with the
	// underlying storage client.
	GetClient() any

	// GetLogger returns the logger.
	GetLogger() sypl.ISypl

	// GetName returns the pubsub name.
	GetName() string

	// GetType returns its type.
	GetType() string

	// GetCounterPingFailed returns the metric.
	GetCounterPingFailed() *expvar.Int

	// GetPublishedCounter returns the metric.
	GetPublishedCounter() *expvar.Int

	// GetPublishedFailedCounter returns the metric.
	GetPublishedFailedCounter() *expvar.Int

	// GetSubscribedCounter returns the metric.
	GetSubscribedCounter() *expvar.Int

	// GetSubscribedFailedCounter returns the metric.
	GetSubscribedFailedCounter() *expvar.Int
}

type Map map[string]IPubSub

type Mock struct {
	// Publish sends a message to a topic.
	MockPublish func(ctx context.Context, messages []*message.Message, opts ...Func) ([]*message.Message, concurrentloop.Errors)

	// MustPublish sends a message to a topic. In case of error it will panic.
	MockMustPublish func(ctx context.Context, msgs ...*message.Message) []*message.Message

	// MustPublishAsync sends a message to a topic asynchronously. In case of error it will panic.
	MockMustPublishAsync func(ctx context.Context, messages ...*message.Message)

	// Subscribe to a topic.
	MockSubscribe func(ctx context.Context, subscriptions []*subscription.Subscription, opts ...Func) ([]*subscription.Subscription, concurrentloop.Errors)

	// MustSubscribe to a topic. In case of error it will panic.
	MockMustSubscribe func(ctx context.Context, subscriptions ...*subscription.Subscription) []*subscription.Subscription

	// MustSubscribeAsync to a topic asynchronously. In case of error it will panic.
	MockMustSubscribeAsyn func(ctx context.Context, subscriptions ...*subscription.Subscription)

	// Unsubscribe from a topic.
	MockUnsubscribe func(ctx context.Context, subscriptions ...*subscription.Subscription) error

	// Close the connection to the Pub Sub broker.
	MockClose func() error

	// GetClient returns the storage client. Use that to interact with the underlying storage client.
	MockGetClient func() any

	// GetLogger returns the logger.
	MockGetLogger func() sypl.ISypl

	// GetName returns the pubsub name.
	MockGetName func() string

	// GetType returns its type.
	MockGetType func() string

	// GetCounterPingFailed returns the metric.
	MockGetCounterPingFailed func() *expvar.Int

	// GetPublishedCounter returns the metric.
	MockGetPublishedCounter func() *expvar.Int

	// GetPublishedFailedCounter returns the metric.
	MockGetPublishedFailedCounter func() *expvar.Int

	// GetSubscribedCounter returns the metric.
	MockGetSubscribedCounter func() *expvar.Int

	// GetSubscribedFailedCounter returns the metric.
	MockGetSubscribedFailedCounter func() *expvar.Int
}

type Options struct {
	// If the operation is synchronous.
	Sync bool `json:"sync" default:"false" env:"PUBSUB_SYNC"`
}

type PubSub struct {
	// Logger.
	Logger sypl.ISypl `json:"-" validate:"required"`

	// Name of the pubsub type.
	Name string `json:"name" validate:"required,lowercase,gte=1"`
	// contains filtered or unexported fields
}