eq_pipe_preserve

Documentation

Index

• Variables
• type Factory
  • func NewFactory(l esl.Logger, basePath string) Factory
  • func NopFactory() Factory
• type Preserver
  • func NewPreserver(l esl.Logger, basePath string) Preserver
  • func NopPreserver() Preserver
• type Restorer
  • func NewRestorer(l esl.Logger, basePath, sessionId string) Restorer
  • func NopRestorer() Restorer

Variables

var (
	ErrorPreserveIsNotSupported = errors.New("this pipe does not support preserve")
)

var (
	ErrorSessionIsNotAvailable = errors.New("session is not available")
)

Types

type Factory

type Factory interface {
	NewPreserver() Preserver

	NewRestorer(sessionId string) Restorer
}

func NewFactory

func NewFactory(l esl.Logger, basePath string) Factory

func NopFactory

func NopFactory() Factory

type Preserver

type Preserver interface {
	// Start preserve session
	Start() error

	// Add data to the preserver
	// Persistent store will be cleaned up when the operation failure.
	Add(d []byte) error

	// Commit data to the persistent store
	// Persistent store will be cleaned up when the operation failure.
	Commit(info []byte) (sessionId string, err error)
}

func NewPreserver

func NewPreserver(l esl.Logger, basePath string) Preserver

func NopPreserver

func NopPreserver() Preserver

type Restorer

type Restorer interface {
	// Restore
	Restore(infoLoader func(info []byte) error, loader func(d []byte) error) error
}

func NewRestorer

func NewRestorer(l esl.Logger, basePath, sessionId string) Restorer

func NopRestorer

func NopRestorer() Restorer