semaphore

Documentation

Index

• func ConfigAdd(path string)
• func Register(ctx context.Context, server *echo.Server) error
• type Options
  • func NewOptions() (*Options, error)
  • func NewOptionsWithPath(path string) (opts *Options, err error)
• type Semaphore
  • func NewSemaphore() *Semaphore
  • func NewSemaphoreWithConfigPath(path string) (*Semaphore, error)
  • func NewSemaphoreWithOptions(options *Options) *Semaphore
  • func (i *Semaphore) Register(ctx context.Context, server *echo.Server) error

Functions

func ConfigAdd

func ConfigAdd(path string)

func Register

func Register(ctx context.Context, server *echo.Server) error

Register registers a new semaphore plugin for echo server.

Types

type Options

type Options struct {
	Enabled bool
	Limit   int64
}

Options semaphore plugin for echo server options.

func NewOptions

func NewOptions() (*Options, error)

NewOptions returns options from config file or environment vars.

func NewOptionsWithPath

func NewOptionsWithPath(path string) (opts *Options, err error)

NewOptionsWithPath unmarshals a given key path into options and returns it.

type Semaphore

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

Semaphore represents semaphore plugin for echo server.

func NewSemaphore

func NewSemaphore() *Semaphore

NewSemaphore returns a new semaphore plugin with default options.

func NewSemaphoreWithConfigPath

func NewSemaphoreWithConfigPath(path string) (*Semaphore, error)

NewSemaphoreWithConfigPath returns a new semaphore plugin with options from config path.

func NewSemaphoreWithOptions

func NewSemaphoreWithOptions(options *Options) *Semaphore

NewSemaphoreWithOptions returns a new semaphore plugin with options.

func (*Semaphore) Register

func (i *Semaphore) Register(ctx context.Context, server *echo.Server) error

Register registers this semaphore plugin for echo server.