Documentation ¶
Overview ¶
Package state holds the interface that any state implementation for IPFS Cluster must satisfy.
Index ¶
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type State ¶
type State interface { // Add adds a pin to the State Add(api.Pin) error // Rm removes a pin from the State Rm(*cid.Cid) error // List lists all the pins in the state List() []api.Pin // Has returns true if the state is holding information for a Cid Has(*cid.Cid) bool // Get returns the information attacthed to this pin Get(*cid.Cid) api.Pin // Snapshot writes a snapshot of the state to a writer Snapshot(w io.Writer) error // Restore restores a snapshot from a reader Restore(r io.Reader) error }
State is used by the Consensus component to keep track of objects which objects are pinned. This component should be thread safe.
Click to show internal directories.
Click to hide internal directories.