ipfscluster

Jan 30, 2024

Changes in this version

type Config

+ AnnounceAddr []ma.Multiaddr

+ NoAnnounceAddr []ma.Multiaddr

Oct 12, 2023

Changes in this version

+ const DefaultPinOnlyOnUntrustedPeers

type Config

+ PinOnlyOnUntrustedPeers bool

Sep 16, 2022

Changes in this version

type IPFSConnector

+ Ready func(context.Context) <-chan struct{}

Jul 6, 2022

Changes in this version

+ const DefaultConnMgrGracePeriod

+ const DefaultConnMgrHighWater

+ const DefaultConnMgrLowWater

+ const DefaultDialPeerTimeout

+ const DefaultEnableRelayHop

+ const DefaultFollowerMode

+ const DefaultMDNSInterval

+ const DefaultPinOnlyOnTrustedPeers

+ const DefaultPinRecoverInterval

+ var DefaultListenAddrs = []string

+ var DefaultRPCPolicy = map[string]RPCEndpointType

+ func RPCServiceID(rpcSvc interface{}) string

type Cluster

+ func (c *Cluster) Alerts() []api.Alert

+ func (c *Cluster) PinUpdate(ctx context.Context, from api.Cid, to api.Cid, opts api.PinOptions) (api.Pin, error)

+ func (c *Cluster) RecoverAll(ctx context.Context, out chan<- api.GlobalPinInfo) error

+ func (c *Cluster) RepoGC(ctx context.Context) (api.GlobalRepoGC, error)

+ func (c *Cluster) RepoGCLocal(ctx context.Context) (api.RepoGC, error)

+ type ClusterRPCAPI struct

+ func (rpcapi *ClusterRPCAPI) Alerts(ctx context.Context, in struct{}, out *[]api.Alert) error

+ func (rpcapi *ClusterRPCAPI) BlockAllocate(ctx context.Context, in api.Pin, out *[]peer.ID) error

+ func (rpcapi *ClusterRPCAPI) ConnectGraph(ctx context.Context, in struct{}, out *api.ConnectGraph) error

+ func (rpcapi *ClusterRPCAPI) ID(ctx context.Context, in struct{}, out *api.ID) error

+ func (rpcapi *ClusterRPCAPI) IDStream(ctx context.Context, in <-chan struct{}, out chan<- api.ID) error

+ func (rpcapi *ClusterRPCAPI) IPFSID(ctx context.Context, in peer.ID, out *api.IPFSID) error

+ func (rpcapi *ClusterRPCAPI) Join(ctx context.Context, in api.Multiaddr, out *struct{}) error

+ func (rpcapi *ClusterRPCAPI) PeerAdd(ctx context.Context, in peer.ID, out *api.ID) error

+ func (rpcapi *ClusterRPCAPI) PeerRemove(ctx context.Context, in peer.ID, out *struct{}) error

+ func (rpcapi *ClusterRPCAPI) Peers(ctx context.Context, in <-chan struct{}, out chan<- api.ID) error

+ func (rpcapi *ClusterRPCAPI) PeersWithFilter(ctx context.Context, in <-chan []peer.ID, out chan<- api.ID) error

+ func (rpcapi *ClusterRPCAPI) Pin(ctx context.Context, in api.Pin, out *api.Pin) error

+ func (rpcapi *ClusterRPCAPI) PinGet(ctx context.Context, in api.Cid, out *api.Pin) error

+ func (rpcapi *ClusterRPCAPI) PinPath(ctx context.Context, in api.PinPath, out *api.Pin) error

+ func (rpcapi *ClusterRPCAPI) Pins(ctx context.Context, in <-chan struct{}, out chan<- api.Pin) error

+ func (rpcapi *ClusterRPCAPI) Recover(ctx context.Context, in api.Cid, out *api.GlobalPinInfo) error

+ func (rpcapi *ClusterRPCAPI) RecoverAll(ctx context.Context, in <-chan struct{}, out chan<- api.GlobalPinInfo) error

+ func (rpcapi *ClusterRPCAPI) RecoverAllLocal(ctx context.Context, in <-chan struct{}, out chan<- api.PinInfo) error

+ func (rpcapi *ClusterRPCAPI) RecoverLocal(ctx context.Context, in api.Cid, out *api.PinInfo) error

+ func (rpcapi *ClusterRPCAPI) RepoGC(ctx context.Context, in struct{}, out *api.GlobalRepoGC) error

+ func (rpcapi *ClusterRPCAPI) RepoGCLocal(ctx context.Context, in struct{}, out *api.RepoGC) error

