provider

Documentation

Index

• Constants
• Variables
• func NewCustomJSONProvider(wrapDecoder func(deps core.ProviderDeps, decoder AmmoDecoder) AmmoDecoder, ...) core.Provider
• func NewJSONProvider(newAmmo func() core.Ammo, conf JSONProviderConfig) core.Provider
• func NewNum(limit int) core.Provider
• func NewNumBuffered(limit int) core.Provider
• func NewNumConf(conf NumConfig) core.Provider
• type AmmoDecoder
  • func NewJSONAmmoDecoder(r io.Reader, buffSize int) AmmoDecoder
• type AmmoDecoderFunc
  • func (f AmmoDecoderFunc) Decode(ammo core.Ammo) error
• type AmmoQueue
  • func NewAmmoQueue(newAmmo func() core.Ammo, conf AmmoQueueConfig) *AmmoQueue
  • func (p *AmmoQueue) Acquire() (core.Ammo, bool)
  • func (p *AmmoQueue) Release(a core.Ammo)
• type AmmoQueueConfig
  • func DefaultAmmoQueueConfig() AmmoQueueConfig
• type ChunkAmmoDecoder
• type DecodeProvider
  • func NewDecodeProvider(newAmmo func() core.Ammo, newDecoder NewAmmoDecoder, conf DecodeProviderConfig) *DecodeProvider
  • func (p *DecodeProvider) Run(ctx context.Context, deps core.ProviderDeps) (err error)
• type DecodeProviderConfig
  • func DefaultDecodeProviderConfig() DecodeProviderConfig
• type Dummy
  • func (d Dummy) Acquire() (ammo core.Ammo, ok bool)
  • func (d Dummy) Release(core.Ammo)
  • func (d Dummy) Run(context.Context, core.ProviderDeps) error
• type JSONAmmoDecoder
  • func (d *JSONAmmoDecoder) Decode(ammo core.Ammo) error
• type JSONProviderConfig
  • func DefaultJSONProviderConfig() JSONProviderConfig
• type NewAmmoDecoder
• type NumConfig
• type ScanAmmoDecoder
  • func NewScanDecoder(scanner Scanner, decoder ChunkAmmoDecoder) *ScanAmmoDecoder
  • func (d *ScanAmmoDecoder) Decode(ammo core.Ammo) error
• type Scanner

Constants

const (
	DefaultAmmoQueueSize = shootsPerSecondUpperBound / 16
)

Variables

var ErrNoAmmoDecoded = fmt.Errorf("no ammo has been decoded from chunk")

Functions

func NewCustomJSONProvider

func NewCustomJSONProvider(wrapDecoder func(deps core.ProviderDeps, decoder AmmoDecoder) AmmoDecoder, newAmmo func() core.Ammo, conf JSONProviderConfig) core.Provider

NewCustomJSONProvider is like NewJSONProvider, but also allows to wrap JSON decoder, to decode data into intermediate struct, but then transform in into desired ammo. For example, decode {"body":"some data"} into struct { Data string }, and transform it to http.Request.

func NewJSONProvider

func NewJSONProvider(newAmmo func() core.Ammo, conf JSONProviderConfig) core.Provider

NewJSONProvider returns generic core.Provider that reads JSON data from source and decodes it into ammo returned from newAmmo.

func NewNum

func NewNum(limit int) core.Provider

NewNum returns dummy provider, that provides 0, 1 .. n int sequence as ammo. May be useful for test or in when Gun don't need ammo.

func NewNumBuffered

func NewNumBuffered(limit int) core.Provider

func NewNumConf

func NewNumConf(conf NumConfig) core.Provider

Types

type AmmoDecoder

type AmmoDecoder interface {
	// Decode fills passed ammo with data.
	// Returns non nil error on fail.
	// Panics if ammo type is not supported.
	Decode(ammo core.Ammo) error
}

AmmoEncoder MAY support only concrete type of ammo. AmmoDecoder SHOULD NOT be used after first decode fail.

func NewJSONAmmoDecoder

func NewJSONAmmoDecoder(r io.Reader, buffSize int) AmmoDecoder

type AmmoDecoderFunc

type AmmoDecoderFunc func(ammo core.Ammo) error

