writecacheconfig

Documentation

Index

• Constants
• type Config
  • func From(c *config.Config) *Config
  • func (x *Config) CountLimit() uint64
  • func (x *Config) Enabled() bool
  • func (x *Config) MaxFlushingObjectsSize() uint64
  • func (x *Config) MaxObjectSize() uint64
  • func (x *Config) NoSync() bool
  • func (x *Config) Path() string
  • func (x *Config) SizeLimit() uint64
  • func (x *Config) WorkerCount() int

Constants

const (
	// MaxSizeDefault is a default value of the object payload size limit.
	MaxSizeDefault = 64 << 20

	// WorkersNumberDefault is a default number of workers.
	WorkersNumberDefault = 20

	// SizeLimitDefault is a default write-cache size limit.
	SizeLimitDefault = 1 << 30

	// CountLimitDefault is a default write-cache count limit.
	CountLimitDefault = 0

	MaxFlushingObjectsSizeDefault = 128 << 20
)

Types

type Config

type Config config.Config

Config is a wrapper over the config section which provides access to WriteCache configurations.

func From

func From(c *config.Config) *Config

From wraps config section into Config.

func (*Config) CountLimit

func (x *Config) CountLimit() uint64

CountLimit returns the value of "max_object_count" config parameter.

Returns CountLimitDefault if the value is not a positive number.

func (*Config) Enabled

func (x *Config) Enabled() bool

Enabled returns true if write-cache is enabled and false otherwise.

Panics if the value is not a boolean.

func (*Config) MaxFlushingObjectsSize

func (x *Config) MaxFlushingObjectsSize() uint64

MaxFlushingObjectsSize returns the value of "max_flushing_objects_size" config parameter.

Returns MaxFlushingObjectsSizeDefault if the value is not a positive number.

func (*Config) MaxObjectSize

func (x *Config) MaxObjectSize() uint64

MaxObjectSize returns the value of "max_object_size" config parameter.

Returns MaxSizeDefault if the value is not a positive number.

func (*Config) NoSync

func (x *Config) NoSync() bool

NoSync returns the value of "no_sync" config parameter.

Returns false if the value is not a boolean.

func (*Config) Path

func (x *Config) Path() string

Path returns the value of "path" config parameter.

Panics if the value is not a non-empty string.

func (*Config) SizeLimit

func (x *Config) SizeLimit() uint64

SizeLimit returns the value of "capacity" config parameter.

Returns SizeLimitDefault if the value is not a positive number.

func (*Config) WorkerCount

func (x *Config) WorkerCount() int

WorkerCount returns the value of "flush_worker_count" config parameter.

Returns WorkersNumberDefault if the value is not a positive number.