d57b81490f
Since the beginning, we have used a Go map to store the shared state (pinset) in memory. The mapstate knew how to serialize itself so that libp2p-raft would know how to write to disk when it: * Saved snapshots of the state on shutdown * Sent the state to a newcomer peer hashicorp.Raft assumes an in-memory state which is snapshotted from time to time and read from disk on boot. This commit adds a `dsstate` implementation of the state interface using `go-datastore`. This allows to effortlessly switch to a disk-backed state in the future (as we will need), and also have at our disposal the different implementations and utilities of Datastore for fine-tuning (caching, batching etc.). `mapstate` has been reworked to use dsstate. Ideally, we would not even need `mapstate`, as it would suffice to initialize `dsstate` with a `MapDatastore`. BUT, we still need it separate to be able to auto-migrate to the new format. This will be the last migration with the current system. Once this has been released and users have been able to upgrade we will just remove `mapstate` as it is now. License: MIT Signed-off-by: Hector Sanjuan <code@hector.link>
37 lines
1.2 KiB
Go
37 lines
1.2 KiB
Go
// Package state holds the interface that any state implementation for
|
|
// IPFS Cluster must satisfy.
|
|
package state
|
|
|
|
// State represents the shared state of the cluster and it
|
|
import (
|
|
"context"
|
|
"io"
|
|
|
|
cid "github.com/ipfs/go-cid"
|
|
|
|
"github.com/ipfs/ipfs-cluster/api"
|
|
)
|
|
|
|
// State is used by the Consensus component to keep track of
|
|
// objects which objects are pinned. This component should be thread safe.
|
|
type State interface {
|
|
// Add adds a pin to the State
|
|
Add(context.Context, api.Pin) error
|
|
// Rm removes a pin from the State
|
|
Rm(context.Context, cid.Cid) error
|
|
// List lists all the pins in the state
|
|
List(context.Context) []api.Pin
|
|
// Has returns true if the state is holding information for a Cid
|
|
Has(context.Context, cid.Cid) bool
|
|
// Get returns the information attacthed to this pin
|
|
Get(context.Context, cid.Cid) (api.Pin, bool)
|
|
// Migrate restores the serialized format of an outdated state to the current version
|
|
Migrate(ctx context.Context, r io.Reader) error
|
|
// Return the version of this state
|
|
GetVersion() int
|
|
// Marshal serializes the state to a byte slice
|
|
Marshal(io.Writer) error
|
|
// Unmarshal deserializes the state from marshaled bytes
|
|
Unmarshal(io.Reader) error
|
|
}
|