+ func (rpcapi *ClusterRPCAPI) SendInformerMetrics(ctx context.Context, in struct{}, out *struct{}) error

+ func (rpcapi *ClusterRPCAPI) SendInformersMetrics(ctx context.Context, in struct{}, out *struct{}) error

+ func (rpcapi *ClusterRPCAPI) Status(ctx context.Context, in api.Cid, out *api.GlobalPinInfo) error

+ func (rpcapi *ClusterRPCAPI) StatusAll(ctx context.Context, in <-chan api.TrackerStatus, out chan<- api.GlobalPinInfo) error

+ func (rpcapi *ClusterRPCAPI) StatusAllLocal(ctx context.Context, in <-chan api.TrackerStatus, out chan<- api.PinInfo) error

+ func (rpcapi *ClusterRPCAPI) StatusLocal(ctx context.Context, in api.Cid, out *api.PinInfo) error

+ func (rpcapi *ClusterRPCAPI) Unpin(ctx context.Context, in api.Pin, out *api.Pin) error

+ func (rpcapi *ClusterRPCAPI) UnpinPath(ctx context.Context, in api.PinPath, out *api.Pin) error

+ func (rpcapi *ClusterRPCAPI) Version(ctx context.Context, in struct{}, out *api.Version) error

type Config

+ ConnMgr ConnMgrConfig

+ DialPeerTimeout time.Duration

+ EnableRelayHop bool

+ FollowerMode bool

+ MDNSInterval time.Duration

+ PeerAddresses []ma.Multiaddr

+ PinOnlyOnTrustedPeers bool

+ PinRecoverInterval time.Duration

+ RPCPolicy map[string]RPCEndpointType

+ func (cfg *Config) ToDisplayJSON() ([]byte, error)

+ type ConnMgrConfig struct

+ GracePeriod time.Duration

+ HighWater int

+ LowWater int

type Consensus

+ Distrust func(context.Context, peer.ID) error

+ IsTrustedPeer func(context.Context, peer.ID) bool

+ Trust func(context.Context, peer.ID) error

+ type ConsensusRPCAPI struct

+ func (rpcapi *ConsensusRPCAPI) AddPeer(ctx context.Context, in peer.ID, out *struct{}) error

+ func (rpcapi *ConsensusRPCAPI) LogPin(ctx context.Context, in api.Pin, out *struct{}) error

+ func (rpcapi *ConsensusRPCAPI) LogUnpin(ctx context.Context, in api.Pin, out *struct{}) error

+ func (rpcapi *ConsensusRPCAPI) Peers(ctx context.Context, in struct{}, out *[]peer.ID) error

+ func (rpcapi *ConsensusRPCAPI) RmPeer(ctx context.Context, in peer.ID, out *struct{}) error

type IPFSConnector

+ BlockStream func(context.Context, <-chan api.NodeWithMeta) error

+ RepoGC func(context.Context) (api.RepoGC, error)

+ type IPFSConnectorRPCAPI struct

+ func (rpcapi *IPFSConnectorRPCAPI) BlockGet(ctx context.Context, in api.Cid, out *[]byte) error

+ func (rpcapi *IPFSConnectorRPCAPI) BlockStream(ctx context.Context, in <-chan api.NodeWithMeta, out chan<- struct{}) error

+ func (rpcapi *IPFSConnectorRPCAPI) ConfigKey(ctx context.Context, in string, out *interface{}) error

+ func (rpcapi *IPFSConnectorRPCAPI) Pin(ctx context.Context, in api.Pin, out *struct{}) error

+ func (rpcapi *IPFSConnectorRPCAPI) PinLs(ctx context.Context, in <-chan []string, out chan<- api.IPFSPinInfo) error

+ func (rpcapi *IPFSConnectorRPCAPI) PinLsCid(ctx context.Context, in api.Pin, out *api.IPFSPinStatus) error

+ func (rpcapi *IPFSConnectorRPCAPI) RepoStat(ctx context.Context, in struct{}, out *api.IPFSRepoStat) error

+ func (rpcapi *IPFSConnectorRPCAPI) Resolve(ctx context.Context, in string, out *api.Cid) error

+ func (rpcapi *IPFSConnectorRPCAPI) SwarmPeers(ctx context.Context, in struct{}, out *[]peer.ID) error

+ func (rpcapi *IPFSConnectorRPCAPI) Unpin(ctx context.Context, in api.Pin, out *struct{}) error

type Informer

+ GetMetrics func(context.Context) []api.Metric

type PeerMonitor

+ LatestForPeer func(ctx context.Context, name string, pid peer.ID) api.Metric

+ MetricNames func(ctx context.Context) []string

