plugin.go

package river

import (
	"github.com/riverqueue/river/rivershared/baseservice"
	"github.com/riverqueue/river/rivershared/riverpilot"
	"github.com/riverqueue/river/rivershared/startstop"
)

// A plugin API that drivers may implement to extend a River client. Driver
// plugins may, for example, add additional maintenance services.
//
// This should be considered a River internal API and its stability is not
// guaranteed. DO NOT USE.
type driverPlugin[TTx any] interface {
	// PluginInit initializes a plugin with an archetype. It's invoked on
	// Client.NewClient.
	PluginInit(archetype *baseservice.Archetype)

	// PluginPilot returns a custom Pilot implementation.
	PluginPilot() riverpilot.Pilot
}

// A plugin API that pilots may implement to extend a River client. Pilot
// plugins may, for example, add additional maintenance services.
//
// This should be considered a River internal API and its stability is not
// guaranteed. DO NOT USE.
type pilotPlugin interface {
	// PluginMaintenanceServices returns additional maintenance services (will
	// only run on an elected leader) for a River client.
	PluginMaintenanceServices() []startstop.Service

	// PluginServices returns additional non-maintenance services (will run on
	// all clients) for a River client.
	PluginServices() []startstop.Service
}