server

Documentation

Overview

Package server defines the Options of server

Package server defines the Options about remote transport of client.

Index

• func ApplyOptions(opts []Option, o *Options)
• func ApplyRegisterOptions(opts []RegisterOption, o *RegisterOptions)
• func DefaultSupportedTransportsFunc(option remote.ServerOption) []string
• func DefaultSysExitSignal() <-chan error
• func SysExitSignal() chan os.Signal
• type Config
  • func NewConfig() *Config
• type Limit
• type Option
• type Options
  • func NewOptions(opts []Option) *Options
• type RegisterOption
• type RegisterOptions
  • func NewRegisterOptions(opts []RegisterOption) *RegisterOptions
• type StreamXOptions

Functions

func ApplyOptions

func ApplyOptions(opts []Option, o *Options)

ApplyOptions applies the given options.

func ApplyRegisterOptions

func ApplyRegisterOptions(opts []RegisterOption, o *RegisterOptions)

ApplyRegisterOptions applies the given register options.

func DefaultSupportedTransportsFunc

func DefaultSupportedTransportsFunc(option remote.ServerOption) []string

func DefaultSysExitSignal

func DefaultSysExitSignal() <-chan error

func SysExitSignal

func SysExitSignal() chan os.Signal

Types

type Config

type Config struct {
	Address net.Addr

	// Duration that server waits for to allow any existing connection to be closed gracefully.
	ExitWaitTime time.Duration

	// Duration that server waits for after error occurs during connection accepting.
	AcceptFailedDelayTime time.Duration

	// Duration that the accepted connection waits for to read or write data, only works under NIO.
	MaxConnectionIdleTime time.Duration
}

Config contains some server-side configuration.

func NewConfig

func NewConfig() *Config

NewConfig creates a new default config.

type Limit

type Limit struct {
	Limits        *limit.Option
	LimitReporter limiter.LimitReporter
	ConLimit      limiter.ConcurrencyLimiter
	QPSLimit      limiter.RateLimiter

	// QPSLimitPostDecode is true to indicate that the QPS limiter takes effect in
	// the OnMessage callback, and false for the OnRead callback.
	// Usually when the server is multiplexed, Kitex set it to True by default.
	QPSLimitPostDecode bool
}

type Option

type Option struct {
	F func(o *Options, di *utils.Slice)
}

Option is the only way to config a server.

type Options

type Options struct {
	Svr      *rpcinfo.EndpointBasicInfo
	Configs  rpcinfo.RPCConfig
	LockBits int
	Once     *configutil.OptionOnce

	MetaHandlers []remote.MetaHandler

	RemoteOpt  *remote.ServerOption
	ErrHandle  func(context.Context, error) error
	ExitSignal func() <-chan error
	Proxy      proxy.ReverseProxy

	// Registry is used for service registry.
	Registry registry.Registry
	// RegistryInfo is used to in registry.
	RegistryInfo *registry.Info

	ACLRules []acl.RejectFunc
	Limit    Limit

	MWBs []endpoint.MiddlewareBuilder

	Bus    event.Bus
	Events event.Queue

	SupportedTransportsFunc func(option remote.ServerOption) []string

	// DebugInfo should only contain objects that are suitable for json serialization.
	DebugInfo    utils.Slice
	DebugService diagnosis.Service

	// Observability
	TracerCtl  *rpcinfo.TraceController
	StatsLevel *stats.Level

	BackupOpt backup.Options

	// Streaming
	Streaming stream.StreamingConfig // old version streaming API config
	StreamX   StreamXOptions         // new version streaming API config

	RefuseTrafficWithoutServiceName bool
	EnableContextTimeout            bool
}

Options is used to initialize the server.

func NewOptions

func NewOptions(opts []Option) *Options

NewOptions creates a default options.

type RegisterOption

type RegisterOption struct {
	F func(o *RegisterOptions)
}

RegisterOption is the only way to config service registration.

type RegisterOptions

type RegisterOptions struct {
	IsFallbackService bool
	Middlewares       []endpoint.Middleware
}

RegisterOptions is used to config service registration.

func NewRegisterOptions

func NewRegisterOptions(opts []RegisterOption) *RegisterOptions

NewRegisterOptions creates a register options.

type StreamXOptions

type StreamXOptions struct {
	StreamMiddlewares     []streamx.StreamMiddleware
	StreamRecvMiddlewares []streamx.StreamRecvMiddleware
	StreamSendMiddlewares []streamx.StreamSendMiddleware
	Provider              streamx.ServerProvider
}