Documentation ¶
Overview ¶
Package client is an interface for an RPC client
Index ¶
- Variables
- func Call(ctx context.Context, request Request, response interface{}, opts ...CallOption) error
- func NewContext(ctx context.Context, c Client) context.Context
- func Publish(ctx context.Context, msg Message, opts ...PublishOption) error
- func RetryAlways(ctx context.Context, req Request, retryCount int, err error) (bool, error)
- func RetryOnError(ctx context.Context, req Request, retryCount int, err error) (bool, error)
- func String() string
- type BackoffFunc
- type CallFunc
- type CallOption
- func WithAddress(a string) CallOption
- func WithBackoff(fn BackoffFunc) CallOption
- func WithCallWrapper(cw ...CallWrapper) CallOption
- func WithDialTimeout(d time.Duration) CallOption
- func WithRequestTimeout(d time.Duration) CallOption
- func WithRetries(i int) CallOption
- func WithRetry(fn RetryFunc) CallOption
- func WithSelectOption(so ...selector.SelectOption) CallOption
- type CallOptions
- type CallWrapper
- type Client
- type Message
- type MessageOption
- type MessageOptions
- type Option
- func Backoff(fn BackoffFunc) Option
- func Broker(b broker.Broker) Option
- func Codec(contentType string, c codec.NewCodec) Option
- func ContentType(ct string) Option
- func DialTimeout(d time.Duration) Option
- func PoolSize(d int) Option
- func PoolTTL(d time.Duration) Option
- func Registry(r registry.Registry) Option
- func RequestTimeout(d time.Duration) Option
- func Retries(i int) Option
- func Retry(fn RetryFunc) Option
- func Selector(s selector.Selector) Option
- func Transport(t transport.Transport) Option
- func Wrap(w Wrapper) Option
- func WrapCall(cw ...CallWrapper) Option
- type Options
- type PublishOption
- type PublishOptions
- type Request
- type RequestOption
- type RequestOptions
- type RetryFunc
- type Stream
- type StreamWrapper
- type Wrapper
Constants ¶
This section is empty.
Variables ¶
var ( // DefaultClient is a default client to use out of the box DefaultClient Client = newRpcClient() // DefaultBackoff is the default backoff function for retries DefaultBackoff = exponentialBackoff // DefaultRetry is the default check-for-retry function for retries DefaultRetry = RetryOnError // DefaultRetries is the default number of times a request is tried DefaultRetries = 1 // DefaultRequestTimeout is the default request timeout DefaultRequestTimeout = time.Second * 5 // DefaultPoolSize sets the connection pool size DefaultPoolSize = 1 // DefaultPoolTTL sets the connection pool ttl DefaultPoolTTL = time.Minute )
Functions ¶
func Call ¶
func Call(ctx context.Context, request Request, response interface{}, opts ...CallOption) error
Makes a synchronous call to a service using the default client
func Publish ¶
func Publish(ctx context.Context, msg Message, opts ...PublishOption) error
Publishes a publication using the default client. Using the underlying broker set within the options.
func RetryAlways ¶ added in v0.10.0
RetryAlways always retry on error
func RetryOnError ¶ added in v0.10.0
RetryOnError retries a request on a 500 or timeout error
Types ¶
type BackoffFunc ¶
type CallFunc ¶
type CallFunc func(ctx context.Context, address string, req Request, rsp interface{}, opts CallOptions) error
CallFunc represents the individual call func
type CallOption ¶
type CallOption func(*CallOptions)
CallOption used by Call or Stream
func WithAddress ¶ added in v0.8.0
func WithAddress(a string) CallOption
WithAddress sets the remote address to use rather than using service discovery
func WithBackoff ¶
func WithBackoff(fn BackoffFunc) CallOption
WithBackoff is a CallOption which overrides that which set in Options.CallOptions
func WithCallWrapper ¶
func WithCallWrapper(cw ...CallWrapper) CallOption
WithCallWrapper is a CallOption which adds to the existing CallFunc wrappers
func WithDialTimeout ¶
func WithDialTimeout(d time.Duration) CallOption
WithDialTimeout is a CallOption which overrides that which set in Options.CallOptions
func WithRequestTimeout ¶
func WithRequestTimeout(d time.Duration) CallOption
WithRequestTimeout is a CallOption which overrides that which set in Options.CallOptions
func WithRetries ¶
func WithRetries(i int) CallOption
WithRetries is a CallOption which overrides that which set in Options.CallOptions
func WithRetry ¶
func WithRetry(fn RetryFunc) CallOption
WithRetry is a CallOption which overrides that which set in Options.CallOptions
func WithSelectOption ¶
func WithSelectOption(so ...selector.SelectOption) CallOption
type CallOptions ¶
type CallOptions struct { SelectOptions []selector.SelectOption // Address of remote host Address string // Backoff func Backoff BackoffFunc // Check if retriable func Retry RetryFunc // Transport Dial Timeout DialTimeout time.Duration // Number of Call attempts Retries int // Request/Response timeout RequestTimeout time.Duration // Middleware for low level call func CallWrappers []CallWrapper // Other options for implementations of the interface // can be stored in a context Context context.Context }
type CallWrapper ¶
CallWrapper is a low level wrapper for the CallFunc
type Client ¶
type Client interface { Init(...Option) error Options() Options NewMessage(topic string, msg interface{}, opts ...MessageOption) Message NewRequest(service, method string, req interface{}, reqOpts ...RequestOption) Request Call(ctx context.Context, req Request, rsp interface{}, opts ...CallOption) error Stream(ctx context.Context, req Request, opts ...CallOption) (Stream, error) Publish(ctx context.Context, msg Message, opts ...PublishOption) error String() string }
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.
type Message ¶ added in v0.8.0
Message is the interface for publishing asynchronously
func NewMessage ¶ added in v0.8.0
func NewMessage(topic string, payload interface{}, opts ...MessageOption) Message
Creates a new message using the default client
type MessageOption ¶ added in v0.9.0
type MessageOption func(*MessageOptions)
MessageOption used by NewMessage
type MessageOptions ¶ added in v0.9.0
type MessageOptions struct {
ContentType string
}
type Option ¶
type Option func(*Options)
Option used by the Client
func Backoff ¶
func Backoff(fn BackoffFunc) Option
Backoff is used to set the backoff function used when retrying Calls
func RequestTimeout ¶
The request timeout. Should this be a Call Option?
func WrapCall ¶
func WrapCall(cw ...CallWrapper) Option
Adds a Wrapper to the list of CallFunc wrappers
type Options ¶
type Options struct { // 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 // Connection Pool PoolSize int PoolTTL time.Duration // 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 PublishOptions ¶
type Request ¶
type Request interface { Service() string Method() string ContentType() string Request() interface{} // indicates whether the request will be a streaming one rather than unary Stream() bool }
Request is the interface for a synchronous request used by Call or Stream
func NewRequest ¶
func NewRequest(service, method string, request interface{}, reqOpts ...RequestOption) Request
Creates a new request using the default client. Content Type will be set to the default within options and use the appropriate codec
type RequestOption ¶
type RequestOption func(*RequestOptions)
RequestOption used by NewRequest
func StreamingRequest ¶
func StreamingRequest() RequestOption
func WithContentType ¶ added in v0.8.0
func WithContentType(ct string) RequestOption
type RequestOptions ¶
type RetryFunc ¶
note that returning either false or a non-nil error will result in the call not being retried
type Stream ¶
type Stream interface { Context() context.Context Request() Request Send(interface{}) error Recv(interface{}) error Error() error Close() error }
Stream is the inteface for a bidirectional synchronous stream
type StreamWrapper ¶
StreamWrapper wraps a Stream and returns the equivalent