2015-06-12 19:52:27 +01:00
|
|
|
package client
|
|
|
|
|
|
|
|
import (
|
2018-03-03 11:53:52 +00:00
|
|
|
"context"
|
2016-01-03 21:14:33 +00:00
|
|
|
"time"
|
|
|
|
|
2015-11-20 16:17:33 +00:00
|
|
|
"github.com/micro/go-micro/broker"
|
2019-06-21 17:20:41 +01:00
|
|
|
"github.com/micro/go-micro/client/selector"
|
2015-11-27 00:17:36 +00:00
|
|
|
"github.com/micro/go-micro/codec"
|
2015-11-20 16:17:33 +00:00
|
|
|
"github.com/micro/go-micro/registry"
|
|
|
|
"github.com/micro/go-micro/transport"
|
2015-06-12 19:52:27 +01:00
|
|
|
)
|
|
|
|
|
2015-12-31 18:11:46 +00:00
|
|
|
type Options struct {
|
2016-04-05 18:07:07 +01:00
|
|
|
// Used to select codec
|
|
|
|
ContentType string
|
|
|
|
|
|
|
|
// Plugged interfaces
|
|
|
|
Broker broker.Broker
|
|
|
|
Codecs map[string]codec.NewCodec
|
|
|
|
Registry registry.Registry
|
|
|
|
Selector selector.Selector
|
|
|
|
Transport transport.Transport
|
|
|
|
|
2019-01-13 12:15:13 +00:00
|
|
|
// Router sets the router
|
|
|
|
Router Router
|
|
|
|
|
2016-06-07 00:46:14 +01:00
|
|
|
// Connection Pool
|
|
|
|
PoolSize int
|
|
|
|
PoolTTL time.Duration
|
|
|
|
|
2016-04-05 18:07:07 +01:00
|
|
|
// Middleware for client
|
|
|
|
Wrappers []Wrapper
|
|
|
|
|
|
|
|
// Default Call Options
|
|
|
|
CallOptions CallOptions
|
2015-12-31 18:11:46 +00:00
|
|
|
|
2016-01-06 16:25:12 +00:00
|
|
|
// Other options for implementations of the interface
|
|
|
|
// can be stored in a context
|
|
|
|
Context context.Context
|
2015-06-12 19:52:27 +01:00
|
|
|
}
|
|
|
|
|
2015-12-31 18:11:46 +00:00
|
|
|
type CallOptions struct {
|
|
|
|
SelectOptions []selector.SelectOption
|
|
|
|
|
2018-04-14 16:16:58 +01:00
|
|
|
// Address of remote host
|
|
|
|
Address string
|
2016-04-05 20:04:37 +01:00
|
|
|
// Backoff func
|
|
|
|
Backoff BackoffFunc
|
2016-11-03 10:45:31 +01:00
|
|
|
// Check if retriable func
|
2016-11-07 09:40:11 +01:00
|
|
|
Retry RetryFunc
|
2016-04-05 18:07:07 +01:00
|
|
|
// Transport Dial Timeout
|
|
|
|
DialTimeout time.Duration
|
|
|
|
// Number of Call attempts
|
|
|
|
Retries int
|
|
|
|
// Request/Response timeout
|
|
|
|
RequestTimeout time.Duration
|
|
|
|
|
2016-11-07 17:49:35 +00:00
|
|
|
// Middleware for low level call func
|
2016-11-07 17:58:34 +00:00
|
|
|
CallWrappers []CallWrapper
|
2016-11-07 17:49:35 +00:00
|
|
|
|
2016-01-06 16:25:12 +00:00
|
|
|
// Other options for implementations of the interface
|
|
|
|
// can be stored in a context
|
|
|
|
Context context.Context
|
2015-12-31 18:11:46 +00:00
|
|
|
}
|
|
|
|
|
|
|
|
type PublishOptions struct {
|
2019-02-23 10:50:53 +00:00
|
|
|
// Exchange is the routing exchange for the message
|
|
|
|
Exchange string
|
2016-01-06 16:25:12 +00:00
|
|
|
// Other options for implementations of the interface
|
|
|
|
// can be stored in a context
|
|
|
|
Context context.Context
|
2015-12-09 00:02:45 +00:00
|
|
|
}
|
2015-12-08 19:25:42 +00:00
|
|
|
|
2018-05-10 17:33:54 +01:00
|
|
|
type MessageOptions struct {
|
|
|
|
ContentType string
|
|
|
|
}
|
|
|
|
|
2015-12-31 18:11:46 +00:00
|
|
|
type RequestOptions struct {
|
2018-04-14 18:06:52 +01:00
|
|
|
ContentType string
|
|
|
|
Stream bool
|
2015-12-08 19:25:42 +00:00
|
|
|
|
2016-01-06 16:25:12 +00:00
|
|
|
// Other options for implementations of the interface
|
|
|
|
// can be stored in a context
|
|
|
|
Context context.Context
|
2015-12-17 20:37:35 +00:00
|
|
|
}
|
|
|
|
|
2016-01-02 23:16:15 +00:00
|
|
|
func newOptions(options ...Option) Options {
|
|
|
|
opts := Options{
|
2016-04-05 18:07:07 +01:00
|
|
|
Codecs: make(map[string]codec.NewCodec),
|
|
|
|
CallOptions: CallOptions{
|
2016-11-07 17:46:12 +01:00
|
|
|
Backoff: DefaultBackoff,
|
|
|
|
Retry: DefaultRetry,
|
|
|
|
Retries: DefaultRetries,
|
|
|
|
RequestTimeout: DefaultRequestTimeout,
|
|
|
|
DialTimeout: transport.DefaultDialTimeout,
|
2016-04-05 18:07:07 +01:00
|
|
|
},
|
2016-06-07 00:46:14 +01:00
|
|
|
PoolSize: DefaultPoolSize,
|
|
|
|
PoolTTL: DefaultPoolTTL,
|
2016-01-02 23:16:15 +00:00
|
|
|
}
|
|
|
|
|
|
|
|
for _, o := range options {
|
|
|
|
o(&opts)
|
|
|
|
}
|
|
|
|
|
|
|
|
if len(opts.ContentType) == 0 {
|
2019-01-07 13:48:38 +00:00
|
|
|
opts.ContentType = DefaultContentType
|
2016-01-02 23:16:15 +00:00
|
|
|
}
|
|
|
|
|
|
|
|
if opts.Broker == nil {
|
|
|
|
opts.Broker = broker.DefaultBroker
|
|
|
|
}
|
|
|
|
|
|
|
|
if opts.Registry == nil {
|
|
|
|
opts.Registry = registry.DefaultRegistry
|
|
|
|
}
|
|
|
|
|
|
|
|
if opts.Selector == nil {
|
|
|
|
opts.Selector = selector.NewSelector(
|
|
|
|
selector.Registry(opts.Registry),
|
|
|
|
)
|
|
|
|
}
|
|
|
|
|
|
|
|
if opts.Transport == nil {
|
|
|
|
opts.Transport = transport.DefaultTransport
|
|
|
|
}
|
|
|
|
|
|
|
|
return opts
|
|
|
|
}
|
|
|
|
|
2015-11-26 12:51:53 +00:00
|
|
|
// Broker to be used for pub/sub
|
2015-06-12 19:52:27 +01:00
|
|
|
func Broker(b broker.Broker) Option {
|
2015-12-31 18:11:46 +00:00
|
|
|
return func(o *Options) {
|
|
|
|
o.Broker = b
|
2015-06-12 19:52:27 +01:00
|
|
|
}
|
|
|
|
}
|
|
|
|
|
2015-11-26 12:51:53 +00:00
|
|
|
// Codec to be used to encode/decode requests for a given content type
|
2015-11-28 11:22:29 +00:00
|
|
|
func Codec(contentType string, c codec.NewCodec) Option {
|
2015-12-31 18:11:46 +00:00
|
|
|
return func(o *Options) {
|
|
|
|
o.Codecs[contentType] = c
|
2015-11-25 19:50:05 +00:00
|
|
|
}
|
|
|
|
}
|
|
|
|
|
2015-11-26 12:51:53 +00:00
|
|
|
// Default content type of the client
|
2015-11-25 19:50:05 +00:00
|
|
|
func ContentType(ct string) Option {
|
2015-12-31 18:11:46 +00:00
|
|
|
return func(o *Options) {
|
|
|
|
o.ContentType = ct
|
2015-11-25 19:50:05 +00:00
|
|
|
}
|
|
|
|
}
|
|
|
|
|
2016-06-07 00:46:14 +01:00
|
|
|
// PoolSize sets the connection pool size
|
|
|
|
func PoolSize(d int) Option {
|
|
|
|
return func(o *Options) {
|
|
|
|
o.PoolSize = d
|
|
|
|
}
|
|
|
|
}
|
|
|
|
|
|
|
|
// PoolSize sets the connection pool size
|
|
|
|
func PoolTTL(d time.Duration) Option {
|
|
|
|
return func(o *Options) {
|
|
|
|
o.PoolTTL = d
|
|
|
|
}
|
|
|
|
}
|
|
|
|
|
2015-11-26 12:51:53 +00:00
|
|
|
// Registry to find nodes for a given service
|
2015-06-12 19:52:27 +01:00
|
|
|
func Registry(r registry.Registry) Option {
|
2015-12-31 18:11:46 +00:00
|
|
|
return func(o *Options) {
|
|
|
|
o.Registry = r
|
2015-06-12 19:52:27 +01:00
|
|
|
}
|
|
|
|
}
|
|
|
|
|
2015-11-26 12:51:53 +00:00
|
|
|
// Transport to use for communication e.g http, rabbitmq, etc
|
2015-06-12 19:52:27 +01:00
|
|
|
func Transport(t transport.Transport) Option {
|
2015-12-31 18:11:46 +00:00
|
|
|
return func(o *Options) {
|
|
|
|
o.Transport = t
|
2015-06-12 19:52:27 +01:00
|
|
|
}
|
|
|
|
}
|
2015-11-26 20:36:42 +00:00
|
|
|
|
2015-12-07 23:56:17 +00:00
|
|
|
// Select is used to select a node to route a request to
|
2015-12-09 19:23:16 +00:00
|
|
|
func Selector(s selector.Selector) Option {
|
2015-12-31 18:11:46 +00:00
|
|
|
return func(o *Options) {
|
|
|
|
o.Selector = s
|
2015-12-07 21:09:10 +00:00
|
|
|
}
|
|
|
|
}
|
|
|
|
|
2015-11-26 20:36:42 +00:00
|
|
|
// Adds a Wrapper to a list of options passed into the client
|
|
|
|
func Wrap(w Wrapper) Option {
|
2015-12-31 18:11:46 +00:00
|
|
|
return func(o *Options) {
|
|
|
|
o.Wrappers = append(o.Wrappers, w)
|
2015-11-26 20:36:42 +00:00
|
|
|
}
|
|
|
|
}
|
2015-12-09 00:02:45 +00:00
|
|
|
|
2016-11-07 17:49:35 +00:00
|
|
|
// Adds a Wrapper to the list of CallFunc wrappers
|
2016-11-07 18:06:15 +00:00
|
|
|
func WrapCall(cw ...CallWrapper) Option {
|
2016-11-07 17:49:35 +00:00
|
|
|
return func(o *Options) {
|
2016-11-07 17:58:34 +00:00
|
|
|
o.CallOptions.CallWrappers = append(o.CallOptions.CallWrappers, cw...)
|
2016-11-07 17:49:35 +00:00
|
|
|
}
|
|
|
|
}
|
|
|
|
|
2016-04-05 20:04:37 +01: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
|
|
|
|
}
|
|
|
|
}
|
|
|
|
|
2016-01-03 21:14:33 +00:00
|
|
|
// Number of retries when making the request.
|
|
|
|
// Should this be a Call Option?
|
2016-01-02 23:16:15 +00:00
|
|
|
func Retries(i int) Option {
|
|
|
|
return func(o *Options) {
|
2016-04-05 18:07:07 +01:00
|
|
|
o.CallOptions.Retries = i
|
2016-01-02 23:16:15 +00:00
|
|
|
}
|
|
|
|
}
|
|
|
|
|
2017-04-12 16:47:40 -04: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-03 21:14:33 +00:00
|
|
|
// The request timeout.
|
|
|
|
// Should this be a Call Option?
|
|
|
|
func RequestTimeout(d time.Duration) Option {
|
|
|
|
return func(o *Options) {
|
2016-04-05 18:07:07 +01:00
|
|
|
o.CallOptions.RequestTimeout = d
|
2016-01-03 21:14:33 +00:00
|
|
|
}
|
|
|
|
}
|
|
|
|
|
2016-01-03 21:25:03 +00:00
|
|
|
// Transport dial timeout
|
|
|
|
func DialTimeout(d time.Duration) Option {
|
|
|
|
return func(o *Options) {
|
2016-04-05 18:07:07 +01:00
|
|
|
o.CallOptions.DialTimeout = d
|
2016-01-03 21:25:03 +00:00
|
|
|
}
|
|
|
|
}
|
|
|
|
|
2015-12-09 00:02:45 +00:00
|
|
|
// Call Options
|
|
|
|
|
2019-02-23 10:50:53 +00:00
|
|
|
// WithExchange sets the exchange to route a message through
|
|
|
|
func WithExchange(e string) PublishOption {
|
|
|
|
return func(o *PublishOptions) {
|
|
|
|
o.Exchange = e
|
|
|
|
}
|
|
|
|
}
|
|
|
|
|
2018-04-14 16:16:58 +01:00
|
|
|
// WithAddress sets the remote address to use rather than using service discovery
|
|
|
|
func WithAddress(a string) CallOption {
|
|
|
|
return func(o *CallOptions) {
|
|
|
|
o.Address = a
|
|
|
|
}
|
|
|
|
}
|
|
|
|
|
2016-04-23 21:37:26 +01:00
|
|
|
func WithSelectOption(so ...selector.SelectOption) CallOption {
|
2015-12-31 18:11:46 +00:00
|
|
|
return func(o *CallOptions) {
|
2016-04-23 21:37:26 +01:00
|
|
|
o.SelectOptions = append(o.SelectOptions, so...)
|
2015-12-09 00:02:45 +00:00
|
|
|
}
|
|
|
|
}
|
2015-12-17 20:37:35 +00:00
|
|
|
|
2016-11-07 17:58:34 +00:00
|
|
|
// WithCallWrapper is a CallOption which adds to the existing CallFunc wrappers
|
|
|
|
func WithCallWrapper(cw ...CallWrapper) CallOption {
|
2016-11-07 17:49:35 +00:00
|
|
|
return func(o *CallOptions) {
|
2016-11-07 17:58:34 +00:00
|
|
|
o.CallWrappers = append(o.CallWrappers, cw...)
|
2016-11-07 17:49:35 +00:00
|
|
|
}
|
|
|
|
}
|
|
|
|
|
2016-04-05 20:04:37 +01: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 09:40:11 +01:00
|
|
|
// WithRetry is a CallOption which overrides that which
|
2016-11-03 10:45:31 +01:00
|
|
|
// set in Options.CallOptions
|
2016-11-07 09:40:11 +01:00
|
|
|
func WithRetry(fn RetryFunc) CallOption {
|
2016-11-03 10:45:31 +01:00
|
|
|
return func(o *CallOptions) {
|
2016-11-07 09:40:11 +01:00
|
|
|
o.Retry = fn
|
2016-11-03 10:45:31 +01:00
|
|
|
}
|
|
|
|
}
|
|
|
|
|
2016-04-05 18:07:07 +01:00
|
|
|
// 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
|
|
|
|
}
|
|
|
|
}
|
|
|
|
|
|
|
|
// 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
|
|
|
|
}
|
|
|
|
}
|
|
|
|
|
2015-12-17 20:37:35 +00:00
|
|
|
// Request Options
|
|
|
|
|
2018-04-14 18:06:52 +01:00
|
|
|
func WithContentType(ct string) RequestOption {
|
|
|
|
return func(o *RequestOptions) {
|
|
|
|
o.ContentType = ct
|
|
|
|
}
|
|
|
|
}
|
|
|
|
|
2015-12-17 20:37:35 +00:00
|
|
|
func StreamingRequest() RequestOption {
|
2015-12-31 18:11:46 +00:00
|
|
|
return func(o *RequestOptions) {
|
|
|
|
o.Stream = true
|
2015-12-17 20:37:35 +00:00
|
|
|
}
|
|
|
|
}
|
2019-01-13 12:15:13 +00:00
|
|
|
|
|
|
|
// WithRouter sets the client router
|
|
|
|
func WithRouter(r Router) Option {
|
|
|
|
return func(o *Options) {
|
|
|
|
o.Router = r
|
|
|
|
}
|
|
|
|
}
|