riverpilot

Documentation

Index

• type Pilot
• type ProducerInitParams
• type ProducerShutdownParams
• type ProducerState
• type QueueMetadataChangedParams
• type StandardPilot
  • func (p *StandardPilot) JobGetAvailable(ctx context.Context, exec riverdriver.Executor, state ProducerState, ...) ([]*rivertype.JobRow, error)
  • func (p *StandardPilot) JobInsertMany(ctx context.Context, tx riverdriver.ExecutorTx, ...) ([]*riverdriver.JobInsertFastResult, error)
  • func (p *StandardPilot) JobSetStateIfRunningMany(ctx context.Context, tx riverdriver.ExecutorTx, ...) ([]*rivertype.JobRow, error)
  • func (p *StandardPilot) PilotInit(archetype *baseservice.Archetype)
  • func (p *StandardPilot) ProducerInit(ctx context.Context, exec riverdriver.Executor, params *ProducerInitParams) (int64, ProducerState, error)
  • func (p *StandardPilot) ProducerKeepAlive(ctx context.Context, exec riverdriver.Executor, ...) error
  • func (p *StandardPilot) ProducerShutdown(ctx context.Context, exec riverdriver.Executor, params *ProducerShutdownParams) error
  • func (p *StandardPilot) QueueMetadataChanged(ctx context.Context, exec riverdriver.Executor, ...) error

Types

type Pilot

type Pilot interface {
	JobGetAvailable(
		ctx context.Context,
		exec riverdriver.Executor,
		state ProducerState,
		params *riverdriver.JobGetAvailableParams,
	) ([]*rivertype.JobRow, error)

	JobInsertMany(
		ctx context.Context,
		tx riverdriver.ExecutorTx,
		params *riverdriver.JobInsertFastManyParams,
	) ([]*riverdriver.JobInsertFastResult, error)

	JobSetStateIfRunningMany(ctx context.Context, tx riverdriver.ExecutorTx, params *riverdriver.JobSetStateIfRunningManyParams) ([]*rivertype.JobRow, error)

	PilotInit(archetype *baseservice.Archetype)

	// ProducerInit is called when a producer is started. It should return the ID
	// of the new producer, a new state object that will be used to track the
	// producer's state, and an error if the producer could not be initialized.
	ProducerInit(ctx context.Context, exec riverdriver.Executor, params *ProducerInitParams) (int64, ProducerState, error)

	ProducerKeepAlive(ctx context.Context, exec riverdriver.Executor, params *riverdriver.ProducerKeepAliveParams) error

	ProducerShutdown(ctx context.Context, exec riverdriver.Executor, params *ProducerShutdownParams) error

	QueueMetadataChanged(ctx context.Context, exec riverdriver.Executor, params *QueueMetadataChangedParams) error
}

A Pilot bridges the gap between the River client and the driver, implementing higher level functionality on top of the driver's underlying queries. It tracks closely to the underlying driver's API, but may add additional functionality or logic wrapping the queries.

This should be considered a River internal API and its stability is not guaranteed. DO NOT USE.

type ProducerInitParams

type ProducerInitParams struct {
	ClientID      string
	ProducerID    int64
	Queue         string
	QueueMetadata []byte
	Schema        string
}

type ProducerShutdownParams

type ProducerShutdownParams struct {
	ProducerID int64
	Schema     string
	State      ProducerState
}

type ProducerState

type ProducerState interface {
	JobFinish(job *rivertype.JobRow)
}

type QueueMetadataChangedParams

type QueueMetadataChangedParams struct {
	Metadata []byte
	Schema   string
	State    ProducerState
}

type StandardPilot

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

func (*StandardPilot) JobGetAvailable

func (p *StandardPilot) JobGetAvailable(ctx context.Context, exec riverdriver.Executor, state ProducerState, params *riverdriver.JobGetAvailableParams) ([]*rivertype.JobRow, error)

func (*StandardPilot) JobInsertMany

func (p *StandardPilot) JobInsertMany(
	ctx context.Context,
	tx riverdriver.ExecutorTx,
	params *riverdriver.JobInsertFastManyParams,
) ([]*riverdriver.JobInsertFastResult, error)

func (*StandardPilot) JobSetStateIfRunningMany

func (p *StandardPilot) JobSetStateIfRunningMany(ctx context.Context, tx riverdriver.ExecutorTx, params *riverdriver.JobSetStateIfRunningManyParams) ([]*rivertype.JobRow, error)

func (*StandardPilot) PilotInit

func (p *StandardPilot) PilotInit(archetype *baseservice.Archetype)

func (*StandardPilot) ProducerInit

func (p *StandardPilot) ProducerInit(ctx context.Context, exec riverdriver.Executor, params *ProducerInitParams) (int64, ProducerState, error)

func (*StandardPilot) ProducerKeepAlive

func (p *StandardPilot) ProducerKeepAlive(ctx context.Context, exec riverdriver.Executor, params *riverdriver.ProducerKeepAliveParams) error

func (*StandardPilot) ProducerShutdown

func (p *StandardPilot) ProducerShutdown(ctx context.Context, exec riverdriver.Executor, params *ProducerShutdownParams) error

func (*StandardPilot) QueueMetadataChanged

func (p *StandardPilot) QueueMetadataChanged(ctx context.Context, exec riverdriver.Executor, params *QueueMetadataChangedParams) error