dag

Documentation

Index

• func ConeRootIndexes(ctx context.Context, dbStorage *storage.Storage, ...) (youngestConeRootIndex milestone.Index, oldestConeRootIndex milestone.Index, ...)
• func TraverseChildren(ctx context.Context, dbStorage *storage.Storage, ...) error
• func TraverseParents(ctx context.Context, dbStorage *storage.Storage, parents hornet.MessageIDs, ...) error
• func TraverseParentsOfMessage(ctx context.Context, dbStorage *storage.Storage, ...) error
• func UpdateConeRootIndexes(ctx context.Context, dbStorage *storage.Storage, ...) error
• type ChildrenTraverser
  • func NewChildrenTraverser(dbStorage *storage.Storage, metadataMemcache ...*storage.MetadataMemcache) *ChildrenTraverser
  • func (t *ChildrenTraverser) Cleanup(forceRelease bool)
  • func (t *ChildrenTraverser) Traverse(ctx context.Context, startMessageID hornet.MessageID, condition Predicate, ...) error
• type Consumer
• type OnMissingParent
• type OnSolidEntryPoint
• type ParentTraverser
  • func NewParentTraverser(dbStorage *storage.Storage, metadataMemcache ...*storage.MetadataMemcache) *ParentTraverser
  • func (t *ParentTraverser) Cleanup(forceRelease bool)
  • func (t *ParentTraverser) Traverse(ctx context.Context, parents hornet.MessageIDs, condition Predicate, ...) error
• type Predicate

Functions

func ConeRootIndexes

func ConeRootIndexes(ctx context.Context, dbStorage *storage.Storage, cachedMsgMeta *storage.CachedMetadata, cmi milestone.Index) (youngestConeRootIndex milestone.Index, oldestConeRootIndex milestone.Index, err error)

ConeRootIndexes searches the cone root indexes for a given message. cachedMsgMeta has to be solid, otherwise youngestConeRootIndex and oldestConeRootIndex will be 0 if a message is missing in the cone.

func TraverseChildren

func TraverseChildren(ctx context.Context, dbStorage *storage.Storage, startMessageID hornet.MessageID, condition Predicate, consumer Consumer, walkAlreadyDiscovered bool, iteratorOptions ...storage.IteratorOption) error

TraverseChildren starts to traverse the children (future cone) of the given start message until the traversal stops due to no more messages passing the given condition. It is unsorted BFS because the children are not ordered in the database.

func TraverseParents

func TraverseParents(ctx context.Context, dbStorage *storage.Storage, parents hornet.MessageIDs, condition Predicate, consumer Consumer, onMissingParent OnMissingParent, onSolidEntryPoint OnSolidEntryPoint, traverseSolidEntryPoints bool) error

TraverseParents starts to traverse the parents (past cone) in the given order until the traversal stops due to no more messages passing the given condition. It is a DFS of the paths of the parents one after another. Caution: condition func is not in DFS order

func TraverseParentsOfMessage

func TraverseParentsOfMessage(ctx context.Context, dbStorage *storage.Storage, startMessageID hornet.MessageID, condition Predicate, consumer Consumer, onMissingParent OnMissingParent, onSolidEntryPoint OnSolidEntryPoint, traverseSolidEntryPoints bool) error

TraverseParentsOfMessage starts to traverse the parents (past cone) of the given start message until the traversal stops due to no more messages passing the given condition. It is a DFS of the paths of the parents one after another. Caution: condition func is not in DFS order

func UpdateConeRootIndexes

func UpdateConeRootIndexes(ctx context.Context, dbStorage *storage.Storage, metadataMemcache *storage.MetadataMemcache, messageIDs hornet.MessageIDs, cmi milestone.Index, iteratorOptions ...storage.IteratorOption) error

UpdateConeRootIndexes updates the cone root indexes of the future cone of all given messages. all the messages of the newly referenced cone already have updated cone root indexes. we have to walk the future cone, and update the past cone of all messages that reference an old cone. as a special property, invocations of the yielded function share the same 'already traversed' set to circumvent walking the future cone of the same messages multiple times.

Types

type ChildrenTraverser

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

func NewChildrenTraverser

func NewChildrenTraverser(dbStorage *storage.Storage, metadataMemcache ...*storage.MetadataMemcache) *ChildrenTraverser

NewChildrenTraverser create a new traverser to traverse the children (future cone)

func (*ChildrenTraverser) Cleanup

func (t *ChildrenTraverser) Cleanup(forceRelease bool)

Cleanup releases all the cached objects that have been traversed. This MUST be called by the user at the end.

func (*ChildrenTraverser) Traverse

func (t *ChildrenTraverser) Traverse(ctx context.Context, startMessageID hornet.MessageID, condition Predicate, consumer Consumer, walkAlreadyDiscovered bool, iteratorOptions ...storage.IteratorOption) error

Traverse starts to traverse the children (future cone) of the given start message until the traversal stops due to no more messages passing the given condition. It is unsorted BFS because the children are not ordered in the database.

type Consumer

type Consumer func(cachedMetadata *storage.CachedMetadata) error

Consumer consumes the given message metadata during traversal.

type OnMissingParent

type OnMissingParent func(parentMessageID hornet.MessageID) error

OnMissingParent gets called when during traversal a parent is missing.

type OnSolidEntryPoint

type OnSolidEntryPoint func(messageID hornet.MessageID)

OnSolidEntryPoint gets called when during traversal the startMsg or parent is a solid entry point.

type ParentTraverser

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

func NewParentTraverser

func NewParentTraverser(dbStorage *storage.Storage, metadataMemcache ...*storage.MetadataMemcache) *ParentTraverser

NewParentTraverser create a new traverser to traverse the parents (past cone)

func (*ParentTraverser) Cleanup

func (t *ParentTraverser) Cleanup(forceRelease bool)

Cleanup releases all the cached objects that have been traversed. This MUST be called by the user at the end.

func (*ParentTraverser) Traverse

func (t *ParentTraverser) Traverse(ctx context.Context, parents hornet.MessageIDs, condition Predicate, consumer Consumer, onMissingParent OnMissingParent, onSolidEntryPoint OnSolidEntryPoint, traverseSolidEntryPoints bool) error

Traverse starts to traverse the parents (past cone) in the given order until the traversal stops due to no more messages passing the given condition. It is a DFS of the paths of the parents one after another. Caution: condition func is not in DFS order

type Predicate

type Predicate func(cachedMetadata *storage.CachedMetadata) (bool, error)

Predicate defines whether a traversal should continue or not.