state

package
v0.0.0-...-6646f2c Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Apr 15, 2019 License: MIT Imports: 3 Imported by: 2

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, bool)
	// Migrate restores the serialized format of an outdated state to the current version
	Migrate(r io.Reader) error
	// Return the version of this state
	GetVersion() int
	// Marshal serializes the state to a byte slice
	Marshal() ([]byte, error)
	// Unmarshal deserializes the state from marshaled bytes
	Unmarshal([]byte) error
}

State is used by the Consensus component to keep track of objects which objects are pinned. This component should be thread safe.

Directories

Path Synopsis
Package mapstate implements the State interface for IPFS Cluster by using a map to keep track of the consensus-shared state.
Package mapstate implements the State interface for IPFS Cluster by using a map to keep track of the consensus-shared state.

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL