1
0
mirror of https://github.com/go-micro/go-micro.git synced 2024-12-18 08:26:38 +02:00
go-micro/events/options.go

174 lines
4.8 KiB
Go
Raw Normal View History

package events
import (
"context"
"time"
"go-micro.dev/v4/logger"
)
type Options struct {
Logger logger.Logger
}
type Option func(o *Options)
func NewOptions(opts ...Option) *Options {
options := Options{
Logger: logger.DefaultLogger,
}
for _, o := range opts {
o(&options)
}
return &options
}
type StoreOptions struct {
Backup Backup
Logger logger.Logger
2023-04-26 02:16:34 +02:00
TTL time.Duration
}
type StoreOption func(o *StoreOptions)
2022-09-30 16:27:07 +02:00
// WithLogger sets the underline logger.
func WithLogger(l logger.Logger) StoreOption {
return func(o *StoreOptions) {
o.Logger = l
}
}
2022-09-30 16:27:07 +02:00
// PublishOptions contains all the options which can be provided when publishing an event.
type PublishOptions struct {
// Metadata contains any keys which can be used to query the data, for example a customer id
Metadata map[string]string
// Timestamp to set for the event, if the timestamp is a zero value, the current time will be used
Timestamp time.Time
}
2022-09-30 16:27:07 +02:00
// PublishOption sets attributes on PublishOptions.
type PublishOption func(o *PublishOptions)
2022-09-30 16:27:07 +02:00
// WithMetadata sets the Metadata field on PublishOptions.
func WithMetadata(md map[string]string) PublishOption {
return func(o *PublishOptions) {
o.Metadata = md
}
}
2022-09-30 16:27:07 +02:00
// WithTimestamp sets the timestamp field on PublishOptions.
func WithTimestamp(t time.Time) PublishOption {
return func(o *PublishOptions) {
o.Timestamp = t
}
}
2022-09-30 16:27:07 +02:00
// ConsumeOptions contains all the options which can be provided when subscribing to a topic.
type ConsumeOptions struct {
// Offset is the time from which the messages should be consumed from. If not provided then
// the messages will be consumed starting from the moment the Subscription starts.
Offset time.Time
2023-04-26 02:16:34 +02:00
// Group is the name of the consumer group, if two consumers have the same group the events
// are distributed between them
Group string
AckWait time.Duration
// RetryLimit indicates number of times a message is retried
RetryLimit int
// AutoAck if true (default true), automatically acknowledges every message so it will not be redelivered.
// If false specifies that each message need ts to be manually acknowledged by the subscriber.
// If processing is successful the message should be ack'ed to remove the message from the stream.
// If processing is unsuccessful the message should be nack'ed (negative acknowledgement) which will mean it will
// remain on the stream to be processed again.
AutoAck bool
// CustomRetries indicates whether to use RetryLimit
CustomRetries bool
}
2022-09-30 16:27:07 +02:00
// ConsumeOption sets attributes on ConsumeOptions.
type ConsumeOption func(o *ConsumeOptions)
2022-09-30 16:27:07 +02:00
// WithGroup sets the consumer group to be part of when consuming events.
func WithGroup(q string) ConsumeOption {
return func(o *ConsumeOptions) {
o.Group = q
}
}
2022-09-30 16:27:07 +02:00
// WithOffset sets the offset time at which to start consuming events.
func WithOffset(t time.Time) ConsumeOption {
return func(o *ConsumeOptions) {
o.Offset = t
}
}
// WithAutoAck sets the AutoAck field on ConsumeOptions and an ackWait duration after which if no ack is received
2022-09-30 16:27:07 +02:00
// the message is requeued in case auto ack is turned off.
func WithAutoAck(ack bool, ackWait time.Duration) ConsumeOption {
return func(o *ConsumeOptions) {
o.AutoAck = ack
o.AckWait = ackWait
}
}
// WithRetryLimit sets the RetryLimit field on ConsumeOptions.
2022-09-30 16:27:07 +02:00
// Set to -1 for infinite retries (default).
func WithRetryLimit(retries int) ConsumeOption {
return func(o *ConsumeOptions) {
o.RetryLimit = retries
o.CustomRetries = true
}
}
func (s ConsumeOptions) GetRetryLimit() int {
if !s.CustomRetries {
return -1
}
return s.RetryLimit
}
2022-09-30 16:27:07 +02:00
// WriteOptions contains all the options which can be provided when writing an event to a store.
type WriteOptions struct {
// TTL is the duration the event should be recorded for, a zero value TTL indicates the event should
2022-09-30 16:27:07 +02:00
// be stored indefinitely
TTL time.Duration
}
2022-09-30 16:27:07 +02:00
// WriteOption sets attributes on WriteOptions.
type WriteOption func(o *WriteOptions)
2022-09-30 16:27:07 +02:00
// WithTTL sets the TTL attribute on WriteOptions.
func WithTTL(d time.Duration) WriteOption {
return func(o *WriteOptions) {
o.TTL = d
}
}
2022-09-30 16:27:07 +02:00
// ReadOptions contains all the options which can be provided when reading events from a store.
type ReadOptions struct {
// Limit the number of results to return
Limit uint
// Context should contain all implementation specific options, using context.WithValue.
Context context.Context
// Offset the results by this number, useful for paginated queries
Offset uint
}
2022-09-30 16:27:07 +02:00
// ReadOption sets attributes on ReadOptions.
type ReadOption func(o *ReadOptions)
2022-09-30 16:27:07 +02:00
// ReadLimit sets the limit attribute on ReadOptions.
func ReadLimit(l uint) ReadOption {
return func(o *ReadOptions) {
o.Limit = l
}
}
2022-09-30 16:27:07 +02:00
// ReadOffset sets the offset attribute on ReadOptions.
func ReadOffset(l uint) ReadOption {
return func(o *ReadOptions) {
o.Offset = l
}
}