micro/network/transport/options.go

184 lines
3.8 KiB
Go
Raw Normal View History

2016-01-17 03:28:57 +03:00
package transport
import (
2018-03-03 14:53:52 +03:00
"context"
2016-01-18 03:10:04 +03:00
"crypto/tls"
2016-01-17 03:28:57 +03:00
"time"
"github.com/unistack-org/micro/v3/codec"
"github.com/unistack-org/micro/v3/logger"
"github.com/unistack-org/micro/v3/meter"
"github.com/unistack-org/micro/v3/tracer"
2016-01-17 03:28:57 +03:00
)
// Options struct holds the transport options
2016-01-17 03:28:57 +03:00
type Options struct {
Name string
2019-07-07 14:23:03 +03:00
// Addrs is the list of intermediary addresses to connect to
Addrs []string
// Codec is the codec interface to use where headers are not supported
// by the transport and the entire payload must be encoded
Codec codec.Codec
2019-07-07 14:23:03 +03:00
// TLSConfig to secure the connection. The assumption is that this
// is mTLS keypair
2016-01-18 03:10:04 +03:00
TLSConfig *tls.Config
2016-08-01 18:31:27 +03:00
// Timeout sets the timeout for Send/Recv
Timeout time.Duration
// Logger sets the logger
Logger logger.Logger
// Meter sets the meter
Meter meter.Meter
// Tracer sets the tracer
Tracer tracer.Tracer
2016-01-17 03:28:57 +03:00
// Other options for implementations of the interface
// can be stored in a context
Context context.Context
}
// NewOptions returns new options
func NewOptions(opts ...Option) Options {
options := Options{
Logger: logger.DefaultLogger,
Meter: meter.DefaultMeter,
Tracer: tracer.DefaultTracer,
Context: context.Background(),
}
for _, o := range opts {
o(&options)
}
return options
}
// DialOptions struct
2016-01-17 03:28:57 +03:00
type DialOptions struct {
2019-07-07 14:23:03 +03:00
// Tells the transport this is a streaming connection with
// multiple calls to send/recv and that send may not even be called
Stream bool
// Timeout for dialing
2016-01-17 03:28:57 +03:00
Timeout time.Duration
2016-01-18 03:10:04 +03:00
// TODO: add tls options when dialling
// Currently set in global options
// Other options for implementations of the interface
// can be stored in a context
Context context.Context
}
// NewDialOptions returns new DialOptions
func NewDialOptions(opts ...DialOption) DialOptions {
options := DialOptions{
Timeout: DefaultDialTimeout,
Context: context.Background(),
}
for _, o := range opts {
o(&options)
}
return options
}
// ListenOptions struct
2016-01-18 03:10:04 +03:00
type ListenOptions struct {
// TODO: add tls options when listening
// Currently set in global options
2016-01-17 03:28:57 +03:00
// Other options for implementations of the interface
// can be stored in a context
Context context.Context
}
// NewListenOptions returns new ListenOptions
func NewListenOptions(opts ...ListenOption) ListenOptions {
options := ListenOptions{
Context: context.Background(),
}
for _, o := range opts {
o(&options)
}
return options
}
2016-03-16 01:25:32 +03:00
// Addrs to use for transport
func Addrs(addrs ...string) Option {
return func(o *Options) {
o.Addrs = addrs
}
}
// Logger sets the logger
func Logger(l logger.Logger) Option {
return func(o *Options) {
o.Logger = l
}
}
// Meter sets the meter
func Meter(m meter.Meter) Option {
return func(o *Options) {
o.Meter = m
}
}
// Context sets the context
func Context(ctx context.Context) Option {
return func(o *Options) {
o.Context = ctx
}
}
2016-12-06 21:56:57 +03:00
// Codec sets the codec used for encoding where the transport
// does not support message headers
func Codec(c codec.Codec) Option {
2016-12-06 21:56:57 +03:00
return func(o *Options) {
o.Codec = c
}
}
2016-08-01 18:31:27 +03:00
// Timeout sets the timeout for Send/Recv execution
func Timeout(t time.Duration) Option {
2016-07-28 20:38:17 +03:00
return func(o *Options) {
2016-08-01 18:31:27 +03:00
o.Timeout = t
2016-07-28 20:38:17 +03:00
}
}
2016-01-18 03:10:04 +03:00
// TLSConfig to be used for the transport.
func TLSConfig(t *tls.Config) Option {
return func(o *Options) {
o.TLSConfig = t
}
}
// WithStream indicates whether this is a streaming connection
2016-01-17 03:28:57 +03:00
func WithStream() DialOption {
return func(o *DialOptions) {
o.Stream = true
}
}
// WithTimeout used when dialling the remote side
2016-01-17 03:28:57 +03:00
func WithTimeout(d time.Duration) DialOption {
return func(o *DialOptions) {
o.Timeout = d
}
}
// Tracer to be used for tracing
func Tracer(t tracer.Tracer) Option {
return func(o *Options) {
o.Tracer = t
}
}
// Name sets the name
func Name(n string) Option {
return func(o *Options) {
o.Name = n
}
}