+ type PeerMonitorRPCAPI struct

+ func (rpcapi *PeerMonitorRPCAPI) LatestMetrics(ctx context.Context, in string, out *[]api.Metric) error

+ func (rpcapi *PeerMonitorRPCAPI) MetricNames(ctx context.Context, in struct{}, out *[]string) error

type PinAllocator

+ Metrics func() []string

type PinTracker

+ PinQueueSize func(context.Context) (int64, error)

+ type PinTrackerRPCAPI struct

+ func (rpcapi *PinTrackerRPCAPI) PinQueueSize(ctx context.Context, in struct{}, out *int64) error

+ func (rpcapi *PinTrackerRPCAPI) Recover(ctx context.Context, in api.Cid, out *api.PinInfo) error

+ func (rpcapi *PinTrackerRPCAPI) RecoverAll(ctx context.Context, in <-chan struct{}, out chan<- api.PinInfo) error

+ func (rpcapi *PinTrackerRPCAPI) Status(ctx context.Context, in api.Cid, out *api.PinInfo) error

+ func (rpcapi *PinTrackerRPCAPI) StatusAll(ctx context.Context, in <-chan api.TrackerStatus, out chan<- api.PinInfo) error

+ func (rpcapi *PinTrackerRPCAPI) Track(ctx context.Context, in api.Pin, out *struct{}) error

+ func (rpcapi *PinTrackerRPCAPI) Untrack(ctx context.Context, in api.Pin, out *struct{}) error

+ type RPCEndpointType int

+ const RPCClosed

+ const RPCOpen

+ const RPCTrusted

Mar 7, 2019

Changes in this version

type Cluster

+ func (c *Cluster) PinPath(ctx context.Context, path *api.PinPath) (*api.Pin, error)

+ func (c *Cluster) UnpinPath(ctx context.Context, path string) (*api.Pin, error)

type Config

+ func (cfg *Config) ApplyEnvVars() error

type IPFSConnector

+ Resolve func(context.Context, string) (cid.Cid, error)

type RPCAPI

+ func (rpcapi *RPCAPI) PinPath(ctx context.Context, in *api.PinPath, out *api.Pin) error

+ func (rpcapi *RPCAPI) UnpinPath(ctx context.Context, in *api.PinPath, out *api.Pin) error

Feb 18, 2019

Changes in this version

type Config

+ Tracing bool

+ type Tracer interface

Aug 24, 2018

Changes in this version

type Cluster

+ func (c *Cluster) AddFile(reader *multipart.Reader, params *api.AddParams) (*cid.Cid, error)

type IPFSConnector

+ BlockGet func(*cid.Cid) ([]byte, error)

+ BlockPut func(api.NodeWithMeta) error

+ RepoStat func() (api.IPFSRepoStat, error)

type RPCAPI

+ func (rpcapi *RPCAPI) BlockAllocate(ctx context.Context, in api.PinSerial, out *[]string) error

+ func (rpcapi *RPCAPI) IPFSBlockGet(ctx context.Context, in api.PinSerial, out *[]byte) error

+ func (rpcapi *RPCAPI) IPFSBlockPut(ctx context.Context, in api.NodeWithMeta, out *struct{}) error

+ func (rpcapi *RPCAPI) IPFSRepoStat(ctx context.Context, in struct{}, out *api.IPFSRepoStat) error

+ func (rpcapi *RPCAPI) SendInformerMetric(ctx context.Context, in struct{}, out *api.Metric) error

May 30, 2018

Changes in this version

+ const DefaultDisableRepinning

+ const DefaultPeerWatchInterval

+ const DefaultPeerstoreFile

+ var ReadyTimeout = 30 * time.Second

+ func GlobalPinInfoSliceToSerial(gpi []api.GlobalPinInfo) []api.GlobalPinInfoSerial

type Config

+ DisableRepinning bool

+ PeerWatchInterval time.Duration

+ PeerstoreFile string

+ func (cfg *Config) GetPeerstorePath() string

type PeerMonitor

+ LatestMetrics func(name string) []api.Metric

+ PublishMetric func(api.Metric) error

type RPCAPI

+ func (rpcapi *RPCAPI) PeerMonitorLatestMetrics(ctx context.Context, in string, out *[]api.Metric) error

Mar 29, 2018

Changes in this version

+ var ErrBootstrap = errors.New("bootstrap unsuccessful")

+ func EncodeProtectorKey(secretBytes []byte) string

+ func NewClusterHost(ctx context.Context, cfg *Config) (host.Host, error)

Feb 12, 2018

Changes in this version

type Cluster

+ func (c *Cluster) ConnectGraph() (api.ConnectGraph, error)

