micro/client/options.go

415 lines
9.2 KiB
Go
Raw Normal View History

package client
import (
2018-03-03 14:53:52 +03:00
"context"
2016-01-04 00:14:33 +03:00
"time"
"github.com/micro/go-micro/v3/broker"
"github.com/micro/go-micro/v3/broker/http"
"github.com/micro/go-micro/v3/codec"
"github.com/micro/go-micro/v3/registry"
"github.com/micro/go-micro/v3/router"
regRouter "github.com/micro/go-micro/v3/router/registry"
"github.com/micro/go-micro/v3/selector"
"github.com/micro/go-micro/v3/selector/random"
"github.com/micro/go-micro/v3/transport"
2020-08-10 17:58:39 +03:00
thttp "github.com/micro/go-micro/v3/transport/http"
)
type Options struct {
// Used to select codec
ContentType string
// Proxy address to send requests via
Proxy string
// Plugged interfaces
Broker broker.Broker
Codecs map[string]codec.NewCodec
Router router.Router
Selector selector.Selector
Transport transport.Transport
// Lookup used for looking up routes
Lookup LookupFunc
2016-06-07 02:46:14 +03:00
// Connection Pool
PoolSize int
PoolTTL time.Duration
2020-05-22 18:52:24 +03:00
// Response cache
Cache *Cache
// Middleware for client
Wrappers []Wrapper
// Default Call Options
CallOptions CallOptions
// Other options for implementations of the interface
// can be stored in a context
Context context.Context
}
type CallOptions struct {
2019-06-26 22:51:13 +03:00
// Address of remote hosts
Address []string
2016-04-05 22:04:37 +03:00
// Backoff func
Backoff BackoffFunc
// Duration to cache the response for
CacheExpiry time.Duration
// Transport Dial Timeout
DialTimeout time.Duration
// Number of Call attempts
Retries int
// Check if retriable func
Retry RetryFunc
// Request/Response timeout
RequestTimeout time.Duration
// Router to use for this call
Router router.Router
// Selector to use for the call
Selector selector.Selector
2020-07-02 19:03:08 +03:00
// SelectOptions to use when selecting a route
SelectOptions []selector.SelectOption
// Stream timeout for the stream
StreamTimeout time.Duration
// Use the auth token as the authorization header
AuthToken bool
// Network to lookup the route within
Network string
2016-11-07 20:49:35 +03:00
// Middleware for low level call func
CallWrappers []CallWrapper
2016-11-07 20:49:35 +03:00
// Other options for implementations of the interface
// can be stored in a context
Context context.Context
}
type PublishOptions struct {
2019-02-23 13:50:53 +03:00
// Exchange is the routing exchange for the message
Exchange string
// Other options for implementations of the interface
// can be stored in a context
Context context.Context
2015-12-09 03:02:45 +03:00
}
2015-12-08 22:25:42 +03:00
2018-05-10 19:33:54 +03:00
type MessageOptions struct {
ContentType string
}
type RequestOptions struct {
2018-04-14 20:06:52 +03:00
ContentType string
Stream bool
2015-12-08 22:25:42 +03:00
// Other options for implementations of the interface
// can be stored in a context
Context context.Context
2015-12-17 23:37:35 +03:00
}
func NewOptions(options ...Option) Options {
2016-01-03 02:16:15 +03:00
opts := Options{
2020-05-22 18:52:24 +03:00
Cache: NewCache(),
Context: context.Background(),
ContentType: "application/protobuf",
Codecs: make(map[string]codec.NewCodec),
CallOptions: CallOptions{
2016-11-07 19:46:12 +03:00
Backoff: DefaultBackoff,
Retry: DefaultRetry,
Retries: DefaultRetries,
RequestTimeout: DefaultRequestTimeout,
DialTimeout: transport.DefaultDialTimeout,
},
Lookup: LookupRoute,
PoolSize: DefaultPoolSize,
PoolTTL: DefaultPoolTTL,
Broker: http.NewBroker(),
Router: regRouter.NewRouter(),
Selector: random.NewSelector(),
2020-08-10 17:58:39 +03:00
Transport: thttp.NewTransport(),
2016-01-03 02:16:15 +03:00
}
for _, o := range options {
o(&opts)
}
return opts
}
2015-11-26 15:51:53 +03:00
// Broker to be used for pub/sub
func Broker(b broker.Broker) Option {
return func(o *Options) {
o.Broker = b
}
}
2015-11-26 15:51:53 +03:00
// Codec to be used to encode/decode requests for a given content type
func Codec(contentType string, c codec.NewCodec) Option {
return func(o *Options) {
o.Codecs[contentType] = c
2015-11-25 22:50:05 +03:00
}
}
2015-11-26 15:51:53 +03:00
// Default content type of the client
2015-11-25 22:50:05 +03:00
func ContentType(ct string) Option {
return func(o *Options) {
o.ContentType = ct
2015-11-25 22:50:05 +03:00
}
}
// Proxy sets the proxy address
func Proxy(addr string) Option {
return func(o *Options) {
o.Proxy = addr
}
}
2016-06-07 02:46:14 +03:00
// PoolSize sets the connection pool size
func PoolSize(d int) Option {
return func(o *Options) {
o.PoolSize = d
}
}
2019-12-15 10:05:19 +03:00
// PoolTTL sets the connection pool ttl
2016-06-07 02:46:14 +03:00
func PoolTTL(d time.Duration) Option {
return func(o *Options) {
o.PoolTTL = d
}
}
// Transport to use for communication e.g http, rabbitmq, etc
func Transport(t transport.Transport) Option {
return func(o *Options) {
o.Transport = t
}
}
// Registry sets the routers registry
func Registry(r registry.Registry) Option {
return func(o *Options) {
o.Router.Init(router.Registry(r))
}
}
// Router is used to lookup routes for a service
func Router(r router.Router) Option {
return func(o *Options) {
o.Router = r
}
}
2015-11-26 23:36:42 +03:00
// Selector is used to select a route
2015-12-09 22:23:16 +03:00
func Selector(s selector.Selector) Option {
return func(o *Options) {
o.Selector = s
}
}
2015-11-26 23:36:42 +03:00
// Adds a Wrapper to a list of options passed into the client
func Wrap(w Wrapper) Option {
return func(o *Options) {
o.Wrappers = append(o.Wrappers, w)
2015-11-26 23:36:42 +03:00
}
}
2015-12-09 03:02:45 +03:00
2016-11-07 20:49:35 +03:00
// Adds a Wrapper to the list of CallFunc wrappers
2016-11-07 21:06:15 +03:00
func WrapCall(cw ...CallWrapper) Option {
2016-11-07 20:49:35 +03:00
return func(o *Options) {
o.CallOptions.CallWrappers = append(o.CallOptions.CallWrappers, cw...)
2016-11-07 20:49:35 +03:00
}
}
2016-04-05 22:04:37 +03:00
// Backoff is used to set the backoff function used
// when retrying Calls
func Backoff(fn BackoffFunc) Option {
return func(o *Options) {
o.CallOptions.Backoff = fn
}
}
// Lookup sets the lookup function to use for resolving service names
func Lookup(l LookupFunc) Option {
return func(o *Options) {
o.Lookup = l
}
}
2016-01-04 00:14:33 +03:00
// Number of retries when making the request.
// Should this be a Call Option?
2016-01-03 02:16:15 +03:00
func Retries(i int) Option {
return func(o *Options) {
o.CallOptions.Retries = i
2016-01-03 02:16:15 +03:00
}
}
2017-04-12 23:47:40 +03:00
// Retry sets the retry function to be used when re-trying.
func Retry(fn RetryFunc) Option {
return func(o *Options) {
o.CallOptions.Retry = fn
}
}
2016-01-04 00:14:33 +03:00
// The request timeout.
// Should this be a Call Option?
func RequestTimeout(d time.Duration) Option {
return func(o *Options) {
o.CallOptions.RequestTimeout = d
2016-01-04 00:14:33 +03:00
}
}
// StreamTimeout sets the stream timeout
func StreamTimeout(d time.Duration) Option {
return func(o *Options) {
o.CallOptions.StreamTimeout = d
}
}
2016-01-04 00:25:03 +03:00
// Transport dial timeout
func DialTimeout(d time.Duration) Option {
return func(o *Options) {
o.CallOptions.DialTimeout = d
2016-01-04 00:25:03 +03:00
}
}
2015-12-09 03:02:45 +03:00
// Call Options
2019-02-23 13:50:53 +03:00
// WithExchange sets the exchange to route a message through
func WithExchange(e string) PublishOption {
return func(o *PublishOptions) {
o.Exchange = e
}
}
// PublishContext sets the context in publish options
func PublishContext(ctx context.Context) PublishOption {
return func(o *PublishOptions) {
o.Context = ctx
}
}
2019-06-26 22:51:13 +03:00
// WithAddress sets the remote addresses to use rather than using service discovery
func WithAddress(a ...string) CallOption {
2018-04-14 18:16:58 +03:00
return func(o *CallOptions) {
o.Address = a
}
}
// WithCallWrapper is a CallOption which adds to the existing CallFunc wrappers
func WithCallWrapper(cw ...CallWrapper) CallOption {
2016-11-07 20:49:35 +03:00
return func(o *CallOptions) {
o.CallWrappers = append(o.CallWrappers, cw...)
2016-11-07 20:49:35 +03:00
}
}
2016-04-05 22:04:37 +03:00
// WithBackoff is a CallOption which overrides that which
// set in Options.CallOptions
func WithBackoff(fn BackoffFunc) CallOption {
return func(o *CallOptions) {
o.Backoff = fn
}
}
2016-11-07 11:40:11 +03:00
// WithRetry is a CallOption which overrides that which
// set in Options.CallOptions
2016-11-07 11:40:11 +03:00
func WithRetry(fn RetryFunc) CallOption {
return func(o *CallOptions) {
2016-11-07 11:40:11 +03:00
o.Retry = fn
}
}
// WithRetries is a CallOption which overrides that which
// set in Options.CallOptions
func WithRetries(i int) CallOption {
return func(o *CallOptions) {
o.Retries = i
}
}
// WithRequestTimeout is a CallOption which overrides that which
// set in Options.CallOptions
func WithRequestTimeout(d time.Duration) CallOption {
return func(o *CallOptions) {
o.RequestTimeout = d
}
}
// WithStreamTimeout sets the stream timeout
func WithStreamTimeout(d time.Duration) CallOption {
return func(o *CallOptions) {
o.StreamTimeout = d
}
}
// WithDialTimeout is a CallOption which overrides that which
// set in Options.CallOptions
func WithDialTimeout(d time.Duration) CallOption {
return func(o *CallOptions) {
o.DialTimeout = d
}
}
// WithAuthToken is a CallOption which overrides the
2020-03-31 14:44:34 +03:00
// authorization header with the services own auth token
func WithAuthToken() CallOption {
2020-03-31 14:44:34 +03:00
return func(o *CallOptions) {
o.AuthToken = true
2020-03-31 14:44:34 +03:00
}
}
2020-05-22 18:52:24 +03:00
// WithCache is a CallOption which sets the duration the response
// shoull be cached for
func WithCache(c time.Duration) CallOption {
return func(o *CallOptions) {
o.CacheExpiry = c
}
}
// WithNetwork is a CallOption which sets the network attribute
func WithNetwork(n string) CallOption {
return func(o *CallOptions) {
o.Network = n
}
}
// WithRouter sets the router to use for this call
func WithRouter(r router.Router) CallOption {
return func(o *CallOptions) {
o.Router = r
}
}
// WithSelector sets the selector to use for this call
func WithSelector(s selector.Selector) CallOption {
return func(o *CallOptions) {
o.Selector = s
}
}
2020-07-02 19:03:08 +03:00
// WithSelectOptions sets the options to pass to the selector for this call
func WithSelectOptions(sops ...selector.SelectOption) CallOption {
return func(o *CallOptions) {
o.SelectOptions = sops
}
}
func WithMessageContentType(ct string) MessageOption {
return func(o *MessageOptions) {
o.ContentType = ct
}
}
2015-12-17 23:37:35 +03:00
// Request Options
2018-04-14 20:06:52 +03:00
func WithContentType(ct string) RequestOption {
return func(o *RequestOptions) {
o.ContentType = ct
}
}
2015-12-17 23:37:35 +03:00
func StreamingRequest() RequestOption {
return func(o *RequestOptions) {
o.Stream = true
2015-12-17 23:37:35 +03:00
}
}