eq_pipe

Documentation

Index

• Constants
• Variables
• type Factory
  • func NewSimple(l esl.Logger, f eq_pipe_preserve.Factory) Factory
  • func NewTransientSimple(l esl.Logger) Factory
• type Pipe
• type SessionId

Constants

const (
	SimpleFormatVersionFirst = iota + 1
)

Variables

var (
	ErrorIncompatibleSessionData = errors.New("incompatible session data")
)

Types

type Factory

type Factory interface {
	// Create a new pipe
	New(batchId string) Pipe

	// Restore a pipe from the session
	Restore(id SessionId) (pipe Pipe, err error)
}

Pipe factory

func NewSimple

func NewSimple(l esl.Logger, f eq_pipe_preserve.Factory) Factory

func NewTransientSimple

func NewTransientSimple(l esl.Logger) Factory

type Pipe

type Pipe interface {
	// Enqueue the data
	Enqueue(d []byte)

	// Dequeue the data from the pipe. Returns nil if the pipe is empty.
	Dequeue() (d []byte)

	// Delete the data.
	Delete(d []byte)

	// Size of the pipe.
	Size() int

	// Close & clean up this pipe.
	Close()

	// Close & preserve the state
	Preserve() (id SessionId, err error)
}

type SessionId

type SessionId string