Documentation
¶
Index ¶
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
func GetLatestNetworkMap ¶ added in v0.12.0
GetLatestNetworkMap requests and returns the latest network map from the storage.
Types ¶
type AnnouncedKeys ¶ added in v0.25.0
type AnnouncedKeys interface {
// Checks if the key was announced by a local node.
IsLocalKey(key []byte) bool
}
AnnouncedKeys is an interface of utility for working with the announced public keys of the storage nodes.
type Source ¶ added in v0.12.0
type Source interface {
// GetNetMap reads the diff-th past network map from the storage.
// Calling with zero diff returns the latest network map.
// It returns the pointer to the requested network map and any error encountered.
//
// GetNetMap must return exactly one non-nil value.
// GetNetMap must return ErrNotFound if the network map is not in the storage.
//
// Implementations must not retain the network map pointer and modify
// the network map through it.
GetNetMap(diff uint64) (*netmap.Netmap, error)
// GetNetMapByEpoch reads network map by the epoch number from the storage.
// It returns the pointer to the requested network map and any error encountered.
//
// Must return exactly one non-nil value.
//
// Implementations must not retain the network map pointer and modify
// the network map through it.
GetNetMapByEpoch(epoch uint64) (*netmap.Netmap, error)
// Epoch reads the current epoch from the storage.
// It returns thw number of the current epoch and any error encountered.
//
// Must return exactly one non-default value.
Epoch() (uint64, error)
}
Source is an interface that wraps basic network map receiving method.
Click to show internal directories.
Click to hide internal directories.