pool

Documentation

Overview

Copyright © 2020 Marvin

Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at

http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.

Copyright © 2020 Marvin

Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at

http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.

Copyright © 2020 Marvin

Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at

http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.

Index

• type IPool
  • func NewPool(maxWorkers int, opts ...Option) IPool
• type Option
  • func WithExecuteTask(taskFn func(t Task) error) Option
  • func WithExecuteTimeout(timeout time.Duration) Option
  • func WithLock(lock sync.Locker) Option
  • func WithResultCallback(callback func(r Result)) Option
  • func WithRetryCount(retryCount int) Option
  • func WithTaskQueueSize(size int) Option
• type Result
• type Task

Types

type IPool

type IPool interface {
	// AddTask adds a task to the pool
	AddTask(t Task)
	// Wait waits for all tasks to be dispatched and completed.
	Wait()
	// Release releases the pool and all its workers.
	Release()
	// RunningWorkerCount returns the number of running workers.
	RunningWorkerCount() int
	// GetPoolWorkerCount returns the number of workers.
	GetPoolWorkerCount() int
}

func NewPool

func NewPool(maxWorkers int, opts ...Option) IPool

NewPool creates a new pool of workers.

type Option

type Option func(*pool)

Option represents an option for the pool.

func WithExecuteTask

func WithExecuteTask(taskFn func(t Task) error) Option

WithExecuteTask sets the task func for the pool.

func WithExecuteTimeout

func WithExecuteTimeout(timeout time.Duration) Option

WithExecuteTimeout sets the timeout for the pool.

func WithLock

func WithLock(lock sync.Locker) Option

WithLock sets the lock for the pool.

func WithResultCallback

func WithResultCallback(callback func(r Result)) Option

WithResultCallback sets the result callback for the pool.

func WithRetryCount

func WithRetryCount(retryCount int) Option

WithRetryCount sets the retry count for the pool.

func WithTaskQueueSize

func WithTaskQueueSize(size int) Option

WithTaskQueueSize sets the size of the task queue for the pool.

type Result

type Result struct {
	Task     Task
	WorkerID int
	Err      error
}

type Task

type Task struct {
	Attr  string
	Stage string
	Job   interface{}
}