Elle Mouton
11b27f07da
Currently, a few of the graph KVStore methods take the `batch.SchedulerOptions` param. This is only used to set the LazyAdd option. A SchedulerOption is a functional option that takes a `batch.Request` which has bolt-specific fields in it. This commit restructures things a bit such that the `batch.Request` type is no longer part of the `batch.SchedulerOptions` - this will make it easier to implement the graph store with a different DB backend.
82 lines
2.6 KiB
Go
82 lines
2.6 KiB
Go
package batch
|
|
|
|
import "github.com/lightningnetwork/lnd/kvdb"
|
|
|
|
// Request defines an operation that can be batched into a single bbolt
|
|
// transaction.
|
|
type Request struct {
|
|
// Opts holds various configuration options for a scheduled request.
|
|
Opts *SchedulerOptions
|
|
|
|
// Reset is called before each invocation of Update and is used to clear
|
|
// any possible modifications to local state as a result of previous
|
|
// calls to Update that were not committed due to a concurrent batch
|
|
// failure.
|
|
//
|
|
// NOTE: This field is optional.
|
|
Reset func()
|
|
|
|
// Update is applied alongside other operations in the batch.
|
|
//
|
|
// NOTE: This method MUST NOT acquire any mutexes.
|
|
Update func(tx kvdb.RwTx) error
|
|
|
|
// OnCommit is called if the batch or a subset of the batch including
|
|
// this request all succeeded without failure. The passed error should
|
|
// contain the result of the transaction commit, as that can still fail
|
|
// even if none of the closures returned an error.
|
|
//
|
|
// NOTE: This field is optional.
|
|
OnCommit func(commitErr error) error
|
|
}
|
|
|
|
// SchedulerOptions holds various configuration options for a scheduled request.
|
|
type SchedulerOptions struct {
|
|
// lazy should be true if we don't have to immediately execute this
|
|
// request when it comes in. This means that it can be scheduled later,
|
|
// allowing larger batches.
|
|
lazy bool
|
|
}
|
|
|
|
// NewDefaultSchedulerOpts returns a new SchedulerOptions with default values.
|
|
func NewDefaultSchedulerOpts() *SchedulerOptions {
|
|
return &SchedulerOptions{
|
|
lazy: false,
|
|
}
|
|
}
|
|
|
|
// NewSchedulerOptions returns a new SchedulerOptions with the given options
|
|
// applied on top of the default options.
|
|
func NewSchedulerOptions(options ...SchedulerOption) *SchedulerOptions {
|
|
opts := NewDefaultSchedulerOpts()
|
|
for _, o := range options {
|
|
o(opts)
|
|
}
|
|
|
|
return opts
|
|
}
|
|
|
|
// SchedulerOption is a type that can be used to supply options to a scheduled
|
|
// request.
|
|
type SchedulerOption func(*SchedulerOptions)
|
|
|
|
// LazyAdd will make the request be executed lazily, added to the next batch to
|
|
// reduce db contention.
|
|
//
|
|
// NOTE: This is currently a no-op for any DB backend other than bbolt.
|
|
func LazyAdd() SchedulerOption {
|
|
return func(opts *SchedulerOptions) {
|
|
opts.lazy = true
|
|
}
|
|
}
|
|
|
|
// Scheduler abstracts a generic batching engine that accumulates an incoming
|
|
// set of Requests, executes them, and returns the error from the operation.
|
|
type Scheduler interface {
|
|
// Execute schedules a Request for execution with the next available
|
|
// batch. This method blocks until the underlying closure has been
|
|
// run against the database. The resulting error is returned to the
|
|
// caller.
|
|
Execute(req *Request) error
|
|
}
|