type IPFSConnector

+ SwarmPeers func() (api.SwarmPeers, error)

type RPCAPI

+ func (rpcapi *RPCAPI) ConnectGraph(in struct{}, out *api.ConnectGraphSerial) error

+ func (rpcapi *RPCAPI) IPFSSwarmPeers(in struct{}, out *api.SwarmPeersSerial) error

Jan 26, 2018

Changes in this version

+ var LoggingFacilities = map[string]string

+ var LoggingFacilitiesExtra = map[string]string

+ func PeersFromMultiaddrs(addrs []ma.Multiaddr) []peer.ID

type Config

+ ReplicationFactorMax int

+ ReplicationFactorMin int

Dec 11, 2017

Changes in this version

+ func MultiaddrSplit(addr ma.Multiaddr) (peer.ID, ma.Multiaddr, error)

type Cluster

+ func (c *Cluster) RecoverAllLocal() ([]api.PinInfo, error)

+ func (c *Cluster) StatusAllLocal() []api.PinInfo

+ func (c *Cluster) StatusLocal(h *cid.Cid) api.PinInfo

type Config

+ Peername string

type PinTracker

+ RecoverAll func() ([]api.PinInfo, error)

type RPCAPI

+ func (rpcapi *RPCAPI) RecoverAllLocal(in struct{}, out *[]api.PinInfoSerial) error

+ func (rpcapi *RPCAPI) RecoverLocal(in api.PinSerial, out *api.PinInfoSerial) error

+ func (rpcapi *RPCAPI) StatusAllLocal(in struct{}, out *[]api.PinInfoSerial) error

+ func (rpcapi *RPCAPI) StatusLocal(in api.PinSerial, out *api.PinInfoSerial) error

+ func (rpcapi *RPCAPI) TrackerRecoverAll(in struct{}, out *[]api.PinInfoSerial) error

Nov 15, 2017

Changes in this version

type Consensus

+ AddPeer func(p peer.ID) error

+ Clean func() error

+ Peers func() ([]peer.ID, error)

+ RmPeer func(p peer.ID) error

type RPCAPI

+ func (rpcapi *RPCAPI) ConsensusAddPeer(in peer.ID, out *struct{}) error

+ func (rpcapi *RPCAPI) ConsensusPeers(in struct{}, out *[]peer.ID) error

+ func (rpcapi *RPCAPI) ConsensusRmPeer(in peer.ID, out *struct{}) error

+ func (rpcapi *RPCAPI) PeerManagerImportAddresses(in api.MultiaddrsSerial, out *struct{}) error

Oct 23, 2017

Changes in this version

+ const DefaultIPFSSyncInterval

+ const DefaultLeaveOnShutdown

+ const DefaultListenAddr

+ const DefaultMonitorPingInterval

+ const DefaultReplicationFactor

+ const DefaultStateSyncInterval

type Config

+ IPFSSyncInterval time.Duration

+ ListenAddr ma.Multiaddr

+ MonitorPingInterval time.Duration

+ Peers []ma.Multiaddr

+ Secret []byte

+ StateSyncInterval time.Duration

+ func (cfg *Config) ConfigKey() string

+ func (cfg *Config) Default() error

+ func (cfg *Config) LoadJSON(raw []byte) error

+ func (cfg *Config) ToJSON() (raw []byte, err error)

+ func (cfg *Config) Validate() error

type IPFSConnector

+ FreeSpace func() (int, error)

type RPCAPI

+ func (rpcapi *RPCAPI) IPFSFreeSpace(in struct{}, out *int) error

Jul 29, 2017

Changes in this version

+ const DefaultDataFolder

+ const DefaultIPFSSyncSeconds

+ func DecodeClusterSecret(hexSecret string) ([]byte, error)

+ func EncodeClusterSecret(secretBytes []byte) string

type Cluster

+ func (c *Cluster) PinGet(h *cid.Cid) (api.Pin, error)

type Config

+ ClusterSecret []byte

+ IPFSSyncSeconds int

+ SSLCertFile string

+ SSLKeyFile string

type JSONConfig

+ ClusterSecret string

+ IPFSSyncSeconds int

+ SSLCertFile string

+ SSLKeyFile string

type RPCAPI

+ func (rpcapi *RPCAPI) PinGet(in api.PinSerial, out *api.PinSerial) error

+ func (rpcapi *RPCAPI) Pins(in struct{}, out *[]api.PinSerial) error

Mar 30, 2017

Changes in this version

type Config

+ func (cfg *Config) Shadow()

Mar 28, 2017

Changes in this version

type Config

+ AllocationStrategy string

