markers

package
v0.1.3 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Oct 3, 2023 License: Apache-2.0, BSD-2-Clause Imports: 20 Imported by: 0

Documentation

Index

Constants

This section is empty.

Variables

View Source 
var DefaultManagerOptions = &ManagerOptions{
	Store:                 mapdb.NewMapDB(),
	CacheTime:             30 * time.Second,
	MaxPastMarkerDistance: 30,
}

DefaultManagerOptions defines the default options for the Manager.

Functions

This section is empty.

Types

type IncreaseIndexCallback 

type IncreaseIndexCallback func(sequenceID SequenceID, currentHighestIndex Index) bool

IncreaseIndexCallback is the type of the callback function that is used to determine if a new Index is supposed to be assigned in a given Sequence.

type Index 

type Index uint64

Index represents the ever-increasing number of the Markers in a Sequence.

func (Index) Length 

func (i Index) Length() int

Length returns the amount of bytes of a serialized Index.

func (Index) String 

func (i Index) String() (humanReadable string)

String returns a human-readable version of the Index.

type Manager 

type Manager struct {
	Options *ManagerOptions
	// contains filtered or unexported fields
}

Manager is the managing entity for the Marker related business logic. It is stateful and automatically stores its state in a KVStore.

func NewManager 

func NewManager(options ...ManagerOption) (newManager *Manager)

NewManager is the constructor of the Manager that takes a KVStore to persist its state.

func (*Manager) InheritStructureDetails 

func (m *Manager) InheritStructureDetails(referencedStructureDetails []*StructureDetails, increaseIndexCallback IncreaseIndexCallback) (inheritedStructureDetails *StructureDetails, newSequenceCreated bool)

InheritStructureDetails takes the StructureDetails of the referenced parents and returns new StructureDetails for the block that was just added to the DAG. It automatically creates a new Sequence and Index if necessary and returns an additional flag that indicates if a new Sequence was created. InheritStructureDetails inherits the structure details of the given parent StructureDetails.

func (*Manager) Sequence 

func (m *Manager) Sequence(sequenceID SequenceID) *objectstorage.CachedObject[*Sequence]

Sequence retrieves a Sequence from the object storage.

func (*Manager) Shutdown 

func (m *Manager) Shutdown()

Shutdown shuts down the Manager and persists its state.

type ManagerOption 

type ManagerOption func(options *ManagerOptions)

ManagerOption represents the return type of optional parameters that can be handed into the constructor of the Manager to configure its behavior.

func WithCacheTime 

func WithCacheTime(cacheTime time.Duration) ManagerOption

WithCacheTime is an option for the Manager that allows to specify how long objects should be cached in the object storage.

func WithMaxPastMarkerDistance 

func WithMaxPastMarkerDistance(distance uint64) ManagerOption

WithMaxPastMarkerDistance is an Option for the Manager that allows to specify how many consecutive blocks are allowed to not receive a new PastMaster before we create a new Sequence.

func WithStore 

func WithStore(store kvstore.KVStore) ManagerOption

WithStore is an option for the Manager that allows to specify which storage layer is supposed to be used to persist data.

type ManagerOptions 

type ManagerOptions struct {
	// Store is a parameter for the Manager that allows to specify which storage layer is supposed to be used to persist
	// data.
	Store kvstore.KVStore

	// CacheTime is a parameter for the Manager that allows to specify how long objects should be cached in the object
	// storage.
	CacheTime time.Duration

	// MaxPastMarkerDistance is a parameter for the Manager that allows to specify how many consecutive blocks are
	// allowed to not receive a new PastMaster before we create a new Sequence.
	MaxPastMarkerDistance uint64
}

ManagerOptions is a container for all configurable parameters of the Manager.

func (*ManagerOptions) Apply 

func (m *ManagerOptions) Apply(options ...ManagerOption) (managerOptions *ManagerOptions)

Apply applies the given options to the ManagerOptions object.

type Marker 

type Marker struct {
	model.Immutable[Marker, *Marker, markerModel] `serix:"0"`
}

Marker represents a coordinate in a Sequence that is identified by an ever-increasing Index.

func NewMarker 

func NewMarker(sequenceID SequenceID, index Index) Marker

NewMarker returns a new marker.

func (Marker) Bytes 

func (m Marker) Bytes() (serialized []byte)

Bytes returns a serialized version of the Marker.

func (Marker) Index 

func (m Marker) Index() (index Index)

Index returns the coordinate of the Marker in a Sequence.

func (Marker) SequenceID 

func (m Marker) SequenceID() (sequenceID SequenceID)

SequenceID returns the identifier of the Sequence of the Marker.

type Markers 

type Markers struct {
	model.Mutable[Markers, *Markers, markersModel] `serix:"0"`
}

Markers represents a collection of Markers that can contain exactly one Index per SequenceID.

func NewMarkers 

func NewMarkers(markers ...Marker) (new *Markers)

NewMarkers creates a new collection of Markers.

func (*Markers) Bytes 

func (m *Markers) Bytes() []byte

Bytes returns a marshaled version of the Markers.

func (*Markers) Clone 

func (m *Markers) Clone() (cloned *Markers)

Clone creates a deep copy of the Markers.

func (*Markers) Delete 

func (m *Markers) Delete(sequenceID SequenceID) (existed bool)

Delete removes the Marker with the given SequenceID from the collection and returns a boolean flag that indicates if the element existed.

func (*Markers) Equals 

func (m *Markers) Equals(other *Markers) (equals bool)

Equals is a comparator for two Markers.

func (*Markers) ForEach 

func (m *Markers) ForEach(iterator func(sequenceID SequenceID, index Index) bool) (success bool)

ForEach calls the iterator for each of the contained Markers. The iteration is aborted if the iterator returns false. The method returns false if the iteration was aborted.

func (*Markers) ForEachSorted 

func (m *Markers) ForEachSorted(iterator func(sequenceID SequenceID, index Index) bool) (success bool)

ForEachSorted calls the iterator for each of the contained Markers in increasing order. The iteration is aborted if the iterator returns false. The method returns false if the iteration was aborted.

func (*Markers) Get 

func (m *Markers) Get(sequenceID SequenceID) (index Index, exists bool)

Get returns the Index of the Marker with the given Sequence and a flag that indicates if the Marker exists.

func (*Markers) HighestIndex 

func (m *Markers) HighestIndex() (highestIndex Index)

HighestIndex returns the highest Index of all Markers in the collection.

func (*Markers) LowestIndex 

func (m *Markers) LowestIndex() (lowestIndex Index)

LowestIndex returns the lowest Index of all Markers in the collection.

func (*Markers) Marker 

func (m *Markers) Marker() (marker Marker)

Marker type casts the Markers to a Marker if it contains only 1 element.

func (*Markers) Merge 

func (m *Markers) Merge(markers *Markers)

Merge takes the given Markers and adds them to the collection (overwriting Markers with a lower Index if there are existing Markers with the same SequenceID).

func (*Markers) Set 

func (m *Markers) Set(sequenceID SequenceID, index Index) (updated, added bool)

Set adds a new Marker to the collection and updates the Index of an existing entry if it is higher than a possible previously stored one. The method returns two boolean flags that indicate if an entry was updated and/or added.

func (*Markers) Size 

func (m *Markers) Size() (size int)

Size returns the amount of Markers in the collection.

type ReferencedMarkers 

type ReferencedMarkers struct {
	model.Mutable[ReferencedMarkers, *ReferencedMarkers, referencedMarkersModel] `serix:"0"`
}

ReferencedMarkers is a data structure that allows to denote which Marker of a Sequence references which other Markers of its parent Sequences in the Sequence DAG.

func NewReferencedMarkers 

func NewReferencedMarkers(markers *Markers) (new *ReferencedMarkers)

NewReferencedMarkers is the constructor for the ReferencedMarkers.

func (*ReferencedMarkers) Add 

func (r *ReferencedMarkers) Add(index Index, referencedMarkers *Markers)

Add adds new referenced Markers to the ReferencedMarkers.

func (*ReferencedMarkers) Get 

func (r *ReferencedMarkers) Get(index Index) (referencedMarkers *Markers)

Get returns the Markers of parent Sequences that were referenced by the given Index.

func (*ReferencedMarkers) String 

func (r *ReferencedMarkers) String() (humanReadableReferencedMarkers string)

String returns a human-readable version of the ReferencedMarkers.

type ReferencingMarkers 

type ReferencingMarkers struct {
	model.Mutable[ReferencingMarkers, *ReferencingMarkers, referencingMarkersModel] `serix:"0"`
}

ReferencingMarkers is a data structure that allows to denote which Markers of child Sequences in the Sequence DAG reference a given Marker in a Sequence.

func NewReferencingMarkers 

func NewReferencingMarkers() (referencingMarkers *ReferencingMarkers)

NewReferencingMarkers is the constructor for the ReferencingMarkers.

func (*ReferencingMarkers) Add 

func (r *ReferencingMarkers) Add(index Index, referencingMarker Marker)

Add adds a new referencing Marker to the ReferencingMarkers.

func (*ReferencingMarkers) Get 

func (r *ReferencingMarkers) Get(index Index) (referencingMarkers *Markers)

Get returns the Markers of child Sequences that reference the given Index.

func (*ReferencingMarkers) String 

func (r *ReferencingMarkers) String() (humanReadableReferencingMarkers string)

String returns a human-readable version of the ReferencingMarkers.

type Sequence 

type Sequence struct {
	model.Storable[SequenceID, Sequence, *Sequence, sequenceModel] `serix:"0"`
}

Sequence represents a set of ever-increasing Indexes that are encapsulating a certain part of the DAG.

func NewSequence 

func NewSequence(id SequenceID, referencedMarkers *Markers) (new *Sequence)

NewSequence creates a new Sequence from the given details.

func (*Sequence) AddReferencingMarker 

func (s *Sequence) AddReferencingMarker(index Index, referencingMarker Marker)

AddReferencingMarker register a Marker that referenced the given Index of this Sequence.

func (*Sequence) HighestIndex 

func (s *Sequence) HighestIndex() Index

HighestIndex returns the Index of the latest Marker in the Sequence.

func (*Sequence) IncreaseHighestIndex 

func (s *Sequence) IncreaseHighestIndex(referencedMarkers *Markers) (index Index, increased bool)

IncreaseHighestIndex increases the highest Index of the Sequence if the referencedMarkers directly reference the Marker with the highest Index. It returns the new Index and a boolean flag that indicates if the value was increased.

func (*Sequence) LowestIndex 

func (s *Sequence) LowestIndex() Index

LowestIndex returns the Index of the very first Marker in the Sequence.

func (*Sequence) ReferencedMarkers 

func (s *Sequence) ReferencedMarkers(index Index) *Markers

ReferencedMarkers returns a collection of Markers that were referenced by the given Index.

func (*Sequence) ReferencingMarkers 

func (s *Sequence) ReferencingMarkers(index Index) *Markers

ReferencingMarkers returns a collection of Markers that reference the given Index.

func (*Sequence) TryExtend 

func (s *Sequence) TryExtend(referencedPastMarkers *Markers, increaseIndexCallback IncreaseIndexCallback) (index Index, remainingReferencedPastMarkers *Markers, extended bool)

TryExtend tries to extend the Sequence with a new Index by checking if the referenced PastMarkers contain the last assigned Index of the Sequence. It returns the new Index, the remaining Markers pointing to other Sequences and a boolean flag that indicating if a new Index was assigned.

type SequenceID 

type SequenceID uint64

SequenceID is the type of the identifier of a Sequence.

func (SequenceID) Bytes 

func (s SequenceID) Bytes() (marshaledSequenceID []byte)

Bytes returns a marshaled version of the SequenceID.

func (*SequenceID) FromBytes 

func (s *SequenceID) FromBytes(data []byte) (err error)

FromBytes unmarshals a SequenceID from a sequence of bytes.

func (SequenceID) Length 

func (s SequenceID) Length() int

Length returns the length of a serialized SequenceID.

func (SequenceID) String 

func (s SequenceID) String() (humanReadableSequenceID string)

String returns a human-readable version of the SequenceID.

type SequenceIDs 

type SequenceIDs map[SequenceID]types.Empty

SequenceIDs represents a collection of SequenceIDs.

func NewSequenceIDs 

func NewSequenceIDs(sequenceIDs ...SequenceID) (result SequenceIDs)

NewSequenceIDs creates a new collection of SequenceIDs.

func (SequenceIDs) String 

func (s SequenceIDs) String() (humanReadableSequenceIDs string)

String returns a human-readable version of the SequenceIDs.

type StructureDetails 

type StructureDetails struct {
	model.Mutable[StructureDetails, *StructureDetails, structureDetailsModel] `serix:"0"`
}

StructureDetails represents a container for the complete Marker related information of a node in a DAG that are used to interact with the public API of this package.

func NewStructureDetails 

func NewStructureDetails() (newStructureDetails *StructureDetails)

NewStructureDetails creates an empty StructureDetails object.

func (*StructureDetails) Clone 

func (m *StructureDetails) Clone() (clone *StructureDetails)

Clone creates a deep copy of the StructureDetails.

func (*StructureDetails) IsPastMarker 

func (m *StructureDetails) IsPastMarker() (isPastMarker bool)

func (*StructureDetails) PastMarkerGap 

func (m *StructureDetails) PastMarkerGap() (pastMarkerGap uint64)

func (*StructureDetails) PastMarkers 

func (m *StructureDetails) PastMarkers() (pastMarkers *Markers)

func (*StructureDetails) Rank 

func (m *StructureDetails) Rank() (rank uint64)

func (*StructureDetails) SetIsPastMarker 

func (m *StructureDetails) SetIsPastMarker(isPastMarker bool)

func (*StructureDetails) SetPastMarkerGap 

func (m *StructureDetails) SetPastMarkerGap(pastMarkerGap uint64)

func (*StructureDetails) SetPastMarkers 

func (m *StructureDetails) SetPastMarkers(pastMarkers *Markers)

func (*StructureDetails) SetRank 

func (m *StructureDetails) SetRank(rank uint64)

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.