summaryrefslogtreecommitdiff
path: root/pkg/worker_watcher/interface.go
blob: 927aa27063325363f8abac765c70e22e3e3211f2 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
package worker_watcher //nolint:golint,stylecheck

import (
	"context"

	"github.com/spiral/roadrunner/v2/pkg/worker"
)

type Watcher interface {
	// AddToWatch used to add stack to wait its state
	AddToWatch(workers []worker.SyncWorker) error

	// GetFreeWorker provide first free worker
	GetFreeWorker(ctx context.Context) (worker.SyncWorker, error)

	// PutWorker enqueues worker back
	PushWorker(w worker.SyncWorker)

	// AllocateNew used to allocate new worker and put in into the WorkerWatcher
	AllocateNew() error

	// Destroy destroys the underlying stack
	Destroy(ctx context.Context)

	// WorkersList return all stack w/o removing it from internal storage
	WorkersList() []worker.SyncWorker

	// RemoveWorker remove worker from the stack
	RemoveWorker(wb worker.SyncWorker) error
}