getter

Documentation

Index

• Constants
• Variables
• func New(addrs []swarm.Address, shardCnt int, g storage.Getter, p storage.Putter, ...) storage.Getter
• func SetConfigInContext(ctx context.Context, s *Strategy, fallbackmode *bool, fetchTimeout *string, ...) (context.Context, error)
• func SetFetchTimeout(ctx context.Context, timeout time.Duration) context.Context
• func SetLogger(ctx context.Context, l log.Logger) context.Context
• func SetStrategy(ctx context.Context, s Strategy) context.Context
• func SetStrict(ctx context.Context, strict bool) context.Context
• type Config
  • func NewConfigFromContext(ctx context.Context, def Config) (conf Config, err error)
• type Strategy

Constants

const (
	DefaultStrategy     = DATA                           // default prefetching strategy
	DefaultStrict       = false                          // default fallback modes
	DefaultFetchTimeout = retrieval.RetrieveChunkTimeout // timeout for each chunk retrieval
)

Variables

var DefaultConfig = Config{
	Strategy:     DefaultStrategy,
	Strict:       DefaultStrict,
	FetchTimeout: DefaultFetchTimeout,
	Logger:       log.Noop,
}

DefaultConfig is the default configuration for the getter

Functions

func New

func New(addrs []swarm.Address, shardCnt int, g storage.Getter, p storage.Putter, remove func(error), conf Config) storage.Getter

New returns a decoder object used to retrieve children of an intermediate chunk

func SetConfigInContext

func SetConfigInContext(ctx context.Context, s *Strategy, fallbackmode *bool, fetchTimeout *string, logger log.Logger) (context.Context, error)

SetConfigInContext sets the config params in the context

func SetFetchTimeout

func SetFetchTimeout(ctx context.Context, timeout time.Duration) context.Context

SetFetchTimeout sets the timeout for each fetch

func SetLogger

func SetLogger(ctx context.Context, l log.Logger) context.Context

func SetStrategy

func SetStrategy(ctx context.Context, s Strategy) context.Context

SetStrategy sets the strategy for the retrieval

func SetStrict

func SetStrict(ctx context.Context, strict bool) context.Context

SetStrict sets the strict mode for the retrieval

Types

type Config

type Config struct {
	Strategy     Strategy
	Strict       bool
	FetchTimeout time.Duration
	Logger       log.Logger
}

Config is the configuration for the getter - public

func NewConfigFromContext

func NewConfigFromContext(ctx context.Context, def Config) (conf Config, err error)

NewConfigFromContext returns a new Config based on the context

type Strategy

type Strategy = int

const (
	NONE Strategy = iota // no prefetching and no decoding
	DATA                 // just retrieve data shards no decoding
	PROX                 // proximity driven selective fetching
	RACE                 // aggressive fetching racing all chunks

)