task

Documentation

Overview

*Copyright (c) 2022, kaydxh * *Permission is hereby granted, free of charge, to any person obtaining a copy *of this software and associated documentation files (the "Software"), to deal *in the Software without restriction, including without limitation the rights *to use, copy, modify, merge, publish, distribute, sublicense, and/or sell *copies of the Software, and to permit persons to whom the Software is *furnished to do so, subject to the following conditions: * *The above copyright notice and this permission notice shall be included in all *copies or substantial portions of the Software. * *THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR *IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, *FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE *AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER *LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, *OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE *SOFTWARE.

*Copyright (c) 2022, kaydxh * *Permission is hereby granted, free of charge, to any person obtaining a copy *of this software and associated documentation files (the "Software"), to deal *in the Software without restriction, including without limitation the rights *to use, copy, modify, merge, publish, distribute, sublicense, and/or sell *copies of the Software, and to permit persons to whom the Software is *furnished to do so, subject to the following conditions: * *The above copyright notice and this permission notice shall be included in all *copies or substantial portions of the Software. * *THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR *IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, *FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE *AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER *LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, *OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE *SOFTWARE.

*Copyright (c) 2022, kaydxh * *Permission is hereby granted, free of charge, to any person obtaining a copy *of this software and associated documentation files (the "Software"), to deal *in the Software without restriction, including without limitation the rights *to use, copy, modify, merge, publish, distribute, sublicense, and/or sell *copies of the Software, and to permit persons to whom the Software is *furnished to do so, subject to the following conditions: * *The above copyright notice and this permission notice shall be included in all *copies or substantial portions of the Software. * *THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR *IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, *FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE *AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER *LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, *OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE *SOFTWARE.

*Copyright (c) 2022, kaydxh * *Permission is hereby granted, free of charge, to any person obtaining a copy *of this software and associated documentation files (the "Software"), to deal *in the Software without restriction, including without limitation the rights *to use, copy, modify, merge, publish, distribute, sublicense, and/or sell *copies of the Software, and to permit persons to whom the Software is *furnished to do so, subject to the following conditions: * *The above copyright notice and this permission notice shall be included in all *copies or substantial portions of the Software. * *THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR *IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, *FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE *AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER *LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, *OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE *SOFTWARE.

Index

• func BatchProcess[T any](data []T, batchSize int, f func(d []T) error) error
• type EmptyPoolOptions
• type Pool
  • func New(taskFunc TaskHandler, opts ...PoolOptions) *Pool
  • func (o *Pool) ApplyOptions(options ...PoolOptions) *Pool
  • func (p *Pool) Error() error
  • func (p *Pool) Put(task interface{}) error
  • func (p *Pool) Stop()
  • func (p *Pool) Wait()
• type PoolConfig
• type PoolOptions
  • func WithBurst(burst int) PoolOptions
  • func WithErrStop(errStop bool) PoolOptions
• type PoolOptionsFunc
• type TaskHandler
• type WorkFunc
• type Worker
  • func (w *Worker) Error() error
  • func (w *Worker) Stop()
  • func (w *Worker) TrySetError(err error)
  • func (w *Worker) Wait()
  • func (w *Worker) Work(ctx context.Context, workChan <-chan interface{}, workFn WorkFunc, ...) (doneC <-chan struct{})

Functions

func BatchProcess

func BatchProcess[T any](data []T, batchSize int, f func(d []T) error) error

Types

type EmptyPoolOptions

type EmptyPoolOptions struct{}

EmptyPoolUrlOption does not alter the Pooluration. It can be embedded in another structure to build custom options.

This API is EXPERIMENTAL.

type Pool

type Pool struct {
	TaskFunc TaskHandler
	// contains filtered or unexported fields
}

func New

func New(taskFunc TaskHandler, opts ...PoolOptions) *Pool

func (*Pool) ApplyOptions

func (o *Pool) ApplyOptions(options ...PoolOptions) *Pool

func (*Pool) Error

func (p *Pool) Error() error

func (*Pool) Put

func (p *Pool) Put(task interface{}) error

func (*Pool) Stop

func (p *Pool) Stop()

func (*Pool) Wait

func (p *Pool) Wait()

type PoolConfig

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

type PoolOptions

type PoolOptions interface {
	// contains filtered or unexported methods
}

A PoolOptions sets options.

func WithBurst

func WithBurst(burst int) PoolOptions

func WithErrStop

func WithErrStop(errStop bool) PoolOptions

type PoolOptionsFunc

type PoolOptionsFunc func(*Pool)

PoolOptionsFunc wraps a function that modifies Pool into an implementation of the PoolOptions interface.

type TaskHandler

type TaskHandler func(task interface{}) error

type WorkFunc

type WorkFunc func(work interface{}) error

type Worker

type Worker struct {
	Burst int32
	// contains filtered or unexported fields
}

func (*Worker) Error

func (w *Worker) Error() error

func (*Worker) Stop

func (w *Worker) Stop()

func (*Worker) TrySetError

func (w *Worker) TrySetError(err error)

func (*Worker) Wait

func (w *Worker) Wait()

func (*Worker) Work

func (w *Worker) Work(
	ctx context.Context,
	workChan <-chan interface{},
	workFn WorkFunc,
	errStop bool,
) (doneC <-chan struct{})