type IPFSConnector

+ ConfigKey func(keypath string) (interface{}, error)

+ ConnectSwarms func() error

+ RepoSize func() (int, error)

type JSONConfig

+ AllocationStrategy string

type RPCAPI

+ func (rpcapi *RPCAPI) IPFSConfigKey(in string, out *interface{}) error

+ func (rpcapi *RPCAPI) IPFSConnectSwarms(in struct{}, out *struct{}) error

+ func (rpcapi *RPCAPI) IPFSRepoSize(in struct{}, out *int) error

Mar 2, 2017

Changes in this version

+ const DefaultMonitoringIntervalSeconds

+ const DefaultStateSyncSeconds

+ const LogOpAddPeer

+ const LogOpRmPeer

+ var AlertChannelCap = 256

+ var CommitRetries = 2

+ var DefaultRaftConfig = hashiraft.DefaultConfig()

+ var PinQueueSize = 1024

+ var RaftMaxSnapshots = 5

+ var WindowCap = 10

+ func SetFacilityLogLevel(f, l string)

type Cluster

+ func (c *Cluster) Done() <-chan struct{}

+ func (c *Cluster) Join(addr ma.Multiaddr) error

+ func (c *Cluster) PeerAdd(addr ma.Multiaddr) (api.ID, error)

+ func (c *Cluster) PeerRemove(pid peer.ID) error

+ func (c *Cluster) Peers() []api.ID

+ func (c *Cluster) Ready() <-chan struct{}

+ func (c *Cluster) Recover(h *cid.Cid) (api.GlobalPinInfo, error)

+ func (c *Cluster) RecoverLocal(h *cid.Cid) (api.PinInfo, error)

+ func (c *Cluster) StatusAll() ([]api.GlobalPinInfo, error)

+ func (c *Cluster) Sync(h *cid.Cid) (api.GlobalPinInfo, error)

+ func (c *Cluster) SyncAll() ([]api.GlobalPinInfo, error)

+ func (c *Cluster) SyncAllLocal() ([]api.PinInfo, error)

+ func (c *Cluster) SyncLocal(h *cid.Cid) (api.PinInfo, error)

type Config

+ Bootstrap []ma.Multiaddr

+ LeaveOnShutdown bool

+ MonitoringIntervalSeconds int

+ ReplicationFactor int

+ StateSyncSeconds int

type Consensus

+ func (cc *Consensus) LogAddPeer(addr ma.Multiaddr) error

+ func (cc *Consensus) LogRmPeer(pid peer.ID) error

+ func (cc *Consensus) Ready() <-chan struct{}

+ func (cc *Consensus) WaitForSync() error

type IPFSConnector

+ ID func() (api.IPFSID, error)

+ PinLs func(typeFilter string) (map[string]api.IPFSPinStatus, error)

+ PinLsCid func(*cid.Cid) (api.IPFSPinStatus, error)

type IPFSHTTPConnector

+ func (ipfs *IPFSHTTPConnector) ID() (api.IPFSID, error)

+ func (ipfs *IPFSHTTPConnector) PinLs(typeFilter string) (map[string]api.IPFSPinStatus, error)

+ func (ipfs *IPFSHTTPConnector) PinLsCid(hash *cid.Cid) (api.IPFSPinStatus, error)

+ type Informer interface

+ GetMetric func() api.Metric

+ Name func() string

type JSONConfig

+ Bootstrap []string

+ LeaveOnShutdown bool

+ MonitoringIntervalSeconds int

+ ReplicationFactor int

+ StateSyncSeconds int

+ type LogOp struct

+ Cid api.CidArgSerial

+ Peer api.MultiaddrSerial

+ Type LogOpType

+ func (op *LogOp) ApplyTo(cstate consensus.State) (consensus.State, error)

+ type LogOpType int

type MapPinTracker

+ func (mpt *MapPinTracker) StatusAll() []api.PinInfo

+ func (mpt *MapPinTracker) SyncAll() ([]api.PinInfo, error)

+ type PeerMonitor interface

+ Alerts func() <-chan api.Alert

+ LastMetrics func(name string) []api.Metric

+ LogMetric func(api.Metric)

+ type PinAllocator interface

+ Allocate func(c *cid.Cid, current, candidates map[peer.ID]api.Metric) ([]peer.ID, error)

type PinTracker

+ StatusAll func() []api.PinInfo

+ SyncAll func() ([]api.PinInfo, error)

type RPCAPI

+ func (rpcapi *RPCAPI) ConsensusLogAddPeer(in api.MultiaddrSerial, out *struct{}) error

