container

Documentation

Index

• Constants
• Variables
• func BuildChunkRecord(chunk []byte) []byte
• func CheckContainerHashFile(id int, filename, storedHash string) error
• func GetContainerMaxSize() int64
• func ReadChunkDataAt(c Container, offset int64, expectedSize int64) ([]byte, error)
• func SealContainer(tx db.DBTX, containerID int64, filename string) error
• func SetContainerMaxSize(size int64)
• func UpdateContainerSize(tx db.DBTX, containerID int64, newSize int64) error
• type ActiveContainer
  • func GetOrCreateOpenContainer(db db.DBTX) (ActiveContainer, error)
• type Container
• type FileContainer
  • func OpenExistingContainer(readonly bool, path string, maxSize int64) (*FileContainer, error)
  • func (c *FileContainer) Append(data []byte) (int64, error)
  • func (c *FileContainer) Close() error
  • func (c *FileContainer) ReadAt(offset int64, size int64) ([]byte, error)
  • func (c *FileContainer) Sync() error

Constants

const (
	ChunkHashSize         = 32
	ChunkRecordSizeSize   = 4
	ChunkRecordHeaderSize = ChunkHashSize + ChunkRecordSizeSize
)

const (
	ContainerMagic  = "ColdKeep" // must be exactly 8 bytes
	ContainerHdrLen = 64         // fixed header size in bytes
)

const (
	ContainerVersionMajor = 0
	ContainerVersionMinor = 6
)

const (
	FLAG_BLOCK_LAYOUT  = 1 << 0 // container uses block-based layout
	FLAG_HAS_BLOCK_TBL = 1 << 1 // optional block index present
)

Reserved future flags (not used yet)

Variables

var ContainersDir = utils_env.GetenvOrDefault("COLDKEEP_STORAGE_DIR", "./storage/containers")

Functions

func BuildChunkRecord

func BuildChunkRecord(chunk []byte) []byte

func CheckContainerHashFile

func CheckContainerHashFile(id int, filename, storedHash string) error

func GetContainerMaxSize

func GetContainerMaxSize() int64

GetContainerMaxSize returns the current container max size

func ReadChunkDataAt

func ReadChunkDataAt(c Container, offset int64, expectedSize int64) ([]byte, error)

func SealContainer

func SealContainer(tx db.DBTX, containerID int64, filename string) error

func SetContainerMaxSize

func SetContainerMaxSize(size int64)

SetContainerMaxSize sets the container max size (for testing)

func UpdateContainerSize

func UpdateContainerSize(tx db.DBTX, containerID int64, newSize int64) error

Types

type ActiveContainer

type ActiveContainer struct {
	ID        int64
	Filename  string
	Container Container
	MaxSize   int64
}

func GetOrCreateOpenContainer

func GetOrCreateOpenContainer(db db.DBTX) (ActiveContainer, error)

type Container

type Container interface {
	Append(data []byte) (offset int64, err error)
	ReadAt(offset int64, size int64) ([]byte, error)
	Sync() error
	Close() error
}

type FileContainer

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

func OpenExistingContainer

func OpenExistingContainer(readonly bool, path string, maxSize int64) (*FileContainer, error)

func (*FileContainer) Append

func (c *FileContainer) Append(data []byte) (int64, error)

func (*FileContainer) Close

func (c *FileContainer) Close() error

func (*FileContainer) ReadAt

func (c *FileContainer) ReadAt(offset int64, size int64) ([]byte, error)

func (*FileContainer) Sync

func (c *FileContainer) Sync() error