client

package

Go to main page

Versions in this module

v0

v0.4.1

Apr 7, 2025

v0.4.0

Apr 5, 2025

v0.3.0

Mar 26, 2025

Changes in this version

+ var DefaultCallOptionsRetries = 0

+ var DefaultCallOptionsRetryFunc = (RetryFunc)(nil)

+ var DefaultMaxCallRecvMsgSize = 10 * 1024 * 1024

+ var DefaultMaxCallSendMsgSize = 10 * 1024 * 1024

+ var ErrStreamNotSupported = errors.New("client does not support streaming")

+ func RegisterMemoryServer(service string, server MemoryServer)

+ func UnregisterMemoryServer(service string)

type CallOption

+ func WithMaxCallRecvMsgSize(n int) CallOption

+ func WithMaxCallSendMsgSize(n int) CallOption

+ func WithMetadata(n map[string]string) CallOption

+ func WithNamespace(n string) CallOption

+ func WithRegion(r string) CallOption

+ func WithRetryFunc(fn RetryFunc) CallOption

type CallOptions

+ MaxCallRecvMsgSize int

+ MaxCallSendMsgSize int

+ Metadata map[string]string

+ Namespace string

+ Region string

+ RetryFunc RetryFunc

type Client

+ Request func(ctx context.Context, service string, endpoint string, req any, result any, ...) error

+ SelectService func(ctx context.Context, service string, opts ...CallOption) (string, string, error)

+ Stream func(ctx context.Context, service string, endpoint string, opts ...CallOption) (StreamIface[any, any], error)

type Config

+ Namespace string

+ Region string

+ type MemoryServer interface

+ Request func(ctx context.Context, infos RequestInfos, req any, result any, ...) error

+ Stream func(ctx context.Context, infos RequestInfos, opts *CallOptions) (StreamIface[any, any], error)

+ func ResolveMemoryServer(service string) (MemoryServer, error)

type Middleware

+ Request func(next MiddlewareRequestHandler) MiddlewareRequestHandler

+ type MiddlewareRequestHandler func(ctx context.Context, service string, endpoint string, req any, result any, ...) error

type Option

+ func WithClientNamespace(n string) Option

+ func WithClientPoolHosts(n int) Option

+ func WithClientRegion(r string) Option

+ type RequestInfos struct

+ Address string

+ Endpoint string

+ Service string

+ Transport string

+ func RequestInfo(ctx context.Context) (RequestInfos, bool)

+ type RequestInfosKey struct

+ type StreamAdapter struct

+ func (s *StreamAdapter[TReq, TResp]) Close() error

+ func (s *StreamAdapter[TReq, TResp]) CloseSend() error

+ func (s *StreamAdapter[TReq, TResp]) Context() context.Context

+ func (s *StreamAdapter[TReq, TResp]) Endpoint() string

+ func (s *StreamAdapter[TReq, TResp]) Recv(msg TResp) error

+ func (s *StreamAdapter[TReq, TResp]) Send(msg TReq) error

+ func (s *StreamAdapter[TReq, TResp]) Service() string

+ type StreamIface interface

+ Close func() error

+ CloseSend func() error

+ Context func() context.Context

+ Recv func(msg TResp) error

+ Send func(msg TReq) error

+ func NewStreamAdapter[TReq any, TResp any](stream StreamIface[any, any], service string, endpoint string, client Client) StreamIface[TReq, TResp]

+ func Stream[TReq any, TResp any](ctx context.Context, c Client, service, endpoint string, opts ...CallOption) (StreamIface[TReq, TResp], error)

type Type

+ func New(configData map[string]any, components *types.Components, logger log.Logger, ...) (Type, error)

+ func ProvideNoOpts(svcCtx *cli.ServiceContextWithConfig, components *types.Components, ...) (Type, error)

v0.2.1

Feb 28, 2025

v0.2.0

Feb 28, 2025

v0.1.1

Feb 26, 2025

v0.1.0

Feb 23, 2025

Changes in this version

+ const ComponentType

+ const MiddlewareComponentType

+ var DefaultBackoff = BackoffExponential

+ var DefaultClientPlugin = "orb"

+ var DefaultConfigSection = "client"

+ var DefaultConnClose = false

+ var DefaultConnectionTimeout = time.Second * 5

+ var DefaultContentType = "application/x-protobuf"

+ var DefaultDialTimeout = time.Second * 5

+ var DefaultPoolHosts = 16

+ var DefaultPoolSize = 100

+ var DefaultPoolTTL = time.Minute

+ var DefaultPreferredTransports = []string

+ var DefaultRequestTimeout = time.Second * 30

+ var DefaultRetries = 5

+ var DefaultRetry = RetryOnTimeoutError

+ var DefaultSelector = SelectRandomNode

+ var DefaultStreamTimeout = time.Duration(0)

+ var ErrFailedToCreateTransport = errors.New("failed to create a transport")

+ var ErrNoNodeFound = errors.New("no node found for the requested service")

+ var ErrServiceArgumentEmpty = errors.New("service argument is empty")

+ var ErrUnknownContentType = errors.New("unknown content-type has been requested")

+ var Middlewares = container.NewMap[string, MiddlewareFactory]()

+ func BackoffExponential(_ context.Context, _ Request[any, any], attempts int) (time.Duration, error)

+ func Call[TResp any, TReq any](ctx context.Context, client Client, service string, endpoint string, req TReq, ...) (*TResp, error)

+ func Register(name string, factory ProviderFunc) bool

+ func RetryAlways(_ context.Context, _ Request[any, any], _ int, _ error) (bool, error)

