rpc

package
v1.2.2 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Nov 21, 2023 License: MIT Imports: 15 Imported by: 2

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

func CheckRequestHandler 

func CheckRequestHandler[request any, response any](checkFunc func(request) (bool, string)) func(ctx *Context[request, response])

func CheckResponseHandler 

func CheckResponseHandler[request any, response any](checkFunc func(response) (bool, string)) func(ctx *Context[request, response])

func ExecuteChain 

func ExecuteChain[request any, response any](handlers Chain[request, response], ctx context.Context, req request, resp response) (result response, err error)

func LogInputAndOutputHandler 

func LogInputAndOutputHandler[request any, response any](log logger.Logger, service string, handler string) func(ctx *Context[request, response])

func RecoveryHandler 

func RecoveryHandler[request any, response any](log logger.Logger, service string, handler string) func(ctx *Context[request, response])

func RequestLimiterHandler 

func RequestLimiterHandler[request any, response any](rpd, rpm, rps int) func(ctx *Context[request, response])

func RequestLimiterHandlerWithFn 

func RequestLimiterHandlerWithFn[request any, response any](rpd, rpm, rps int, _ func(request) (response, error)) func(ctx *Context[request, response])

Types

type Chain 

type Chain[request any, response any] []Handler[request, response]

func DefaultChain 

func DefaultChain[request any, response any](logger logger.Logger, serviceName string, handlerName string, handlers ...Handler[request, response]) Chain[request, response]

func LimitedDefaultChain 

func LimitedDefaultChain[request any, response any](logger logger.Logger, serviceName string, handlerName string, rpd, rpm, rps int, handlers ...Handler[request, response]) Chain[request, response]

func NewChain 

func NewChain[request any, response any](handlers ...Handler[request, response]) Chain[request, response]

func (Chain[request, response]) AddFrontHandler 

func (c Chain[request, response]) AddFrontHandler(h ...Handler[request, response]) Chain[request, response]

func (Chain[request, response]) AddHandler 

func (c Chain[request, response]) AddHandler(h ...Handler[request, response]) Chain[request, response]

func (Chain[request, response]) Run 

func (c Chain[request, response]) Run(ctx *Context[request, response])

type CheckRequestFailedError 

type CheckRequestFailedError struct {
	Reason string
}

func NewCheckRequestFailedError 

func NewCheckRequestFailedError(reason string) CheckRequestFailedError

func (CheckRequestFailedError) Error 

func (e CheckRequestFailedError) Error() string

type CheckResponseFailedError 

type CheckResponseFailedError struct {
	Reason string
}

func NewCheckResponseFailedError 

func NewCheckResponseFailedError(reason string) CheckResponseFailedError

func (CheckResponseFailedError) Error 

func (e CheckResponseFailedError) Error() string

type Context 

type Context[request any, response any] struct {
	// contains filtered or unexported fields
}

func NewContext 

func NewContext[request any, response any](ctx context.Context, req request, resp response) *Context[request, response]

func (*Context[request, response]) Abort 

func (c *Context[request, response]) Abort()

func (*Context[request, response]) Deadline 

func (c *Context[request, response]) Deadline() (deadline time.Time, ok bool)

func (*Context[request, response]) Done 

func (c *Context[request, response]) Done() <-chan struct{}

func (*Context[request, response]) EntryGet 

func (c *Context[request, response]) EntryGet(key string, receiver any, marshaller Marshaller) (err error)

func (*Context[request, response]) EntrySet 

func (c *Context[request, response]) EntrySet(key string, payload any, marshaller Marshaller) (err error)

func (*Context[request, response]) Err 

func (c *Context[request, response]) Err() error

func (*Context[request, response]) Error 

func (c *Context[request, response]) Error() error

func (*Context[request, response]) FunctionGet 

func (c *Context[request, response]) FunctionGet(key string, fn func(val any))

func (*Context[request, response]) Get 

func (c *Context[request, response]) Get(key string) (value any, exists bool)

func (*Context[request, response]) GetBool 

func (c *Context[request, response]) GetBool(key string) (value bool, exists bool, isBool bool)

func (*Context[request, response]) GetContext 

func (c *Context[request, response]) GetContext() context.Context

func (*Context[request, response]) GetContextClientIP 

func (c *Context[request, response]) GetContextClientIP() (ip string, err error)

func (*Context[request, response]) GetFloat32 

func (c *Context[request, response]) GetFloat32(key string) (value float32, exists bool, isFloat32 bool)

func (*Context[request, response]) GetFloat64 

func (c *Context[request, response]) GetFloat64(key string) (value float64, exists bool, isFloat64 bool)

func (*Context[request, response]) GetInt 

func (c *Context[request, response]) GetInt(key string) (value int, exists bool, isInt bool)

func (*Context[request, response]) GetInt64 

func (c *Context[request, response]) GetInt64(key string) (value int64, exists bool, isInt64 bool)

func (*Context[request, response]) GetRequest 

