store

Documentation

Index

• Variables
• type Store
• type StoreProvider

Variables

var ReadStoreEmptyErr error = errors.New("error reading, store is empty")

var WriteStoreClosedErr error = errors.New("error writing, store is closed")

var WriteStoreFullErr error = errors.New("error writing, store is full")

Types

type Store

type Store interface {
	// Read returns upto N(size) messages from the persisted store, it also returns
	// a boolean flag to indicate if the end of file has been reached.
	Read(size int64) ([]*isb.ReadMessage, bool, error)
	// Write writes message to persistence store
	Write(msg *isb.ReadMessage) error
	// Close closes store
	Close() error
}

Store provides methods to read, write and delete data from the store.

type StoreProvider

type StoreProvider interface {
	// CreateStore returns a new store instance.
	CreateStore(context.Context, partition.ID) (Store, error)
	// DiscoverPartitions discovers all the managed partitions.
	DiscoverPartitions(context.Context) ([]partition.ID, error)
	// DeleteStore deletes the store
	DeleteStore(partition.ID) error
}

StoreProvider defines the functions for store implementation