+ func (rpcapi *RPCAPI) ConsensusLogRmPeer(in peer.ID, out *struct{}) error

+ func (rpcapi *RPCAPI) IPFSPinLs(in string, out *map[string]api.IPFSPinStatus) error

+ func (rpcapi *RPCAPI) IPFSPinLsCid(in api.CidArgSerial, out *api.IPFSPinStatus) error

+ func (rpcapi *RPCAPI) Join(in api.MultiaddrSerial, out *struct{}) error

+ func (rpcapi *RPCAPI) PeerAdd(in api.MultiaddrSerial, out *api.IDSerial) error

+ func (rpcapi *RPCAPI) PeerManagerAddFromMultiaddrs(in api.MultiaddrsSerial, out *struct{}) error

+ func (rpcapi *RPCAPI) PeerManagerAddPeer(in api.MultiaddrSerial, out *struct{}) error

+ func (rpcapi *RPCAPI) PeerManagerPeers(in struct{}, out *[]peer.ID) error

+ func (rpcapi *RPCAPI) PeerManagerRmPeer(in peer.ID, out *struct{}) error

+ func (rpcapi *RPCAPI) PeerManagerRmPeerShutdown(in peer.ID, out *struct{}) error

+ func (rpcapi *RPCAPI) PeerMonitorLastMetrics(in string, out *[]api.Metric) error

+ func (rpcapi *RPCAPI) PeerMonitorLogMetric(in api.Metric, out *struct{}) error

+ func (rpcapi *RPCAPI) PeerRemove(in peer.ID, out *struct{}) error

+ func (rpcapi *RPCAPI) Peers(in struct{}, out *[]api.IDSerial) error

+ func (rpcapi *RPCAPI) Recover(in api.CidArgSerial, out *api.GlobalPinInfoSerial) error

+ func (rpcapi *RPCAPI) RemoteMultiaddrForPeer(in peer.ID, out *api.MultiaddrSerial) error

+ func (rpcapi *RPCAPI) StatusAll(in struct{}, out *[]api.GlobalPinInfoSerial) error

+ func (rpcapi *RPCAPI) Sync(in api.CidArgSerial, out *api.GlobalPinInfoSerial) error

+ func (rpcapi *RPCAPI) SyncAll(in struct{}, out *[]api.GlobalPinInfoSerial) error

+ func (rpcapi *RPCAPI) SyncAllLocal(in struct{}, out *[]api.PinInfoSerial) error

+ func (rpcapi *RPCAPI) SyncLocal(in api.CidArgSerial, out *api.PinInfoSerial) error

+ func (rpcapi *RPCAPI) TrackerRecover(in api.CidArgSerial, out *api.PinInfoSerial) error

+ func (rpcapi *RPCAPI) TrackerStatusAll(in struct{}, out *[]api.PinInfoSerial) error

+ type Raft struct

+ func NewRaft(peers []peer.ID, host host.Host, dataFolder string, fsm hashiraft.FSM) (*Raft, error)

+ func (r *Raft) AddPeer(peer string) error

+ func (r *Raft) Leader() string

+ func (r *Raft) RemovePeer(peer string) error

+ func (r *Raft) Shutdown() error

+ func (r *Raft) Snapshot() error

+ func (r *Raft) WaitForLeader(ctx context.Context) error

+ func (r *Raft) WaitForUpdates(ctx context.Context) error

type State

+ Add func(api.CidArg) error

+ Get func(*cid.Cid) api.CidArg

+ Has func(*cid.Cid) bool

+ List func() []api.CidArg

+ Rm func(*cid.Cid) error

+ type StdPeerMonitor struct

+ func NewStdPeerMonitor(cfg *Config) *StdPeerMonitor

+ func (mon *StdPeerMonitor) Alerts() <-chan api.Alert

+ func (mon *StdPeerMonitor) LastMetrics(name string) []api.Metric

+ func (mon *StdPeerMonitor) LogMetric(m api.Metric)

+ func (mon *StdPeerMonitor) SetClient(c *rpc.Client)

+ func (mon *StdPeerMonitor) Shutdown() error

Jan 25, 2017

Changes in this version

+ const Bug

+ const ClusterError

+ const DefaultAPIAddr

+ const DefaultClusterAddr

+ const DefaultConfigCrypto

+ const DefaultConfigKeyLength

+ const DefaultIPFSNodeAddr

+ const DefaultIPFSProxyAddr

+ const LogOpPin

+ const LogOpUnpin

+ const PinError

+ const Pinned

+ const Pinning

+ const RemotePin

+ const UnpinError

+ const Unpinned

+ const Unpinning

+ const Version

+ var Commit string

