cache

Documentation

Index

• Variables
• func FullAvailabilityWithLocalRandSquare(t *testing.T, n int) (share.Availability, *share.Root)
• func LightAvailabilityWithLocalRandSquare(t *testing.T, n int) (share.Availability, *share.Root)
• type ShareAvailability
  • func NewShareAvailability(avail share.Availability, ds datastore.Batching) *ShareAvailability
  • func (ca *ShareAvailability) Close(ctx context.Context) error
  • func (ca *ShareAvailability) ProbabilityOfAvailability(ctx context.Context) float64
  • func (ca *ShareAvailability) SharesAvailable(ctx context.Context, root *share.Root, _ ...peer.ID) error

Variables

var (
	// DefaultWriteBatchSize defines the size of the batched header write.
	// Headers are written in batches not to thrash the underlying Datastore with writes.
	// TODO(@Wondertan, @renaynay): Those values must be configurable and proper defaults should be set
	// for specific node  type. (#709)
	DefaultWriteBatchSize = 2048
)

Functions

func FullAvailabilityWithLocalRandSquare

func FullAvailabilityWithLocalRandSquare(t *testing.T, n int) (share.Availability, *share.Root)

FullAvailabilityWithLocalRandSquare wraps full.GetterWithRandSquare with cache availability

func LightAvailabilityWithLocalRandSquare

func LightAvailabilityWithLocalRandSquare(t *testing.T, n int) (share.Availability, *share.Root)

LightAvailabilityWithLocalRandSquare wraps light.GetterWithRandSquare with cache availability

Types

type ShareAvailability

type ShareAvailability struct {
	// contains filtered or unexported fields
}

ShareAvailability wraps a given share.Availability (whether it's light or full) and stores the results of a successful sampling routine over a given Root's hash to disk.

func NewShareAvailability

func NewShareAvailability(avail share.Availability, ds datastore.Batching) *ShareAvailability

NewShareAvailability wraps the given share.Availability with an additional datastore for sampling result caching.

func (*ShareAvailability) Close

func (ca *ShareAvailability) Close(ctx context.Context) error

Close flushes all queued writes to disk.

func (*ShareAvailability) ProbabilityOfAvailability

func (ca *ShareAvailability) ProbabilityOfAvailability(ctx context.Context) float64

func (*ShareAvailability) SharesAvailable

func (ca *ShareAvailability) SharesAvailable(ctx context.Context, root *share.Root, _ ...peer.ID) error

SharesAvailable will store, upon success, the hash of the given Root to disk.