micro/client/client.go

140 lines
5.0 KiB
Go
Raw Normal View History

2016-12-14 18:41:48 +03:00
// Package client is an interface for an RPC client
2015-01-14 02:31:27 +03:00
package client
2015-05-21 21:24:57 +03:00
import (
2016-01-04 00:14:33 +03:00
"time"
2015-05-23 13:53:40 +03:00
"golang.org/x/net/context"
2015-05-21 21:24:57 +03:00
)
2016-01-31 00:15:08 +03: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-14 02:31:27 +03:00
type Client interface {
2016-01-02 22:12:17 +03:00
Init(...Option) error
Options() Options
NewPublication(topic string, msg interface{}) Publication
2015-12-17 23:37:35 +03:00
NewRequest(service, method string, req interface{}, reqOpts ...RequestOption) Request
NewProtoRequest(service, method string, req interface{}, reqOpts ...RequestOption) Request
NewJsonRequest(service, method string, req interface{}, reqOpts ...RequestOption) Request
2015-12-08 22:25:42 +03:00
Call(ctx context.Context, req Request, rsp interface{}, opts ...CallOption) error
CallRemote(ctx context.Context, addr string, req Request, rsp interface{}, opts ...CallOption) error
2015-12-17 23:37:35 +03:00
Stream(ctx context.Context, req Request, opts ...CallOption) (Streamer, error)
StreamRemote(ctx context.Context, addr string, req Request, opts ...CallOption) (Streamer, error)
2015-12-08 22:25:42 +03:00
Publish(ctx context.Context, p Publication, opts ...PublishOption) error
2015-12-20 00:56:14 +03:00
String() string
}
2016-04-06 19:53:16 +03:00
// Publication is the interface for a message published asynchronously
type Publication interface {
Topic() string
Message() interface{}
ContentType() string
}
2016-04-06 19:53:16 +03:00
// Request is the interface for a synchronous request used by Call or Stream
type Request interface {
Service() string
Method() string
ContentType() string
Request() interface{}
2015-12-17 23:37:35 +03:00
// indicates whether the request will be a streaming one rather than unary
Stream() bool
}
2016-04-06 19:53:16 +03:00
// Streamer is the inteface for a bidirectional synchronous stream
type Streamer interface {
2015-12-17 23:37:35 +03:00
Context() context.Context
Request() Request
2015-12-17 23:37:35 +03:00
Send(interface{}) error
Recv(interface{}) error
Error() error
Close() error
2015-01-14 02:31:27 +03:00
}
2016-04-06 19:53:16 +03:00
// Option used by the Client
type Option func(*Options)
2016-04-06 19:53:16 +03:00
// CallOption used by Call or Stream
type CallOption func(*CallOptions)
2016-04-06 19:53:16 +03:00
// PublishOption used by Publish
type PublishOption func(*PublishOptions)
2016-04-06 19:53:16 +03:00
// RequestOption used by NewRequest
type RequestOption func(*RequestOptions)
2015-05-21 21:24:57 +03:00
2015-01-14 02:31:27 +03:00
var (
2016-04-06 19:53:16 +03:00
// DefaultClient is a default client to use out of the box
2015-05-23 19:40:53 +03:00
DefaultClient Client = newRpcClient()
2016-04-06 19:53:16 +03:00
// DefaultBackoff is the default backoff function for retries
DefaultBackoff = exponentialBackoff
2016-11-07 11:40:11 +03:00
// DefaultRetry is the default check-for-retry function for retries
DefaultRetry = alwaysRetry
2016-04-06 19:53:16 +03:00
// DefaultRetries is the default number of times a request is tried
DefaultRetries = 1
// DefaultRequestTimeout is the default request timeout
2016-01-04 00:14:33 +03:00
DefaultRequestTimeout = time.Second * 5
2016-06-07 02:46:14 +03:00
// DefaultPoolSize sets the connection pool size
DefaultPoolSize = 0
// DefaultPoolTTL sets the connection pool ttl
DefaultPoolTTL = time.Minute
2015-01-14 02:31:27 +03:00
)
2015-11-26 15:21:00 +03:00
// Makes a synchronous call to a service using the default client
2015-12-08 22:25:42 +03:00
func Call(ctx context.Context, request Request, response interface{}, opts ...CallOption) error {
return DefaultClient.Call(ctx, request, response, opts...)
2015-01-14 02:31:27 +03:00
}
2015-11-26 15:21:00 +03:00
// Makes a synchronous call to the specified address using the default client
2015-12-08 22:25:42 +03:00
func CallRemote(ctx context.Context, address string, request Request, response interface{}, opts ...CallOption) error {
return DefaultClient.CallRemote(ctx, address, request, response, opts...)
2015-01-14 02:31:27 +03:00
}
2015-11-26 15:21:00 +03:00
// Creates a streaming connection with a service and returns responses on the
2016-04-06 19:53:16 +03:00
// channel passed in. It's up to the user to close the streamer.
2015-12-17 23:37:35 +03:00
func Stream(ctx context.Context, request Request, opts ...CallOption) (Streamer, error) {
return DefaultClient.Stream(ctx, request, opts...)
}
2015-11-26 15:21:00 +03:00
// Creates a streaming connection to the address specified.
2015-12-17 23:37:35 +03:00
func StreamRemote(ctx context.Context, address string, request Request, opts ...CallOption) (Streamer, error) {
return DefaultClient.StreamRemote(ctx, address, request, opts...)
}
2015-11-26 15:21:00 +03:00
// Publishes a publication using the default client. Using the underlying broker
// set within the options.
func Publish(ctx context.Context, p Publication) error {
return DefaultClient.Publish(ctx, p)
}
2015-11-26 15:21:00 +03:00
// Creates a new client with the options passed in
func NewClient(opt ...Option) Client {
2015-05-23 19:40:53 +03:00
return newRpcClient(opt...)
}
2015-11-26 15:21:00 +03:00
// Creates a new publication using the default client
func NewPublication(topic string, message interface{}) Publication {
return DefaultClient.NewPublication(topic, message)
}
2015-11-26 15:21:00 +03:00
// Creates a new request using the default client. Content Type will
// be set to the default within options and use the appropriate codec
2015-12-17 23:37:35 +03:00
func NewRequest(service, method string, request interface{}, reqOpts ...RequestOption) Request {
return DefaultClient.NewRequest(service, method, request, reqOpts...)
2015-01-14 02:31:27 +03:00
}
2015-11-26 15:21:00 +03:00
// Creates a new protobuf request using the default client
2015-12-17 23:37:35 +03:00
func NewProtoRequest(service, method string, request interface{}, reqOpts ...RequestOption) Request {
return DefaultClient.NewProtoRequest(service, method, request, reqOpts...)
2015-01-14 02:31:27 +03:00
}
2015-11-26 15:21:00 +03:00
// Creates a new json request using the default client
2015-12-17 23:37:35 +03:00
func NewJsonRequest(service, method string, request interface{}, reqOpts ...RequestOption) Request {
return DefaultClient.NewJsonRequest(service, method, request, reqOpts...)
2015-01-14 02:31:27 +03:00
}
2015-12-20 00:56:14 +03:00
func String() string {
return DefaultClient.String()
}