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

163 lines
3.1 KiB
Go
Raw Normal View History

2015-12-23 21:07:26 +02:00
package broker
import (
2018-03-03 13:53:52 +02:00
"context"
2016-01-17 01:39:47 +02:00
"crypto/tls"
2024-06-04 22:40:43 +02:00
"go-micro.dev/v5/codec"
"go-micro.dev/v5/logger"
"go-micro.dev/v5/registry"
)
type Options struct {
2023-04-26 02:16:34 +02:00
Codec codec.Marshaler
// Logger is the underlying logger
Logger logger.Logger
// Registry used for clustering
Registry registry.Registry
// Other options for implementations of the interface
// can be stored in a context
Context context.Context
2023-04-26 02:16:34 +02:00
// Handler executed when error happens in broker mesage
// processing
ErrorHandler Handler
TLSConfig *tls.Config
Addrs []string
Secure bool
}
2015-12-23 21:07:26 +02:00
type PublishOptions struct {
// Other options for implementations of the interface
// can be stored in a context
Context context.Context
}
2015-12-23 21:07:26 +02:00
type SubscribeOptions struct {
2023-04-26 02:16:34 +02:00
// Other options for implementations of the interface
// can be stored in a context
Context context.Context
2015-12-23 22:05:47 +02:00
// Subscribers with the same queue name
// will create a shared subscription where each
// receives a subset of messages.
Queue string
2023-04-26 02:16:34 +02:00
// AutoAck defaults to true. When a handler returns
// with a nil error the message is acked.
AutoAck bool
2015-12-23 21:07:26 +02:00
}
type Option func(*Options)
type PublishOption func(*PublishOptions)
2022-09-30 16:27:07 +02:00
// PublishContext set context.
func PublishContext(ctx context.Context) PublishOption {
return func(o *PublishOptions) {
o.Context = ctx
}
}
2015-12-23 21:07:26 +02:00
type SubscribeOption func(*SubscribeOptions)
func NewOptions(opts ...Option) *Options {
options := Options{
Context: context.Background(),
Logger: logger.DefaultLogger,
}
for _, o := range opts {
o(&options)
}
return &options
}
2018-11-30 19:32:48 +02:00
func NewSubscribeOptions(opts ...SubscribeOption) SubscribeOptions {
2016-01-17 00:13:02 +02:00
opt := SubscribeOptions{
AutoAck: true,
}
for _, o := range opts {
o(&opt)
}
return opt
}
2022-09-30 16:27:07 +02:00
// Addrs sets the host addresses to be used by the broker.
2016-03-16 00:12:28 +02:00
func Addrs(addrs ...string) Option {
return func(o *Options) {
o.Addrs = addrs
}
}
2016-12-06 20:59:41 +02:00
// Codec sets the codec used for encoding/decoding used where
2022-09-30 16:27:07 +02:00
// a broker does not support headers.
2019-01-10 11:42:02 +02:00
func Codec(c codec.Marshaler) Option {
2016-12-06 20:59:41 +02:00
return func(o *Options) {
o.Codec = c
}
}
2015-12-23 21:07:26 +02:00
// DisableAutoAck will disable auto acking of messages
// after they have been handled.
func DisableAutoAck() SubscribeOption {
return func(o *SubscribeOptions) {
o.AutoAck = false
}
}
// ErrorHandler will catch all broker errors that cant be handled
2022-09-30 16:27:07 +02:00
// in normal way, for example Codec errors.
func ErrorHandler(h Handler) Option {
return func(o *Options) {
o.ErrorHandler = h
}
}
2022-09-30 16:27:07 +02:00
// Queue sets the name of the queue to share messages on.
2016-05-10 11:55:18 +02:00
func Queue(name string) SubscribeOption {
2015-12-23 22:05:47 +02:00
return func(o *SubscribeOptions) {
o.Queue = name
}
}
2016-01-20 17:22:44 +02:00
func Registry(r registry.Registry) Option {
return func(o *Options) {
o.Registry = r
2016-01-20 17:22:44 +02:00
}
}
2022-09-30 16:27:07 +02:00
// Secure communication with the broker.
2016-01-17 00:13:02 +02:00
func Secure(b bool) Option {
return func(o *Options) {
o.Secure = b
2015-12-23 21:07:26 +02:00
}
}
2016-01-17 01:39:47 +02:00
2022-09-30 16:27:07 +02:00
// Specify TLS Config.
2016-01-17 01:39:47 +02:00
func TLSConfig(t *tls.Config) Option {
return func(o *Options) {
o.TLSConfig = t
}
}
2022-09-30 16:27:07 +02:00
// Logger sets the underline logger.
func Logger(l logger.Logger) Option {
return func(o *Options) {
o.Logger = l
}
}
2022-09-30 16:27:07 +02:00
// SubscribeContext set context.
func SubscribeContext(ctx context.Context) SubscribeOption {
return func(o *SubscribeOptions) {
o.Context = ctx
}
}