package
0.10.3
Repository: https://github.com/cloudwego/kitex.git
Documentation: pkg.go.dev

# Packages

Package genericserver ...
No description provided by the author

# Functions

NewInvoker creates new Invoker.
NewServer creates a server with the given Options.
RegisterShutdownHook add hook which is executed after the server shutdown.
RegisterStartHook add hook which is executed after the server starts.
WithACLRules sets the ACL rules.
WithBoundHandler adds remote.BoundHandler for server.
WithCodec to set a codec that handle other protocols which not support by kitex.
WithCompatibleMiddlewareForUnary allows Unary APIs to use the same middleware as non-streaming APIs For thrift unary APIs over HTTP2, it's enabled by default.
Deprecated: Use WithConnectionLimiter instead.
WithConnectionLimiter sets the limiter of connections.
WithContextBackup enables local-session to backup kitex server's context, in case of user don't correctly pass context into next RPC call.
WithDiagnosisService sets the diagnosis service for gathering debug information.
WithEnableContextTimeout enables handler timeout.
WithErrorHandler sets the error handler.
WithExitSignal adds ExitSignal for server.
WithExitWaitTime sets the wait duration for graceful shutdown.
No description provided by the author
WithGeneric set Generic type for generic call.
WithGRPCInitialConnWindowSize returns an Option that sets window size for a connection.
WithGRPCInitialWindowSize returns a Option that sets window size for stream.
WithGRPCKeepaliveEnforcementPolicy returns an Option that sets keepalive enforcement policy for the server.
WithGRPCKeepaliveParams returns an Option that sets keepalive and max-age parameters for the server.
WithGRPCMaxConcurrentStreams returns an Option that will apply a limit on the number of concurrent streams to each ServerTransport.
WithGRPCMaxHeaderListSize returns a ServerOption that sets the max (uncompressed) size of header list that the server is prepared to accept.
WithGRPCReadBufferSize lets you set the size of read buffer, this determines how much data can be read at most for one read syscall.
No description provided by the author
WithGRPCWriteBufferSize determines how much data can be batched before doing a write on the wire.
WithLimit sets the limitation of concurrent connections or max QPS.
WithLimitReporter do report when server limit happen.
WithListener sets the listener for server, the priority is higher than WithServiceAddr.
WithLogger sets the Logger for kitex server.
WithMaxConnIdleTime sets the max idle time on connection from clients.
WithMetaHandler adds a MetaHandler.
WithMiddleware adds middleware for server to handle request.
WithMiddlewareBuilder adds middleware that depend on context for server to handle request.
Deprecated: Useless option now, server support multi protocols by default.
WithMuxTransport specifies the transport type to be mux.
WithPayloadCodec to set a payloadCodec that handle other payload which not support by kitex.
WithProfiler set a profiler to server.
WithProfilerMessageTagging set message tagging function to profiler MessageTagging extracting tags after whole decode process finished.
WithProfilerTransInfoTagging set transinfo tagging function to profiler TransInfoTagging extracting tags after TransInfo decoded but before message decoded.
WithProxy sets the backward Proxy for server.
WithQPSLimiter sets the limiter of max QPS.
WithReadWriteTimeout sets the read/write timeout on network.
WithRecvMiddleware adds middleware for server to handle response.
WithRecvMiddlewareBuilder adds middleware that depend on a per-server context for server to handle response.
WithRefuseTrafficWithoutServiceName returns an Option that only accepts traffics with service name.
WithRegistry to set a Registry to register service.
WithRegistryInfo to set Registry Info if needed.
WithReusePort sets SO_REUSEPORT on listener, it is only used with Option `WithServiceAddr`.
WithSendMiddleware adds middleware for server to handle request.
WithSendMiddlewareBuilder adds middleware that depend on a per-server context for server to handle request.
WithServerBasicInfo provides initial information for client endpoint in RPCInfo.
WithServiceAddr sets the listen address for server.
WithStatsLevel sets the stats level for server.
WithSuite adds an option suite for server.
WithSupportedTransportsFunc sets a function which converts supported transports from server option.
WithTracer adds a tracer to server.
WithTransHandlerFactory sets the TransHandlerFactory for server.
WithTransServerFactory sets the TransServerFactory for server.

# Interfaces

InvokeCaller is the abstraction for invoker call.
Invoker is the abstraction for invoker.
Server is an abstraction of an RPC server.
A Suite is a collection of Options.

# Type aliases

Hooks is a collection of func.
Option is the only way to config server.
Options is used to initialize the server.
RegisterOption is the only way to config service registration.
RegisterOptions is used to config service registration.