handlers

Documentation

Index

• type DON
• type Handler
  • func NewDummyHandler(donConfig *config.DONConfig, don DON) (Handler, error)
  • func NewHandler(handlerType HandlerType, donConfig *config.DONConfig, don DON) (Handler, error)
• type HandlerType
• type RateLimiter
  • func NewRateLimiter(globalRPS float64, globalBurst int, perUserRPS float64, perUserBurst int) *RateLimiter
  • func (rl *RateLimiter) Allow(user string) bool
• type UserCallbackPayload

Types

type DON

type DON interface {
	// Thread-safe
	SendToNode(ctx context.Context, nodeAddress string, msg *api.Message) error
}

Representation of a DON from a Handler's perspective.

type Handler

type Handler interface {
	job.ServiceCtx

	// Each user request is processed by a separate goroutine, which:
	//   1. calls HandleUserMessage
	//   2. waits on callbackCh with a timeout
	HandleUserMessage(ctx context.Context, msg *api.Message, callbackCh chan<- UserCallbackPayload) error

	// Handlers should not make any assumptions about goroutines calling HandleNodeMessage
	HandleNodeMessage(ctx context.Context, msg *api.Message, nodeAddr string) error
}

func NewDummyHandler

func NewDummyHandler(donConfig *config.DONConfig, don DON) (Handler, error)

func NewHandler

func NewHandler(handlerType HandlerType, donConfig *config.DONConfig, don DON) (Handler, error)

type HandlerType

type HandlerType = string

const (
	Dummy HandlerType = "dummy"
)

type RateLimiter

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

func NewRateLimiter

func NewRateLimiter(globalRPS float64, globalBurst int, perUserRPS float64, perUserBurst int) *RateLimiter

func (*RateLimiter) Allow

func (rl *RateLimiter) Allow(user string) bool

type UserCallbackPayload

type UserCallbackPayload struct {
	Msg     *api.Message
	ErrCode api.ErrorCode
	ErrMsg  string
}

UserCallbackPayload is a response to user request sent to HandleUserMessage(). Each message needs to receive at most one response on the provided channel.