+ var IPFSProxyServerIdleTimeout = 60 * time.Second

+ var IPFSProxyServerReadTimeout = 5 * time.Second

+ var IPFSProxyServerWriteTimeout = 10 * time.Second

+ var LeaderTimeout = 120 * time.Second

+ var PinningTimeout = 15 * time.Minute

+ var RESTAPIServerIdleTimeout = 60 * time.Second

+ var RESTAPIServerReadTimeout = 5 * time.Second

+ var RESTAPIServerWriteTimeout = 10 * time.Second

+ var RPCProtocol = protocol.ID("/ipfscluster/" + Version + "/rpc")

+ var SilentRaft = true

+ var UnpinningTimeout = 10 * time.Second

+ func SetLogLevel(l string)

+ type API interface

+ type CidArg struct

+ Cid string

+ func NewCidArg(c *cid.Cid) *CidArg

+ func (arg *CidArg) CID() (*cid.Cid, error)

+ type Cluster struct

+ func NewCluster(cfg *Config, api API, ipfs IPFSConnector, state State, tracker PinTracker) (*Cluster, error)

+ func (c *Cluster) GlobalSync() ([]GlobalPinInfo, error)

+ func (c *Cluster) GlobalSyncCid(h *cid.Cid) (GlobalPinInfo, error)

+ func (c *Cluster) ID() ID

+ func (c *Cluster) LocalSync() ([]PinInfo, error)

+ func (c *Cluster) LocalSyncCid(h *cid.Cid) (PinInfo, error)

+ func (c *Cluster) Members() []peer.ID

+ func (c *Cluster) Pin(h *cid.Cid) error

+ func (c *Cluster) Pins() []*cid.Cid

+ func (c *Cluster) Shutdown() error

+ func (c *Cluster) StateSync() ([]PinInfo, error)

+ func (c *Cluster) Status() ([]GlobalPinInfo, error)

+ func (c *Cluster) StatusCid(h *cid.Cid) (GlobalPinInfo, error)

+ func (c *Cluster) Unpin(h *cid.Cid) error

+ func (c *Cluster) Version() string

+ type Component interface

+ SetClient func(*rpc.Client)

+ Shutdown func() error

+ type Config struct

+ APIAddr ma.Multiaddr

+ ClusterAddr ma.Multiaddr

+ ClusterPeers []ma.Multiaddr

+ ConsensusDataFolder string

+ ID peer.ID

+ IPFSNodeAddr ma.Multiaddr

+ IPFSProxyAddr ma.Multiaddr

+ PrivateKey crypto.PrivKey

+ RaftConfig *hashiraft.Config

+ func LoadConfig(path string) (*Config, error)

+ func NewDefaultConfig() (*Config, error)

+ func (cfg *Config) Save(path string) error

+ func (cfg *Config) ToJSONConfig() (j *JSONConfig, err error)

+ type Consensus struct

+ func NewConsensus(cfg *Config, host host.Host, state State) (*Consensus, error)

+ func (cc *Consensus) Leader() (peer.ID, error)

+ func (cc *Consensus) LogPin(c *cid.Cid) error

+ func (cc *Consensus) LogUnpin(c *cid.Cid) error

+ func (cc *Consensus) Rollback(state State) error

+ func (cc *Consensus) SetClient(c *rpc.Client)

+ func (cc *Consensus) Shutdown() error

+ func (cc *Consensus) State() (State, error)

+ type GlobalPinInfo struct

+ Cid *cid.Cid

+ Status map[peer.ID]PinInfo

+ type ID struct

+ Addresses []ma.Multiaddr

+ Commit string

+ ID peer.ID

+ PublicKey crypto.PubKey

+ RPCProtocolVersion protocol.ID

+ Version string

+ type IPFSConnector interface

+ IsPinned func(*cid.Cid) (bool, error)

+ Pin func(*cid.Cid) error

+ Unpin func(*cid.Cid) error

+ type IPFSHTTPConnector struct

+ func NewIPFSHTTPConnector(cfg *Config) (*IPFSHTTPConnector, error)

+ func (ipfs *IPFSHTTPConnector) IsPinned(hash *cid.Cid) (bool, error)

+ func (ipfs *IPFSHTTPConnector) Pin(hash *cid.Cid) error

+ func (ipfs *IPFSHTTPConnector) SetClient(c *rpc.Client)

+ func (ipfs *IPFSHTTPConnector) Shutdown() error

+ func (ipfs *IPFSHTTPConnector) Unpin(hash *cid.Cid) error

+ type IPFSStatus int

+ func (st IPFSStatus) String() string

+ type JSONConfig struct

+ APIListenMultiaddress string

