api

Documentation

Index

• func NewQueueHandler(sc *securecookie.SecureCookie, redisC *redis.Client, ...) *queueHandler
• func NewWhiteListHandler(redisC *redis.Client) *whiteListHandler
• func VironEndpoints(g *echo.Group)
• func VironWhiteListEndpoints(g *echo.Group, redisC *redis.Client)
• type Error
  • func (err *Error) Error() string
  • func (err *Error) Unwrap() error
• type HTTPError
• type QueueResult

Functions

func NewQueueHandler

func NewQueueHandler(
	sc *securecookie.SecureCookie,
	redisC *redis.Client,
	config *waitingroom.Config,
	cache *waitingroom.Cache,
) *queueHandler

func NewWhiteListHandler

func NewWhiteListHandler(redisC *redis.Client) *whiteListHandler

func VironEndpoints

func VironEndpoints(g *echo.Group)

func VironWhiteListEndpoints

func VironWhiteListEndpoints(g *echo.Group, redisC *redis.Client)

Types

type Error

type Error struct {
	StatusCode int
	Message    string
	RawErr     error
}

Error Apiのエラーを定義する構造体

func (*Error) Error

func (err *Error) Error() string

Error Errorインターフェースの必須定義メソッド

func (*Error) Unwrap

func (err *Error) Unwrap() error

type HTTPError

type HTTPError struct {
	Code     int         `json:"-"`
	Message  interface{} `json:"message"`
	Internal error       `json:"-"` // Stores the error returned by an external dependency
}

type QueueResult

type QueueResult struct {
	ID                  string
	Enabled             bool  `json:"enabled"`
	PermittedClient     bool  `json:"permitted_client"`
	SerialNo            int64 `json:"serial_no"`
	PermittedNo         int64 `json:"permitted_no"`
	RemainingWaitSecond int64 `json:"remaining_wait_second"`
}