go-micro: github.com/micro/go-micro/client Index | Files | Directories

package client

import "github.com/micro/go-micro/client"

Package client is an interface for an RPC client

Index

Package Files

backoff.go buffer.go client.go context.go options.go retry.go rpc_client.go rpc_codec.go rpc_message.go rpc_pool.go rpc_request.go rpc_stream.go wrapper.go

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
)

func Call Uses

func Call(ctx context.Context, request Request, response interface{}, opts ...CallOption) error

Makes a synchronous call to a service using the default client

func NewContext Uses

func NewContext(ctx context.Context, c Client) context.Context

func Publish Uses

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 Uses

func RetryAlways(ctx context.Context, req Request, retryCount int, err error) (bool, error)

RetryAlways always retry on error

func RetryOnError Uses

func RetryOnError(ctx context.Context, req Request, retryCount int, err error) (bool, error)

RetryOnError retries a request on a 500 or timeout error

func String Uses

func String() string

type BackoffFunc Uses

type BackoffFunc func(ctx context.Context, req Request, attempts int) (time.Duration, error)

type CallFunc Uses

type CallFunc func(ctx context.Context, address string, req Request, rsp interface{}, opts CallOptions) error

CallFunc represents the individual call func

type CallOption Uses

type CallOption func(*CallOptions)

CallOption used by Call or Stream

func WithAddress Uses

func WithAddress(a string) CallOption

WithAddress sets the remote address to use rather than using service discovery

func WithBackoff Uses

func WithBackoff(fn BackoffFunc) CallOption

WithBackoff is a CallOption which overrides that which set in Options.CallOptions

func WithCallWrapper Uses

func WithCallWrapper(cw ...CallWrapper) CallOption

WithCallWrapper is a CallOption which adds to the existing CallFunc wrappers

func WithDialTimeout Uses

func WithDialTimeout(d time.Duration) CallOption

WithDialTimeout is a CallOption which overrides that which set in Options.CallOptions

func WithRequestTimeout Uses

func WithRequestTimeout(d time.Duration) CallOption

WithRequestTimeout is a CallOption which overrides that which set in Options.CallOptions

func WithRetries Uses

func WithRetries(i int) CallOption

WithRetries is a CallOption which overrides that which set in Options.CallOptions

func WithRetry Uses

func WithRetry(fn RetryFunc) CallOption

WithRetry is a CallOption which overrides that which set in Options.CallOptions

func WithSelectOption Uses

func WithSelectOption(so ...selector.SelectOption) CallOption

type CallOptions Uses

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 Uses

type CallWrapper func(CallFunc) CallFunc

CallWrapper is a low level wrapper for the CallFunc

type Client Uses

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.

func FromContext Uses

func FromContext(ctx context.Context) (Client, bool)

func NewClient Uses

func NewClient(opt ...Option) Client

Creates a new client with the options passed in

type Message Uses

type Message interface {
    Topic() string
    Payload() interface{}
    ContentType() string
}

Message is the interface for publishing asynchronously

func NewMessage Uses

func NewMessage(topic string, payload interface{}, opts ...MessageOption) Message

Creates a new message using the default client

type MessageOption Uses

type MessageOption func(*MessageOptions)

MessageOption used by NewMessage

type MessageOptions Uses

type MessageOptions struct {
    ContentType string
}

type Option Uses

type Option func(*Options)

Option used by the Client

func Backoff Uses

func Backoff(fn BackoffFunc) Option

Backoff is used to set the backoff function used when retrying Calls

func Broker Uses

func Broker(b broker.Broker) Option

Broker to be used for pub/sub

func Codec Uses

func Codec(contentType string, c codec.NewCodec) Option

Codec to be used to encode/decode requests for a given content type

func ContentType Uses

func ContentType(ct string) Option

Default content type of the client

func DialTimeout Uses

func DialTimeout(d time.Duration) Option

Transport dial timeout

func PoolSize Uses

func PoolSize(d int) Option

PoolSize sets the connection pool size

func PoolTTL Uses

func PoolTTL(d time.Duration) Option

PoolSize sets the connection pool size

func Registry Uses

func Registry(r registry.Registry) Option

Registry to find nodes for a given service

func RequestTimeout Uses

func RequestTimeout(d time.Duration) Option

The request timeout. Should this be a Call Option?

func Retries Uses

func Retries(i int) Option

Number of retries when making the request. Should this be a Call Option?

func Retry Uses

func Retry(fn RetryFunc) Option

Retry sets the retry function to be used when re-trying.

func Selector Uses

func Selector(s selector.Selector) Option

Select is used to select a node to route a request to

func Transport Uses

func Transport(t transport.Transport) Option

Transport to use for communication e.g http, rabbitmq, etc

func Wrap Uses

func Wrap(w Wrapper) Option

Adds a Wrapper to a list of options passed into the client

func WrapCall Uses

func WrapCall(cw ...CallWrapper) Option

Adds a Wrapper to the list of CallFunc wrappers

type Options Uses

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 PublishOption Uses

type PublishOption func(*PublishOptions)

PublishOption used by Publish

type PublishOptions Uses

type PublishOptions struct {
    // Other options for implementations of the interface
    // can be stored in a context
    Context context.Context
}

type Request Uses

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 Uses

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 Uses

type RequestOption func(*RequestOptions)

RequestOption used by NewRequest

func StreamingRequest Uses

func StreamingRequest() RequestOption

func WithContentType Uses

func WithContentType(ct string) RequestOption

type RequestOptions Uses

type RequestOptions struct {
    ContentType string
    Stream      bool

    // Other options for implementations of the interface
    // can be stored in a context
    Context context.Context
}

type RetryFunc Uses

type RetryFunc func(ctx context.Context, req Request, retryCount int, err error) (bool, error)

note that returning either false or a non-nil error will result in the call not being retried

type Stream Uses

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

func NewStream Uses

func NewStream(ctx context.Context, request Request, opts ...CallOption) (Stream, error)

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.

type StreamWrapper Uses

type StreamWrapper func(Stream) Stream

StreamWrapper wraps a Stream and returns the equivalent

type Wrapper Uses

type Wrapper func(Client) Client

Wrapper wraps a client and returns a client

Directories

PathSynopsis
mockPackage mock provides a mock client for testing
rpcPackage rpc provides an rpc client

Package client imports 18 packages (graph) and is imported by 407 packages. Updated 2018-12-02. Refresh now. Tools for package owners.