handlers

Documentation

Index

• Constants
• func Serve(ctx context.Context, handler CustomHandler) error
• type Config
  • func LoadConfigFromPath(configPath string) (*Config, error)
• type CustomHandler
• type Handler
• type HandlerContext
  • func NewHandlerContext(scalingJobID string, sender ResponseSender) *HandlerContext
  • func (c *HandlerContext) Deadline() (deadline time.Time, ok bool)
  • func (c *HandlerContext) Done() <-chan struct{}
  • func (c *HandlerContext) Err() error
  • func (c *HandlerContext) Report(status handler.HandleResponse_Status, formatAndArgs ...interface{}) error
  • func (c *HandlerContext) Value(key interface{}) interface{}
• type HandlerLogger
  • func (l *HandlerLogger) GetLogger() *log.Logger
  • func (l *HandlerLogger) SetLogger(logger *log.Logger)
• type HandlerMeta
• type Listener
• type Logger
• type PostHandler
• type PreHandler
• type ResponseSender

Constants

const (
	HandlerTypePreHandle  = "pre-handle"
	HandlerTypeHandle     = "handle"
	HandlerTypePostHandle = "post-handle"
)

Functions

func Serve

func Serve(ctx context.Context, handler CustomHandler) error

Serve 指定のハンドラでgRPCサーバをスタート/リッスンする

Types

type Config

type Config struct {
	ExporterConfig *config.ExporterConfig `yaml:"exporter_config"`
}

Config .

func LoadConfigFromPath

func LoadConfigFromPath(configPath string) (*Config, error)

LoadConfigFromPath ファイルパスからConfigを読み込む

type CustomHandler

type CustomHandler interface {
	HandlerMeta
	Listener
}

CustomHandler カスタムハンドラーが実装すべきインターフェース

type Handler

type Handler interface {
	Handle(*handler.HandleRequest, ResponseSender) error
}

Handler CoreからのHandleリクエストを処理するためのインターフェース

type HandlerContext

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

func NewHandlerContext

func NewHandlerContext(scalingJobID string, sender ResponseSender) *HandlerContext

func (*HandlerContext) Deadline

func (c *HandlerContext) Deadline() (deadline time.Time, ok bool)

func (*HandlerContext) Done

func (c *HandlerContext) Done() <-chan struct{}

func (*HandlerContext) Err

func (c *HandlerContext) Err() error

func (*HandlerContext) Report

func (c *HandlerContext) Report(status handler.HandleResponse_Status, formatAndArgs ...interface{}) error

func (*HandlerContext) Value

func (c *HandlerContext) Value(key interface{}) interface{}

type HandlerLogger

type HandlerLogger struct {
	Logger *log.Logger
}

func (*HandlerLogger) GetLogger

func (l *HandlerLogger) GetLogger() *log.Logger

func (*HandlerLogger) SetLogger

func (l *HandlerLogger) SetLogger(logger *log.Logger)

type HandlerMeta

type HandlerMeta interface {
	// Name プレフィックスなしの短い名前を返す
	Name() string
	// Version バージョン情報を返す
	Version() string

	Logger
}

HandlerMeta ハンドラーのメタ情報

ビルトイン/カスタム問わず全てのハンドラーが実装すべきインターフェース

type Listener

type Listener interface {
	ListenAddress() string
	ConfigPath() string
}

Listener gRPCサーバとしてリッスンするためのインターフェース

type Logger

type Logger interface {
	GetLogger() *log.Logger
	SetLogger(logger *log.Logger)
}

Logger ログ出力のためのインターフェース

type PostHandler

type PostHandler interface {
	PostHandle(*handler.PostHandleRequest, ResponseSender) error
}

PostHandler CoreからのPostHandleリクエストを処理するためのインターフェース

type PreHandler

type PreHandler interface {
	PreHandle(*handler.HandleRequest, ResponseSender) error
}

PreHandler CoreからのPreHandleリクエストを処理するためのインターフェース

type ResponseSender

type ResponseSender interface {
	Send(*handler.HandleResponse) error
}

ResponseSender gRPCのサーバストリームのレスポンスをラップするインターフェース