2016-12-14 15:41:48 +00:00
|
|
|
// Package client is an interface for an RPC client
|
2015-01-13 23:31:27 +00:00
|
|
|
package client
|
|
|
|
|
2015-05-21 19:24:57 +01:00
|
|
|
import (
|
2018-03-03 11:53:52 +00:00
|
|
|
"context"
|
2016-01-03 21:14:33 +00:00
|
|
|
"time"
|
2019-01-10 11:39:39 +00:00
|
|
|
|
|
|
|
"github.com/micro/go-micro/codec"
|
2015-05-21 19:24:57 +01:00
|
|
|
)
|
|
|
|
|
2016-01-30 21:15:08 +00:00
|
|
|
// Client is the interface used to make requests to services.
|
|
|
|
// It supports Request/Response via Transport and Publishing via the Broker.
|
|
|
|
// It also supports bidiectional streaming of requests.
|
2015-01-13 23:31:27 +00:00
|
|
|
type Client interface {
|
2016-01-02 19:12:17 +00:00
|
|
|
Init(...Option) error
|
|
|
|
Options() Options
|
2018-05-10 17:33:54 +01:00
|
|
|
NewMessage(topic string, msg interface{}, opts ...MessageOption) Message
|
2019-01-10 21:25:31 +00:00
|
|
|
NewRequest(service, endpoint string, req interface{}, reqOpts ...RequestOption) Request
|
2015-12-08 19:25:42 +00:00
|
|
|
Call(ctx context.Context, req Request, rsp interface{}, opts ...CallOption) error
|
2018-04-14 18:15:09 +01:00
|
|
|
Stream(ctx context.Context, req Request, opts ...CallOption) (Stream, error)
|
2018-04-14 18:06:52 +01:00
|
|
|
Publish(ctx context.Context, msg Message, opts ...PublishOption) error
|
2015-12-19 21:56:14 +00:00
|
|
|
String() string
|
2015-06-12 19:52:27 +01:00
|
|
|
}
|
|
|
|
|
2019-01-10 11:39:39 +00:00
|
|
|
// Router manages request routing
|
|
|
|
type Router interface {
|
|
|
|
SendRequest(context.Context, Request) (Response, error)
|
|
|
|
}
|
|
|
|
|
2018-04-14 18:06:52 +01:00
|
|
|
// Message is the interface for publishing asynchronously
|
|
|
|
type Message interface {
|
2015-06-12 19:52:27 +01:00
|
|
|
Topic() string
|
2018-04-14 18:06:52 +01:00
|
|
|
Payload() interface{}
|
2015-06-12 19:52:27 +01:00
|
|
|
ContentType() string
|
|
|
|
}
|
|
|
|
|
2016-04-06 17:53:16 +01:00
|
|
|
// Request is the interface for a synchronous request used by Call or Stream
|
2015-06-12 19:52:27 +01:00
|
|
|
type Request interface {
|
2019-01-10 11:39:39 +00:00
|
|
|
// The service to call
|
2015-06-12 19:52:27 +01:00
|
|
|
Service() string
|
2019-01-10 21:25:31 +00:00
|
|
|
// The endpoint to call
|
|
|
|
Endpoint() string
|
2019-01-10 11:39:39 +00:00
|
|
|
// The content type
|
2015-06-12 19:52:27 +01:00
|
|
|
ContentType() string
|
2019-01-10 11:39:39 +00:00
|
|
|
// The unencoded request body
|
|
|
|
Body() interface{}
|
|
|
|
// Write to the encoded request writer. This is nil before a call is made
|
|
|
|
Codec() codec.Writer
|
2015-12-17 20:37:35 +00:00
|
|
|
// indicates whether the request will be a streaming one rather than unary
|
|
|
|
Stream() bool
|
2015-06-01 18:55:27 +01:00
|
|
|
}
|
|
|
|
|
2019-01-10 11:39:39 +00:00
|
|
|
// Response is the response received from a service
|
|
|
|
type Response interface {
|
|
|
|
// Read the response
|
|
|
|
Codec() codec.Reader
|
|
|
|
// read the header
|
|
|
|
Header() map[string]string
|
|
|
|
// Read the undecoded response
|
|
|
|
Read() ([]byte, error)
|
|
|
|
}
|
|
|
|
|
2018-04-14 18:15:09 +01:00
|
|
|
// Stream is the inteface for a bidirectional synchronous stream
|
|
|
|
type Stream interface {
|
2015-12-17 20:37:35 +00:00
|
|
|
Context() context.Context
|
2015-06-01 18:55:27 +01:00
|
|
|
Request() Request
|
2015-12-17 20:37:35 +00:00
|
|
|
Send(interface{}) error
|
|
|
|
Recv(interface{}) error
|
2015-06-01 18:55:27 +01:00
|
|
|
Error() error
|
|
|
|
Close() error
|
2015-01-13 23:31:27 +00:00
|
|
|
}
|
|
|
|
|
2016-04-06 17:53:16 +01:00
|
|
|
// Option used by the Client
|
2015-12-31 18:11:46 +00:00
|
|
|
type Option func(*Options)
|
2016-04-06 17:53:16 +01:00
|
|
|
|
|
|
|
// CallOption used by Call or Stream
|
2015-12-31 18:11:46 +00:00
|
|
|
type CallOption func(*CallOptions)
|
2016-04-06 17:53:16 +01:00
|
|
|
|
|
|
|
// PublishOption used by Publish
|
2015-12-31 18:11:46 +00:00
|
|
|
type PublishOption func(*PublishOptions)
|
2016-04-06 17:53:16 +01:00
|
|
|
|
2018-05-10 17:33:54 +01:00
|
|
|
// MessageOption used by NewMessage
|
|
|
|
type MessageOption func(*MessageOptions)
|
|
|
|
|
2016-04-06 17:53:16 +01:00
|
|
|
// RequestOption used by NewRequest
|
2015-12-31 18:11:46 +00:00
|
|
|
type RequestOption func(*RequestOptions)
|
2015-05-21 19:24:57 +01:00
|
|
|
|
2015-01-13 23:31:27 +00:00
|
|
|
var (
|
2016-04-06 17:53:16 +01:00
|
|
|
// DefaultClient is a default client to use out of the box
|
2015-05-23 17:40:53 +01:00
|
|
|
DefaultClient Client = newRpcClient()
|
2016-04-06 17:53:16 +01:00
|
|
|
// DefaultBackoff is the default backoff function for retries
|
|
|
|
DefaultBackoff = exponentialBackoff
|
2016-11-07 09:40:11 +01:00
|
|
|
// DefaultRetry is the default check-for-retry function for retries
|
2018-07-22 17:41:58 +01:00
|
|
|
DefaultRetry = RetryOnError
|
2016-04-06 17:53:16 +01:00
|
|
|
// DefaultRetries is the default number of times a request is tried
|
|
|
|
DefaultRetries = 1
|
|
|
|
// DefaultRequestTimeout is the default request timeout
|
2016-01-03 21:14:33 +00:00
|
|
|
DefaultRequestTimeout = time.Second * 5
|
2016-06-07 00:46:14 +01:00
|
|
|
// DefaultPoolSize sets the connection pool size
|
2018-05-26 09:10:29 +01:00
|
|
|
DefaultPoolSize = 1
|
2016-06-07 00:46:14 +01:00
|
|
|
// DefaultPoolTTL sets the connection pool ttl
|
|
|
|
DefaultPoolTTL = time.Minute
|
2015-01-13 23:31:27 +00:00
|
|
|
)
|
|
|
|
|
2018-04-17 11:00:22 +01:00
|
|
|
// Makes a synchronous call to a service using the default client
|
|
|
|
func Call(ctx context.Context, request Request, response interface{}, opts ...CallOption) error {
|
|
|
|
return DefaultClient.Call(ctx, request, response, opts...)
|
|
|
|
}
|
|
|
|
|
|
|
|
// Publishes a publication using the default client. Using the underlying broker
|
|
|
|
// set within the options.
|
2018-05-10 17:33:54 +01:00
|
|
|
func Publish(ctx context.Context, msg Message, opts ...PublishOption) error {
|
|
|
|
return DefaultClient.Publish(ctx, msg, opts...)
|
2018-04-17 11:00:22 +01:00
|
|
|
}
|
|
|
|
|
|
|
|
// Creates a new message using the default client
|
2018-05-10 17:33:54 +01:00
|
|
|
func NewMessage(topic string, payload interface{}, opts ...MessageOption) Message {
|
|
|
|
return DefaultClient.NewMessage(topic, payload, opts...)
|
2018-04-17 11:00:22 +01:00
|
|
|
}
|
|
|
|
|
2015-11-26 12:21:00 +00:00
|
|
|
// Creates a new client with the options passed in
|
2015-05-23 20:04:16 +01:00
|
|
|
func NewClient(opt ...Option) Client {
|
2015-05-23 17:40:53 +01:00
|
|
|
return newRpcClient(opt...)
|
|
|
|
}
|
2018-04-17 11:00:22 +01:00
|
|
|
|
|
|
|
// Creates a new request using the default client. Content Type will
|
|
|
|
// be set to the default within options and use the appropriate codec
|
2019-01-10 21:25:31 +00:00
|
|
|
func NewRequest(service, endpoint string, request interface{}, reqOpts ...RequestOption) Request {
|
|
|
|
return DefaultClient.NewRequest(service, endpoint, request, reqOpts...)
|
2018-04-17 11:00:22 +01:00
|
|
|
}
|
|
|
|
|
|
|
|
// Creates a streaming connection with a service and returns responses on the
|
|
|
|
// channel passed in. It's up to the user to close the streamer.
|
|
|
|
func NewStream(ctx context.Context, request Request, opts ...CallOption) (Stream, error) {
|
|
|
|
return DefaultClient.Stream(ctx, request, opts...)
|
|
|
|
}
|
|
|
|
|
|
|
|
func String() string {
|
|
|
|
return DefaultClient.String()
|
|
|
|
}
|