reserve

Documentation

Index

• func RemoveChunkWithItem(ctx context.Context, trx transaction.Store, item *BatchRadiusItem) error
• type BatchRadiusItem
  • func (b *BatchRadiusItem) Clone() storage.Item
  • func (b *BatchRadiusItem) ID() string
  • func (b *BatchRadiusItem) Marshal() ([]byte, error)
  • func (b *BatchRadiusItem) Namespace() string
  • func (b *BatchRadiusItem) String() string
  • func (b *BatchRadiusItem) Unmarshal(buf []byte) error
• type BinItem
  • func (b *BinItem) Clone() storage.Item
  • func (b *BinItem) ID() string
  • func (c *BinItem) Marshal() ([]byte, error)
  • func (b *BinItem) Namespace() string
  • func (c *BinItem) String() string
  • func (c *BinItem) Unmarshal(buf []byte) error
• type ChunkBinItem
  • func (c *ChunkBinItem) Clone() storage.Item
  • func (c *ChunkBinItem) ID() string
  • func (c *ChunkBinItem) Marshal() ([]byte, error)
  • func (c *ChunkBinItem) Namespace() string
  • func (c *ChunkBinItem) String() string
  • func (c *ChunkBinItem) Unmarshal(buf []byte) error
• type EpochItem
  • func (e *EpochItem) Clone() storage.Item
  • func (e *EpochItem) ID() string
  • func (e *EpochItem) Marshal() ([]byte, error)
  • func (e *EpochItem) Namespace() string
  • func (e *EpochItem) String() string
  • func (e *EpochItem) Unmarshal(buf []byte) error
• type Reserve
  • func New(baseAddr swarm.Address, st transaction.Storage, capacity int, ...) (*Reserve, error)
  • func (r *Reserve) Capacity() int
  • func (r *Reserve) EvictBatchBin(ctx context.Context, batchID []byte, count int, bin uint8) (int, error)
  • func (r *Reserve) EvictionTarget() int
  • func (r *Reserve) Get(ctx context.Context, addr swarm.Address, batchID []byte) (swarm.Chunk, error)
  • func (r *Reserve) Has(addr swarm.Address, batchID []byte) (bool, error)
  • func (r *Reserve) IncBinID(store storage.IndexStore, bin uint8) (uint64, error)
  • func (r *Reserve) IsWithinCapacity() bool
  • func (r *Reserve) IterateBin(bin uint8, startBinID uint64, ...) error
  • func (r *Reserve) IterateChunks(startBin uint8, cb func(swarm.Chunk) (bool, error)) error
  • func (r *Reserve) IterateChunksItems(startBin uint8, cb func(*ChunkBinItem) (bool, error)) error
  • func (r *Reserve) LastBinIDs() ([]uint64, uint64, error)
  • func (r *Reserve) Put(ctx context.Context, chunk swarm.Chunk) error
  • func (r *Reserve) Radius() uint8
  • func (r *Reserve) SetRadius(rad uint8) error
  • func (r *Reserve) Size() int

Functions

func RemoveChunkWithItem

func RemoveChunkWithItem(
	ctx context.Context,
	trx transaction.Store,
	item *BatchRadiusItem,
) error

Types

type BatchRadiusItem

type BatchRadiusItem struct {
	Bin     uint8
	BatchID []byte
	Address swarm.Address
	BinID   uint64
}

BatchRadiusItem allows iteration of the chunks with respect to bin and batchID. Used for batch evictions of certain bins.

func (*BatchRadiusItem) Clone

func (b *BatchRadiusItem) Clone() storage.Item

func (*BatchRadiusItem) ID

func (b *BatchRadiusItem) ID() string

batchID/bin/ChunkAddr

func (*BatchRadiusItem) Marshal

func (b *BatchRadiusItem) Marshal() ([]byte, error)

func (*BatchRadiusItem) Namespace

func (b *BatchRadiusItem) Namespace() string

func (*BatchRadiusItem) String

func (b *BatchRadiusItem) String() string

func (*BatchRadiusItem) Unmarshal

func (b *BatchRadiusItem) Unmarshal(buf []byte) error

type BinItem

type BinItem struct {
	Bin   uint8
	BinID uint64
}

BinItem stores the latest binIDs for each bin between 0 and swarm.MaxBins