+ ClusterListenMultiaddress string

+ ClusterPeers []string

+ ConsensusDataFolder string

+ ID string

+ IPFSNodeMultiaddress string

+ IPFSProxyListenMultiaddress string

+ PrivateKey string

+ RaftConfig *RaftConfig

+ func (jcfg *JSONConfig) ToConfig() (c *Config, err error)

+ type MapPinTracker struct

+ func NewMapPinTracker(cfg *Config) *MapPinTracker

+ func (mpt *MapPinTracker) Recover(c *cid.Cid) error

+ func (mpt *MapPinTracker) SetClient(c *rpc.Client)

+ func (mpt *MapPinTracker) Shutdown() error

+ func (mpt *MapPinTracker) Status() []PinInfo

+ func (mpt *MapPinTracker) StatusCid(c *cid.Cid) PinInfo

+ func (mpt *MapPinTracker) Sync(c *cid.Cid) bool

+ func (mpt *MapPinTracker) Track(c *cid.Cid) error

+ func (mpt *MapPinTracker) Untrack(c *cid.Cid) error

+ type MapState struct

+ PinMap map[string]struct{}

+ func NewMapState() *MapState

+ func (st *MapState) AddPin(c *cid.Cid) error

+ func (st *MapState) HasPin(c *cid.Cid) bool

+ func (st *MapState) ListPins() []*cid.Cid

+ func (st *MapState) RmPin(c *cid.Cid) error

+ type Peered interface

+ AddPeer func(p peer.ID)

+ RmPeer func(p peer.ID)

+ SetPeers func(peers []peer.ID)

+ type PinInfo struct

+ CidStr string

+ Error string

+ IPFS IPFSStatus

+ Peer peer.ID

+ TS time.Time

+ type PinTracker interface

+ Recover func(*cid.Cid) error

+ Status func() []PinInfo

+ StatusCid func(*cid.Cid) PinInfo

+ Sync func(*cid.Cid) bool

+ Track func(*cid.Cid) error

+ Untrack func(*cid.Cid) error

+ type RESTAPI struct

+ func NewRESTAPI(cfg *Config) (*RESTAPI, error)

+ func (api *RESTAPI) SetClient(c *rpc.Client)

+ func (api *RESTAPI) Shutdown() error

+ type RPCAPI struct

+ func (api *RPCAPI) ConsensusLogPin(in *CidArg, out *struct{}) error

+ func (api *RPCAPI) ConsensusLogUnpin(in *CidArg, out *struct{}) error

+ func (api *RPCAPI) GlobalSync(in struct{}, out *[]GlobalPinInfo) error

+ func (api *RPCAPI) GlobalSyncCid(in *CidArg, out *GlobalPinInfo) error

+ func (api *RPCAPI) ID(in struct{}, out *ID) error

+ func (api *RPCAPI) IPFSIsPinned(in *CidArg, out *bool) error

+ func (api *RPCAPI) IPFSPin(in *CidArg, out *struct{}) error

+ func (api *RPCAPI) IPFSUnpin(in *CidArg, out *struct{}) error

+ func (api *RPCAPI) LocalSync(in struct{}, out *[]PinInfo) error

+ func (api *RPCAPI) LocalSyncCid(in *CidArg, out *PinInfo) error

+ func (api *RPCAPI) MemberList(in struct{}, out *[]peer.ID) error

+ func (api *RPCAPI) Pin(in *CidArg, out *struct{}) error

+ func (api *RPCAPI) PinList(in struct{}, out *[]string) error

+ func (api *RPCAPI) StateSync(in struct{}, out *[]PinInfo) error

+ func (api *RPCAPI) Status(in struct{}, out *[]GlobalPinInfo) error

+ func (api *RPCAPI) StatusCid(in *CidArg, out *GlobalPinInfo) error

+ func (api *RPCAPI) Track(in *CidArg, out *struct{}) error

+ func (api *RPCAPI) TrackerStatus(in struct{}, out *[]PinInfo) error

+ func (api *RPCAPI) TrackerStatusCid(in *CidArg, out *PinInfo) error

+ func (api *RPCAPI) Unpin(in *CidArg, out *struct{}) error

+ func (api *RPCAPI) Untrack(in *CidArg, out *struct{}) error

+ func (api *RPCAPI) Version(in struct{}, out *string) error

+ type RaftConfig struct

+ EnableSingleNode bool

+ SnapshotIntervalSeconds int

+ type State interface

+ AddPin func(*cid.Cid) error

+ HasPin func(*cid.Cid) bool

+ ListPins func() []*cid.Cid

+ RmPin func(*cid.Cid) error