pipeline

Documentation

Index

• Constants
• type DriverFactory
  • func NewDriverFactory[T any](natsConn *nats.Conn) DriverFactory[T]
  • func (df DriverFactory[T]) NewDriver(channelName string) WorkerDriver[T]
• type Enqueuer
• type InMemoryQueueDriver
  • func NewInMemoryQueueDriver[T any](name string) *InMemoryQueueDriver[T]
  • func (qd InMemoryQueueDriver[T]) Enqueue(item T)
  • func (qd *InMemoryQueueDriver[T]) SetListener(l Listener[T])
  • func (qd InMemoryQueueDriver[T]) Start()
  • func (qd InMemoryQueueDriver[T]) Stop()
• type InputQueueSetter
• type Listener
• type NatsDriver
  • func NewNatsDriver[T any](conn *nats.Conn, topic string) *NatsDriver[T]
  • func (d *NatsDriver[T]) Enqueue(msg T)
  • func (d *NatsDriver[T]) SetListener(listener Listener[T])
  • func (d *NatsDriver[T]) Start()
  • func (d *NatsDriver[T]) Stop()
• type Pipeline
  • func New[T any](cfg queueConfigurer[T], steps ...Step[T]) *Pipeline[T]
  • func (p *Pipeline[T]) Begin(ctx context.Context, item T)
  • func (p *Pipeline[T]) GetQueueForStep(i int) *Queue[T]
  • func (p *Pipeline[T]) Start()
  • func (p *Pipeline[T]) Stop()
• type Queue
  • func NewQueue[T any](driver QueueDriver[T], itemProcessor QueueItemProcessor[T]) *Queue[T]
  • func (q Queue[T]) Enqueue(ctx context.Context, item T)
  • func (q *Queue[T]) InitializeMetrics(meter metric.Meter)
  • func (q Queue[T]) Listen(item T)
  • func (q *Queue[T]) SetDriver(driver QueueDriver[T])
  • func (q *Queue[T]) Stop()
• type QueueDriver
• type QueueItemProcessor
• type Step
• type StepProcessor
• type WorkerDriver

Constants

const (
	QueueWorkerCount      = 20
	QueueWorkerBufferSize = QueueWorkerCount * 1_000 // 1k jobs per worker
)

Types

type DriverFactory

type DriverFactory[T any] struct {
	// contains filtered or unexported fields
}

func NewDriverFactory

func NewDriverFactory[T any](natsConn *nats.Conn) DriverFactory[T]

func (DriverFactory[T]) NewDriver

func (df DriverFactory[T]) NewDriver(channelName string) WorkerDriver[T]

type Enqueuer

type Enqueuer[T any] interface {
	Enqueue(context.Context, T)
}

type InMemoryQueueDriver

type InMemoryQueueDriver[T any] struct {
	// contains filtered or unexported fields
}

func NewInMemoryQueueDriver

func NewInMemoryQueueDriver[T any](name string) *InMemoryQueueDriver[T]

func (InMemoryQueueDriver[T]) Enqueue

func (qd InMemoryQueueDriver[T]) Enqueue(item T)

func (*InMemoryQueueDriver[T]) SetListener

func (qd *InMemoryQueueDriver[T]) SetListener(l Listener[T])

func (InMemoryQueueDriver[T]) Start

func (qd InMemoryQueueDriver[T]) Start()

func (InMemoryQueueDriver[T]) Stop

func (qd InMemoryQueueDriver[T]) Stop()

type InputQueueSetter

type InputQueueSetter[T any] interface {
	SetInputQueue(Enqueuer[T])
}

type Listener

type Listener[T any] interface {
	Listen(T)
}

type NatsDriver

type NatsDriver[T any] struct {
	// contains filtered or unexported fields
}

func NewNatsDriver

func NewNatsDriver[T any](conn *nats.Conn, topic string) *NatsDriver[T]

func (*NatsDriver[T]) Enqueue

func (d *NatsDriver[T]) Enqueue(msg T)

func (*NatsDriver[T]) SetListener

func (d *NatsDriver[T]) SetListener(listener Listener[T])

SetListener implements QueueDriver.

func (*NatsDriver[T]) Start

func (d *NatsDriver[T]) Start()

func (*NatsDriver[T]) Stop

func (d *NatsDriver[T]) Stop()

type Pipeline

type Pipeline[T any] struct {
	// contains filtered or unexported fields
}

func New

func New[T any](cfg queueConfigurer[T], steps ...Step[T]) *Pipeline[T]

func (*Pipeline[T]) Begin

func (p *Pipeline[T]) Begin(ctx context.Context, item T)

func (*Pipeline[T]) GetQueueForStep

func (p *Pipeline[T]) GetQueueForStep(i int) *Queue[T]

func (*Pipeline[T]) Start

func (p *Pipeline[T]) Start()

func (*Pipeline[T]) Stop

func (p *Pipeline[T]) Stop()

type Queue

type Queue[T any] struct {
	EnqueuePreprocessorFn func(context.Context, T) T
	ListenPreprocessorFn  func(context.Context, T) (context.Context, T)
	// contains filtered or unexported fields
}

func NewQueue

func NewQueue[T any](driver QueueDriver[T], itemProcessor QueueItemProcessor[T]) *Queue[T]

func (Queue[T]) Enqueue

func (q Queue[T]) Enqueue(ctx context.Context, item T)

func (*Queue[T]) InitializeMetrics

func (q *Queue[T]) InitializeMetrics(meter metric.Meter)

func (Queue[T]) Listen

func (q Queue[T]) Listen(item T)

func (*Queue[T]) SetDriver

func (q *Queue[T]) SetDriver(driver QueueDriver[T])

func (*Queue[T]) Stop

func (q *Queue[T]) Stop()

type QueueDriver

type QueueDriver[T any] interface {
	Enqueue(T)
	SetListener(Listener[T])
}

type QueueItemProcessor

type QueueItemProcessor[T any] interface {
	ProcessItem(context.Context, T)
}

type Step

type Step[T any] struct {
	Driver           WorkerDriver[T]
	Processor        StepProcessor[T]
	InputQueueOffset int
}

type StepProcessor

type StepProcessor[T any] interface {
	QueueItemProcessor[T]
	SetOutputQueue(Enqueuer[T])
}

type WorkerDriver

type WorkerDriver[T any] interface {
	QueueDriver[T]
	Start()
	Stop()
}