gxsync

Documentation

Index

• Variables
• type ConnectionPool
  • func (p ConnectionPool) Close()
  • func (p ConnectionPool) IsClosed() bool
  • func (p ConnectionPool) NumWorkers() int32
  • func (p *ConnectionPool) Submit(t task) error
  • func (p *ConnectionPool) SubmitSync(t task) error
• type GenericTaskPool
  • func NewTaskPool(opts ...TaskPoolOption) GenericTaskPool
  • func NewTaskPoolSimple(size int) GenericTaskPool
• type TaskPool
  • func (p *TaskPool) AddTask(t task) (ok bool)
  • func (p *TaskPool) AddTaskAlways(t task)
  • func (p *TaskPool) AddTaskBalance(t task)
  • func (p *TaskPool) Close()
  • func (p *TaskPool) IsClosed() bool
• type TaskPoolOption
  • func WithTaskPoolTaskPoolSize(size int) TaskPoolOption
  • func WithTaskPoolTaskQueueLength(length int) TaskPoolOption
  • func WithTaskPoolTaskQueueNumber(number int) TaskPoolOption
• type TaskPoolOptions
• type WorkerPool
  • func NewConnectionPool(config WorkerPoolConfig) WorkerPool
• type WorkerPoolConfig

Variables

var (
	PoolBusyErr = perrors.New("pool is busy")
)

Types

type ConnectionPool

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

func (ConnectionPool) Close

func (p ConnectionPool) Close()

func (ConnectionPool) IsClosed

func (p ConnectionPool) IsClosed() bool

func (ConnectionPool) NumWorkers

func (p ConnectionPool) NumWorkers() int32

func (*ConnectionPool) Submit

func (p *ConnectionPool) Submit(t task) error

func (*ConnectionPool) SubmitSync

func (p *ConnectionPool) SubmitSync(t task) error

type GenericTaskPool

type GenericTaskPool interface {
	// AddTask wait idle worker add task
	AddTask(t task) bool
	// AddTaskAlways add task to queues or do it immediately
	AddTaskAlways(t task)
	// AddTaskBalance add task to idle queue
	AddTaskBalance(t task)
	// Close use to close the task pool
	Close()
	// IsClosed use to check pool status.
	IsClosed() bool
}

GenericTaskPool represents an generic task pool.

func NewTaskPool

func NewTaskPool(opts ...TaskPoolOption) GenericTaskPool

NewTaskPool build a task pool

func NewTaskPoolSimple

func NewTaskPoolSimple(size int) GenericTaskPool

NewTaskPoolSimple build a simple task pool

type TaskPool

type TaskPool struct {
	TaskPoolOptions
	// contains filtered or unexported fields
}

/////////////////////////////////////// Task Pool /////////////////////////////////////// task pool: manage task ts

func (*TaskPool) AddTask

func (p *TaskPool) AddTask(t task) (ok bool)

return false when the pool is stop

func (*TaskPool) AddTaskAlways

func (p *TaskPool) AddTaskAlways(t task)

func (*TaskPool) AddTaskBalance

func (p *TaskPool) AddTaskBalance(t task)

do it immediately when no idle queue

func (*TaskPool) Close

func (p *TaskPool) Close()

func (*TaskPool) IsClosed

func (p *TaskPool) IsClosed() bool

check whether the session has been closed.

type TaskPoolOption

type TaskPoolOption func(*TaskPoolOptions)

func WithTaskPoolTaskPoolSize

func WithTaskPoolTaskPoolSize(size int) TaskPoolOption

WithTaskPoolTaskPoolSize set @size of the task queue pool size

func WithTaskPoolTaskQueueLength

func WithTaskPoolTaskQueueLength(length int) TaskPoolOption

WithTaskPoolTaskQueueLength set @length of the task queue length

func WithTaskPoolTaskQueueNumber

func WithTaskPoolTaskQueueNumber(number int) TaskPoolOption

WithTaskPoolTaskQueueNumber set @number of the task queue number

type TaskPoolOptions

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

TaskPoolOptions is optional settings for task pool

type WorkerPool

type WorkerPool interface {
	// Submit adds a task to queue asynchronously.
	Submit(task) error
	// SubmitSync adds a task to queue synchronously.
	SubmitSync(task) error
	// Close closes the worker pool
	Close()
	// IsClosed returns close status of the worker pool
	IsClosed() bool
	// NumWorkers returns the number of workers
	NumWorkers() int32
}

func NewConnectionPool

func NewConnectionPool(config WorkerPoolConfig) WorkerPool

type WorkerPoolConfig

type WorkerPoolConfig struct {
	NumWorkers int
	NumQueues  int
	QueueSize  int
	Logger     gxlog.Logger
}