rkgrpctimeout

Documentation

Overview

Package rkgrpctimeout is a middleware of grpc framework for timing out request.

Index

• Constants
• func StreamServerInterceptor(opts ...Option) grpc.StreamServerInterceptor
• func UnaryServerInterceptor(opts ...Option) grpc.UnaryServerInterceptor
• type Option
  • func WithEntryNameAndType(entryName, entryType string) Option
  • func WithTimeoutAndResp(timeout time.Duration, resp error) Option
  • func WithTimeoutAndRespByPath(path string, timeout time.Duration, resp error) Option

Constants

const (
	TokenBucket   = "tokenBucket"
	LeakyBucket   = "leakyBucket"
	DefaultLimit  = 1000000
	GlobalLimiter = "rk-limiter"
)

Functions

func StreamServerInterceptor

func StreamServerInterceptor(opts ...Option) grpc.StreamServerInterceptor

StreamServerInterceptor Add rate limit interceptors.

func UnaryServerInterceptor

func UnaryServerInterceptor(opts ...Option) grpc.UnaryServerInterceptor

UnaryServerInterceptor Add rate limit interceptors.

Types

type Option

type Option func(*optionSet)

Option option for optionSet

func WithEntryNameAndType

func WithEntryNameAndType(entryName, entryType string) Option

WithEntryNameAndType Provide entry name and entry type.

func WithTimeoutAndResp

func WithTimeoutAndResp(timeout time.Duration, resp error) Option

WithTimeoutAndResp Provide global timeout and response handler. If response is nil, default globalResponse will be assigned

func WithTimeoutAndRespByPath

func WithTimeoutAndRespByPath(path string, timeout time.Duration, resp error) Option

WithTimeoutAndRespByPath Provide timeout and response handler by path. If response is nil, default globalResponse will be assigned