func (c *Context[request, response]) GetRequest() request

func (*Context[request, response]) GetResponse 

func (c *Context[request, response]) GetResponse() response

func (*Context[request, response]) GetString 

func (c *Context[request, response]) GetString(key string) (value string, exists bool, isString bool)

func (*Context[request, response]) GetTime 

func (c *Context[request, response]) GetTime(key string) (value time.Time, exists bool, isTime bool)

func (*Context[request, response]) IsAborted 

func (c *Context[request, response]) IsAborted() bool

func (*Context[request, response]) MustGet 

func (c *Context[request, response]) MustGet(key string, defaultVal any) any

func (*Context[request, response]) MustGetBool 

func (c *Context[request, response]) MustGetBool(key string, defaultVal bool) bool

func (*Context[request, response]) MustGetFloat32 

func (c *Context[request, response]) MustGetFloat32(key string, defaultVal float32) float32

func (*Context[request, response]) MustGetFloat64 

func (c *Context[request, response]) MustGetFloat64(key string, defaultVal float64) float64

func (*Context[request, response]) MustGetInt 

func (c *Context[request, response]) MustGetInt(key string, defaultVal int) int

func (*Context[request, response]) MustGetInt64 

func (c *Context[request, response]) MustGetInt64(key string, defaultVal int64) int64

func (*Context[request, response]) MustGetString 

func (c *Context[request, response]) MustGetString(key string, defaultVal string) string

func (*Context[request, response]) MustGetTime 

func (c *Context[request, response]) MustGetTime(key string, defaultVal time.Time) time.Time

func (*Context[request, response]) Next 

func (c *Context[request, response]) Next()

func (*Context[request, response]) Set 

func (c *Context[request, response]) Set(key string, value any)

func (*Context[request, response]) SetContext 

func (c *Context[request, response]) SetContext(ctx context.Context)

func (*Context[request, response]) SetError 

func (c *Context[request, response]) SetError(err error)

func (*Context[request, response]) SetRequest 

func (c *Context[request, response]) SetRequest(req request)

func (*Context[request, response]) SetResponse 

func (c *Context[request, response]) SetResponse(resp response)

func (*Context[request, response]) SetResult 

func (c *Context[request, response]) SetResult(resp response, err error)

func (*Context[request, response]) TraceID 

func (c *Context[request, response]) TraceID() string

func (*Context[request, response]) Value 

func (c *Context[request, response]) Value(key any) any

type Engine 

type Engine struct {
	// contains filtered or unexported fields
}

func NewEngine 

func NewEngine() *Engine

func (*Engine) AddService 

func (e *Engine) AddService(services ...Service)

func (*Engine) Serve 

func (e *Engine) Serve(address string) (err error)

func (*Engine) ServeAsync 

func (e *Engine) ServeAsync(address string, ex chan struct{}) (exitChan chan error)

func (*Engine) Serving 

func (e *Engine) Serving() bool

type GetRPCClientIPFailedError 

type GetRPCClientIPFailedError struct{}

func NewGetRPCClientIPFailedError 

func NewGetRPCClientIPFailedError() GetRPCClientIPFailedError

func (GetRPCClientIPFailedError) Error 

func (e GetRPCClientIPFailedError) Error() string

type Handler 

type Handler[request any, response any] func(ctx *Context[request, response])

type InvalidIPAddressError 

type InvalidIPAddressError struct {
	IPAddress string
}

func NewInvalidIPAddressError 

func NewInvalidIPAddressError(ipAddress string) InvalidIPAddressError

func (InvalidIPAddressError) Error 

func (e InvalidIPAddressError) Error() string

type Marshaller 

type Marshaller interface {
	Marshal(request any) ([]byte, error)
	Unmarshal(data []byte, response any) error
}

func NewJsonMarshaller 

func NewJsonMarshaller() Marshaller

func NewYamlMarshaller 

func NewYamlMarshaller() Marshaller

type RequestLimiterError 

type RequestLimiterError struct {
	Reason string
}

func NewRequestLimiterError 

func NewRequestLimiterError(reason string) RequestLimiterError

func (RequestLimiterError) Error 

func (e RequestLimiterError) Error() string

type ServerAlreadyServingError 

type ServerAlreadyServingError struct {
	Address string
}

func NewServerAlreadyServingError 

func NewServerAlreadyServingError(address string) ServerAlreadyServingError

func (ServerAlreadyServingError) Error 

func (e ServerAlreadyServingError) Error() string

type Service 

type Service interface {
	Initialization()
	BindEngine(conn *grpc.Server)
}

type ServiceMetadata 

type ServiceMetadata struct {
	ServiceName string
}

type UnsupportedNetworkError 

type UnsupportedNetworkError struct {
	Network string
}

func NewUnsupportedNetworkError 

func NewUnsupportedNetworkError(network string) UnsupportedNetworkError

func (UnsupportedNetworkError) Error 

func (e UnsupportedNetworkError) Error() string

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.