+ func RetryOnTimeoutError(_ context.Context, _ Request[any, any], _ int, err error) (bool, error)

+ func SelectRandomNode(_ context.Context, _ string, nodes NodeMap, preferredTransports []string, ...) (*registry.Node, error)

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

+ type CallOption func(*CallOptions)

+ func WithAnyTransport() CallOption

+ func WithBackoff(fn BackoffFunc) CallOption

+ func WithConnClose() CallOption

+ func WithContentType(ct string) CallOption

+ func WithDialTimeout(d time.Duration) CallOption

+ func WithPoolHosts(n int) CallOption

+ func WithPoolSize(n int) CallOption

+ func WithPoolTTL(n time.Duration) CallOption

+ func WithPreferredTransports(n ...string) CallOption

+ func WithRequestTimeout(d time.Duration) CallOption

+ func WithResponseMetadata(n map[string]string) CallOption

+ func WithRetries(i int) CallOption

+ func WithRetry(fn RetryFunc) CallOption

+ func WithSelector(fn SelectorFunc) CallOption

+ func WithStreamTimeout(d time.Duration) CallOption

+ func WithTLSConfig(n *tls.Config) CallOption

+ func WithURL(n string) CallOption

+ type CallOptions struct

+ AnyTransport bool

+ Backoff BackoffFunc

+ ConnClose bool

+ ConnectionTimeout time.Duration

+ ContentType string

+ DialTimeout time.Duration

+ PoolHosts int

+ PoolSize int

+ PoolTTL time.Duration

+ PreferredTransports []string

+ RequestTimeout time.Duration

+ ResponseMetadata map[string]string

+ Retries int

+ Retry RetryFunc

+ Selector SelectorFunc

+ StreamTimeout time.Duration

+ TLSConfig *tls.Config

+ URL string

+ type Client interface

+ Call func(ctx context.Context, req *Request[any, any], result any, opts ...CallOption) (*RawResponse, error)

+ CallNoCodec func(ctx context.Context, req *Request[any, any], result any, opts ...CallOption) error

+ Config func() Config

+ NeedsCodec func(ctx context.Context, req *Request[any, any], opts ...CallOption) bool

+ ResolveService func(ctx context.Context, service string, preferredTransports ...string) (NodeMap, error)

+ With func(opts ...Option) error

+ type Config struct

+ AnyTransport bool

+ Backoff BackoffFunc

+ ConnectionTimeout time.Duration

+ ContentType string

+ DialTimeout time.Duration

+ Middleware []MiddlewareConfig

+ Plugin string

+ PoolHosts int

+ PoolSize int

+ PoolTTL time.Duration

+ PreferredTransports []string

+ RequestTimeout time.Duration

+ Retries int

+ Retry RetryFunc

+ Selector SelectorFunc

+ StreamTimeout time.Duration

+ TLSConfig *tls.Config

+ func NewConfig(opts ...Option) Config

+ type ConfigType interface

+ type Middleware interface

+ Call func(next MiddlewareCallHandler) MiddlewareCallHandler

+ CallNoCodec func(next MiddlewareCallNoCodecHandler) MiddlewareCallNoCodecHandler

+ type MiddlewareCallHandler func(ctx context.Context, req *Request[any, any], opts *CallOptions) (*RawResponse, error)

+ type MiddlewareCallNoCodecHandler func(ctx context.Context, req *Request[any, any], result any, opts *CallOptions) error

+ type MiddlewareConfig struct

+ Name string

+ type MiddlewareFactory func(configSection []string, configs types.ConfigData, client Type, ...) (Middleware, error)

+ type NodeMap map[string][]*registry.Node

+ type Option func(ConfigType)

+ func WithClientAnyTransport() Option

+ func WithClientBackoff(n BackoffFunc) Option

+ func WithClientConnectionTimeout(n time.Duration) Option

+ func WithClientContentType(n string) Option

+ func WithClientDialTimeout(n time.Duration) Option

+ func WithClientMiddleware(m MiddlewareConfig) Option

+ func WithClientPlugin(n string) Option

+ func WithClientPoolSize(n int) Option

+ func WithClientPoolTTL(n time.Duration) Option

+ func WithClientPreferredTransports(n ...string) Option

+ func WithClientRequestTimeout(n time.Duration) Option

+ func WithClientRetries(n int) Option

+ func WithClientRetry(n RetryFunc) Option

+ func WithClientSelector(n SelectorFunc) Option

+ func WithClientStreamTimeout(n time.Duration) Option

+ func WithClientTLSConfig(n *tls.Config) Option

+ type ProviderFunc func(name types.ServiceName, data types.ConfigData, logger log.Logger, ...) (Type, error)

+ type RawResponse = Response[io.Reader]

+ type Request struct

+ func NewRequest[TResp any, TReq any](service string, endpoint string, req TReq) *Request[TResp, TReq]

+ func (r *Request[TResp, TReq]) Call(ctx context.Context, client Client, opts ...CallOption) (resp *TResp, err error)

+ func (r *Request[TResp, TReq]) Endpoint() string

+ func (r *Request[TResp, TReq]) Node(ctx context.Context, opts *CallOptions) (*registry.Node, error)

+ func (r *Request[TResp, TReq]) Request() TReq

+ func (r *Request[TResp, TReq]) Service() string

+ type Response struct

+ Body T

+ ContentType string

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

+ type SelectorFunc func(ctx context.Context, service string, nodes NodeMap, ...) (*registry.Node, error)

+ type Type struct

+ func Provide(name types.ServiceName, configs types.ConfigData, logger log.Logger, ...) (Type, error)

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL