water

Documentation

Overview

Package water provides the watermark type.

Index

• type Mark
  • func NewMark(value uint64) Mark
  • func (m Mark) Add(value uint64) Mark
  • func (m Mark) Compare(other Mark) int
  • func (m Mark) Value() uint64

Types

type Mark

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

Mark is wrapper for uint64 representing a watermark, or a logical timestamp. Some implementations use an actual timestamp in micro- or nanoseconds, some use more generic sequence numbers.

func NewMark

func NewMark(value uint64) Mark

NewMark returns a watermark from the given integer value.

func (Mark) Add

func (m Mark) Add(value uint64) Mark

Add increments the watermark by the passed in value.

func (Mark) Compare

func (m Mark) Compare(other Mark) int

Compare returns the result of comparing this Mark with with the other.

func (Mark) Value

func (m Mark) Value() uint64

Value returns the uint64 representation of the watermark.