func (*BinItem) Clone

func (b *BinItem) Clone() storage.Item

func (*BinItem) ID

func (b *BinItem) ID() string

func (*BinItem) Marshal

func (c *BinItem) Marshal() ([]byte, error)

func (*BinItem) Namespace

func (b *BinItem) Namespace() string

func (*BinItem) String

func (c *BinItem) String() string

func (*BinItem) Unmarshal

func (c *BinItem) Unmarshal(buf []byte) error

type ChunkBinItem

type ChunkBinItem struct {
	Bin       uint8
	BinID     uint64
	Address   swarm.Address
	BatchID   []byte
	ChunkType swarm.ChunkType
}

ChunkBinItem allows for iterating on ranges of bin and binIDs for chunks. BinIDs come in handy when syncing the reserve contents with other peers.

func (*ChunkBinItem) Clone

func (c *ChunkBinItem) Clone() storage.Item

func (*ChunkBinItem) ID

func (c *ChunkBinItem) ID() string

bin/binID

func (*ChunkBinItem) Marshal

func (c *ChunkBinItem) Marshal() ([]byte, error)

func (*ChunkBinItem) Namespace

func (c *ChunkBinItem) Namespace() string

func (*ChunkBinItem) String

func (c *ChunkBinItem) String() string

func (*ChunkBinItem) Unmarshal

func (c *ChunkBinItem) Unmarshal(buf []byte) error

type EpochItem

type EpochItem struct {
	Timestamp uint64
}

EpochItem stores the timetamp in seconds of the initial creation of the reserve.

func (*EpochItem) Clone

func (e *EpochItem) Clone() storage.Item

func (*EpochItem) ID

func (e *EpochItem) ID() string

func (*EpochItem) Marshal

func (e *EpochItem) Marshal() ([]byte, error)

func (*EpochItem) Namespace

func (e *EpochItem) Namespace() string

func (*EpochItem) String

func (e *EpochItem) String() string

func (*EpochItem) Unmarshal

func (e *EpochItem) Unmarshal(buf []byte) error

type Reserve

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

func New

func New(
	baseAddr swarm.Address,
	st transaction.Storage,
	capacity int,
	radiusSetter topology.SetStorageRadiuser,
	logger log.Logger,
) (*Reserve, error)

func (*Reserve) Capacity

func (r *Reserve) Capacity() int

func (*Reserve) EvictBatchBin

func (r *Reserve) EvictBatchBin(
	ctx context.Context,
	batchID []byte,
	count int,
	bin uint8,
) (int, error)

EvictBatchBin evicts all chunks from bins upto the bin provided.

func (*Reserve) EvictionTarget

func (r *Reserve) EvictionTarget() int

func (*Reserve) Get

func (r *Reserve) Get(ctx context.Context, addr swarm.Address, batchID []byte) (swarm.Chunk, error)

func (*Reserve) Has

func (r *Reserve) Has(addr swarm.Address, batchID []byte) (bool, error)

func (*Reserve) IncBinID

func (r *Reserve) IncBinID(store storage.IndexStore, bin uint8) (uint64, error)

func (*Reserve) IsWithinCapacity

func (r *Reserve) IsWithinCapacity() bool

func (*Reserve) IterateBin

func (r *Reserve) IterateBin(bin uint8, startBinID uint64, cb func(swarm.Address, uint64, []byte) (bool, error)) error

func (*Reserve) IterateChunks

func (r *Reserve) IterateChunks(startBin uint8, cb func(swarm.Chunk) (bool, error)) error

func (*Reserve) IterateChunksItems

func (r *Reserve) IterateChunksItems(startBin uint8, cb func(*ChunkBinItem) (bool, error)) error

func (*Reserve) LastBinIDs

func (r *Reserve) LastBinIDs() ([]uint64, uint64, error)

func (*Reserve) Put

func (r *Reserve) Put(ctx context.Context, chunk swarm.Chunk) error

Put stores a new chunk in the reserve and returns if the reserve size should increase.

func (*Reserve) Radius

func (r *Reserve) Radius() uint8

func (*Reserve) SetRadius

func (r *Reserve) SetRadius(rad uint8) error

func (*Reserve) Size

func (r *Reserve) Size() int