version

Documentation

Index

• Variables
• func MinVersionFromContext(ctx context.Context) (int, bool)
• func NewContextWithMinVersion(ctx context.Context, minVersion int) context.Context
• func NewContextWithMinVersionWait(ctx context.Context, minVersion int) (c context.Context, cancel func())
• type Repo
  • func NewRepo(repo eh.ReadWriteRepo) *Repo
  • func Repository(repo eh.ReadRepo) *Repo
  • func (r *Repo) Find(ctx context.Context, id uuid.UUID) (eh.Entity, error)
  • func (r *Repo) Parent() eh.ReadRepo

Variables

var DefaultMinVersionDeadline = 10 * time.Second

DefaultMinVersionDeadline is the deadline to use when creating a min version context that waits.

Functions

func MinVersionFromContext

func MinVersionFromContext(ctx context.Context) (int, bool)

MinVersionFromContext returns the min version from the context.

func NewContextWithMinVersion

func NewContextWithMinVersion(ctx context.Context, minVersion int) context.Context

NewContextWithMinVersion returns the context with min version set.

func NewContextWithMinVersionWait

func NewContextWithMinVersionWait(ctx context.Context, minVersion int) (c context.Context, cancel func())

NewContextWithMinVersionWait returns the context with min version and a default deadline set.

Types

type Repo

type Repo struct {
	eh.ReadWriteRepo
}

Repo is a middleware that adds version checking to a read repository.

func NewRepo

func NewRepo(repo eh.ReadWriteRepo) *Repo

NewRepo creates a new Repo.

func Repository

func Repository(repo eh.ReadRepo) *Repo

Repository returns a parent ReadRepo if there is one.

func (*Repo) Find

func (r *Repo) Find(ctx context.Context, id uuid.UUID) (eh.Entity, error)

Find implements the Find method of the eventhorizon.ReadModel interface. If the context contains a min version set by WithMinVersion it will only return an item if its version is at least min version. If a timeout or deadline is set on the context it will repetedly try to get the item until either the version matches or the deadline is reached.

func (*Repo) Parent

func (r *Repo) Parent() eh.ReadRepo

Parent implements the Parent method of the eventhorizon.ReadRepo interface.