fscache

package

v17.12.0-ce-rc4+incomp... Latest Latest Go to latest Published: Mar 23, 2020 License: Apache-2.0 Imports: 22 Imported by: 0

Details

This section is empty.

This section is empty.

This section is empty.

type Backend interface {
	Get(id string) (string, error)
	Remove(id string) error
}

Backend is a backing implementation for FSCache

func NewNaiveCacheBackend(root string) Backend

NewNaiveCacheBackend is a basic backend implementation for fscache

type CachePolicy struct {
	Priority int
	LastUsed time.Time
}

CachePolicy defines policy for keeping a resource in cache

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

FSCache allows syncing remote resources to cached snapshots

func NewFSCache(opt Opt) (*FSCache, error)

NewFSCache returns new FSCache object

func (fsc *FSCache) Close() error

Close stops the gc and closes the persistent db

func (fsc *FSCache) DiskUsage() (int64, error)

DiskUsage reports how much data is allocated by the cache

func (fsc *FSCache) Prune(ctx context.Context) (uint64, error)

Prune allows manually cleaning up the cache

func (fsc *FSCache) RegisterTransport(id string, transport Transport) error

RegisterTransport registers a new transport method

func (fsc *FSCache) SyncFrom(ctx context.Context, id RemoteIdentifier) (builder.Source, error)

SyncFrom returns a source based on a remote identifier

type GCPolicy struct {
	MaxSize         uint64
	MaxKeepDuration time.Duration
}

GCPolicy defines policy for garbage collection

type Opt struct {
	Backend  Backend
	Root     string // for storing local metadata
	GCPolicy GCPolicy
}

Opt defines options for initializing FSCache

type RemoteIdentifier interface {
	Key() string
	SharedKey() string
	Transport() string
}

RemoteIdentifier identifies a transfer request

type Transport interface {
	Copy(ctx context.Context, id RemoteIdentifier, dest string, cs filesync.CacheUpdater) error
}

Transport defines a method for syncing remote data to FSCache