func (AmmoDecoderFunc) Decode

func (f AmmoDecoderFunc) Decode(ammo core.Ammo) error

type AmmoQueue

type AmmoQueue struct {
	OutQueue  chan core.Ammo
	InputPool sync.Pool
}

func NewAmmoQueue

func NewAmmoQueue(newAmmo func() core.Ammo, conf AmmoQueueConfig) *AmmoQueue

func (*AmmoQueue) Acquire

func (p *AmmoQueue) Acquire() (core.Ammo, bool)

func (*AmmoQueue) Release

func (p *AmmoQueue) Release(a core.Ammo)

type AmmoQueueConfig

type AmmoQueueConfig struct {
	// AmmoQueueSize is number maximum number of ready but not acquired ammo.
	// On queue overflow, ammo decode is stopped.
	AmmoQueueSize int `config:"ammo-queue-size" validate:"min=1"`
}

func DefaultAmmoQueueConfig

func DefaultAmmoQueueConfig() AmmoQueueConfig

type ChunkAmmoDecoder

type ChunkAmmoDecoder interface {
	// DecodeChunk accepts chunk of data, than decode it to ammo or change ChunkAmmoDecoder internal
	// state.
	// Returns nil on when ammo was successfully decoded.
	// ErrNoAmmoDecoded MAY be returned, to indicate that chunk was accepted, but ammo were not
	// decoded.
	// Returns other non nil error, on chunk decode fail.
	// Panics if ammo type is not supported.
	DecodeChunk(chunk []byte, ammo core.Ammo) error
}

ChunkAmmoDecoder accept data chunks that can contain encoded ammo or some meta information that changes ChunkAmmoDecoder state and affects next ammo decoding. For example, chunks are lines that contains HTTP URI to be transformed to http.Request or HTTP header to be added to next decoded http.Requests.

type DecodeProvider

type DecodeProvider struct {
	AmmoQueue

	core.ProviderDeps
	// contains filtered or unexported fields
}

func NewDecodeProvider

func NewDecodeProvider(newAmmo func() core.Ammo, newDecoder NewAmmoDecoder, conf DecodeProviderConfig) *DecodeProvider

func (*DecodeProvider) Run

func (p *DecodeProvider) Run(ctx context.Context, deps core.ProviderDeps) (err error)

type DecodeProviderConfig

type DecodeProviderConfig struct {
	Queue  AmmoQueueConfig `config:",squash"`
	Source core.DataSource `config:"source" validate:"required"`
	// Limit limits total num of ammo. Unlimited if zero.
	Limit int `validate:"min=0"`
	// Passes limits ammo file passes. Unlimited if zero.
	Passes int `validate:"min=0"`
}

func DefaultDecodeProviderConfig

func DefaultDecodeProviderConfig() DecodeProviderConfig

type Dummy

type Dummy struct {
}

func (Dummy) Acquire

func (d Dummy) Acquire() (ammo core.Ammo, ok bool)

func (Dummy) Release

func (d Dummy) Release(core.Ammo)

func (Dummy) Run

func (d Dummy) Run(context.Context, core.ProviderDeps) error

type JSONAmmoDecoder

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

func (*JSONAmmoDecoder) Decode

func (d *JSONAmmoDecoder) Decode(ammo core.Ammo) error

type JSONProviderConfig

type JSONProviderConfig struct {
	Decode DecodeProviderConfig      `config:",squash"`
	Buffer coreutil.BufferSizeConfig `config:",squash"`
}

func DefaultJSONProviderConfig

func DefaultJSONProviderConfig() JSONProviderConfig

type NewAmmoDecoder

type NewAmmoDecoder func(deps core.ProviderDeps, source io.Reader) (AmmoDecoder, error)

type NumConfig

type NumConfig struct {
	Limit int
}

type ScanAmmoDecoder

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

func NewScanDecoder

func NewScanDecoder(scanner Scanner, decoder ChunkAmmoDecoder) *ScanAmmoDecoder

func (*ScanAmmoDecoder) Decode

func (d *ScanAmmoDecoder) Decode(ammo core.Ammo) error

type Scanner

type Scanner interface {
	Scan() bool
	Bytes() []byte
	Err() error
}

Scanner is interface of bufio.Scanner like scanners.