chunkstore

Documentation

Index

• Constants
• func Iterate(st storage.Store, callBackFunc func(*RetrievalIndexItem) error) error
• func IterateChunkEntries(st storage.Store, fn func(swarm.Address, bool) (bool, error)) error
• func IterateLocations(ctx context.Context, st storage.Store, locationResultC chan<- LocationResult)
• type ChunkStoreWrapper
  • func New(store storage.Store, sharky Sharky) *ChunkStoreWrapper
  • func (c *ChunkStoreWrapper) Close() error
  • func (c *ChunkStoreWrapper) Delete(ctx context.Context, addr swarm.Address) error
  • func (c *ChunkStoreWrapper) Get(ctx context.Context, addr swarm.Address) (swarm.Chunk, error)
  • func (c *ChunkStoreWrapper) Has(_ context.Context, addr swarm.Address) (bool, error)
  • func (c *ChunkStoreWrapper) Iterate(ctx context.Context, fn storage.IterateChunkFn) error
  • func (c *ChunkStoreWrapper) Put(ctx context.Context, ch swarm.Chunk) error
• type IterateResult
• type LocationResult
• type RetrievalIndexItem
  • func (r *RetrievalIndexItem) Clone() storage.Item
  • func (r *RetrievalIndexItem) ID() string
  • func (r *RetrievalIndexItem) Marshal() ([]byte, error)
  • func (RetrievalIndexItem) Namespace() string
  • func (r RetrievalIndexItem) String() string
  • func (r *RetrievalIndexItem) Unmarshal(buf []byte) error
• type Sharky
• type TxChunkStoreWrapper
  • func NewTxChunkStore(txStore storage.TxStore, csSharky Sharky) *TxChunkStoreWrapper
  • func (cs *TxChunkStoreWrapper) Commit() error
  • func (cs *TxChunkStoreWrapper) NewTx(state *storage.TxState) storage.TxChunkStore
  • func (cs *TxChunkStoreWrapper) Recover() error
  • func (cs *TxChunkStoreWrapper) Rollback() error

Constants

const RetrievalIndexItemSize = swarm.HashSize + 8 + sharky.LocationSize + 4

Functions

func Iterate

func Iterate(st storage.Store, callBackFunc func(*RetrievalIndexItem) error) error

Iterate iterates over entire retrieval index with a call back.

func IterateChunkEntries

func IterateChunkEntries(st storage.Store, fn func(swarm.Address, bool) (bool, error)) error

func IterateLocations

func IterateLocations(
	ctx context.Context,
	st storage.Store,
	locationResultC chan<- LocationResult,
)

IterateLocations iterates over entire retrieval index and plucks only sharky location.

Types

type ChunkStoreWrapper

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

func New

func New(store storage.Store, sharky Sharky) *ChunkStoreWrapper

func (*ChunkStoreWrapper) Close

func (c *ChunkStoreWrapper) Close() error

func (*ChunkStoreWrapper) Delete

func (c *ChunkStoreWrapper) Delete(ctx context.Context, addr swarm.Address) error

func (*ChunkStoreWrapper) Get

func (c *ChunkStoreWrapper) Get(ctx context.Context, addr swarm.Address) (swarm.Chunk, error)

func (*ChunkStoreWrapper) Has

func (c *ChunkStoreWrapper) Has(_ context.Context, addr swarm.Address) (bool, error)

func (*ChunkStoreWrapper) Iterate

func (c *ChunkStoreWrapper) Iterate(ctx context.Context, fn storage.IterateChunkFn) error

func (*ChunkStoreWrapper) Put

func (c *ChunkStoreWrapper) Put(ctx context.Context, ch swarm.Chunk) error

type IterateResult

type IterateResult struct {
	Err  error
	Item *RetrievalIndexItem
}

type LocationResult

type LocationResult struct {
	Err      error
	Location sharky.Location
}

type RetrievalIndexItem

type RetrievalIndexItem struct {
	Address   swarm.Address
	Timestamp uint64
	Location  sharky.Location
	RefCnt    uint32
}

RetrievalIndexItem is the index which gives us the sharky location from the swarm.Address. The RefCnt stores the reference of each time a Put operation is issued on this Address.

func (*RetrievalIndexItem) Clone

func (r *RetrievalIndexItem) Clone() storage.Item

func (*RetrievalIndexItem) ID

func (r *RetrievalIndexItem) ID() string

func (*RetrievalIndexItem) Marshal

func (r *RetrievalIndexItem) Marshal() ([]byte, error)

Stored in bytes as: |--Address(32)--|--Timestamp(8)--|--Location(7)--|--RefCnt(4)--|

func (RetrievalIndexItem) Namespace

func (RetrievalIndexItem) Namespace() string

func (RetrievalIndexItem) String

func (r RetrievalIndexItem) String() string

func (*RetrievalIndexItem) Unmarshal

func (r *RetrievalIndexItem) Unmarshal(buf []byte) error

type Sharky

type Sharky interface {
	Read(context.Context, sharky.Location, []byte) error
	Write(context.Context, []byte) (sharky.Location, error)
	Release(context.Context, sharky.Location) error
}

Sharky provides an abstraction for the sharky.Store operations used in the chunkstore. This allows us to be more flexible in passing in the sharky instance to chunkstore. For eg, check the TxChunkStore implementation in this pkg.

type TxChunkStoreWrapper

type TxChunkStoreWrapper struct {
	*storage.TxChunkStoreBase
	// contains filtered or unexported fields
}

func NewTxChunkStore

func NewTxChunkStore(txStore storage.TxStore, csSharky Sharky) *TxChunkStoreWrapper

func (*TxChunkStoreWrapper) Commit

func (cs *TxChunkStoreWrapper) Commit() error

func (*TxChunkStoreWrapper) NewTx

func (cs *TxChunkStoreWrapper) NewTx(state *storage.TxState) storage.TxChunkStore

func (*TxChunkStoreWrapper) Recover

func (cs *TxChunkStoreWrapper) Recover() error

Recover attempts to recover from a previous crash by reverting all uncommitted transactions.

func (*TxChunkStoreWrapper) Rollback

func (cs *TxChunkStoreWrapper) Rollback() error