Documentation
¶
Overview ¶
(c) 2019 Dapper Labs - ALL RIGHTS RESERVED
Index ¶
- func EjectFakeRandom(entities map[flow.Identifier]flow.Entity) (flow.Identifier, flow.Entity)
- func EjectPanic(entities map[flow.Identifier]flow.Entity) (flow.Identifier, flow.Entity)
- func EjectTrueRandom(entities map[flow.Identifier]flow.Entity) (flow.Identifier, flow.Entity)
- type Assignments
- func (a *Assignments) Add(fingerprint flow.Identifier, assignment *chunkmodels.Assignment) bool
- func (a *Assignments) All() []*chunkmodels.Assignment
- func (a *Assignments) ByID(assignmentID flow.Identifier) (*chunkmodels.Assignment, bool)
- func (a *Assignments) Has(assignmentID flow.Identifier) bool
- func (a *Assignments) Rem(assignmentID flow.Identifier) bool
- func (a *Assignments) Size() uint
- type Backdata
- func (b *Backdata) Add(entity flow.Entity) bool
- func (b *Backdata) Adjust(entityID flow.Identifier, f func(flow.Entity) flow.Entity) (flow.Entity, bool)
- func (b *Backdata) All() []flow.Entity
- func (b *Backdata) ByID(entityID flow.Identifier) (flow.Entity, bool)
- func (b *Backdata) Clear()
- func (b *Backdata) Has(entityID flow.Identifier) bool
- func (b *Backdata) Hash() flow.Identifier
- func (b *Backdata) Rem(entityID flow.Identifier) (flow.Entity, bool)
- func (b *Backdata) Size() uint
- type Backend
- func (b *Backend) Add(entity flow.Entity) bool
- func (b *Backend) Adjust(entityID flow.Identifier, f func(flow.Entity) flow.Entity) (flow.Entity, bool)
- func (b *Backend) All() []flow.Entity
- func (b *Backend) ByID(entityID flow.Identifier) (flow.Entity, bool)
- func (b *Backend) Clear()
- func (b *Backend) Has(entityID flow.Identifier) bool
- func (b *Backend) Hash() flow.Identifier
- func (b *Backend) Limit() uint
- func (b *Backend) RegisterEjectionCallbacks(callbacks ...mempool.OnEjection)
- func (b *Backend) Rem(entityID flow.Identifier) bool
- func (b *Backend) Run(f func(backdata map[flow.Identifier]flow.Entity) error) error
- func (b *Backend) Size() uint
- type BlockByCollectionBackdata
- type BlockByCollections
- type Blocks
- type ChunkDataPacks
- func (c *ChunkDataPacks) Add(cdp *flow.ChunkDataPack) bool
- func (c *ChunkDataPacks) All() []*flow.ChunkDataPack
- func (c *ChunkDataPacks) ByChunkID(chunkID flow.Identifier) (*flow.ChunkDataPack, bool)
- func (c *ChunkDataPacks) Has(chunkID flow.Identifier) bool
- func (c *ChunkDataPacks) Hash() flow.Identifier
- func (c *ChunkDataPacks) Rem(chunkID flow.Identifier) bool
- func (c *ChunkDataPacks) Size() uint
- type ChunkRequests
- func (cs *ChunkRequests) Add(request *verification.ChunkDataPackRequest) bool
- func (cs *ChunkRequests) All() []*verification.ChunkDataPackRequest
- func (cs *ChunkRequests) ByID(chunkID flow.Identifier) (*verification.ChunkDataPackRequest, bool)
- func (cs *ChunkRequests) IncrementAttempt(chunkID flow.Identifier) bool
- func (cs *ChunkRequests) Rem(chunkID flow.Identifier) bool
- func (cs *ChunkRequests) RequestHistory(chunkID flow.Identifier) (uint64, time.Time, time.Duration, bool)
- func (cs ChunkRequests) Size() uint
- func (cs *ChunkRequests) UpdateRequestHistory(chunkID flow.Identifier, updater mempool.ChunkRequestHistoryUpdaterFunc) (uint64, time.Time, time.Duration, bool)
- type ChunkStatuses
- func (cs *ChunkStatuses) Add(status *verification.ChunkStatus) bool
- func (cs ChunkStatuses) All() []*verification.ChunkStatus
- func (cs ChunkStatuses) ByID(chunkID flow.Identifier) (*verification.ChunkStatus, bool)
- func (cs *ChunkStatuses) Rem(chunkID flow.Identifier) bool
- func (cs ChunkStatuses) Size() uint
- type Collections
- type EjectFunc
- type Guarantees
- type IdentifierMap
- func (i *IdentifierMap) Append(key, id flow.Identifier) error
- func (i *IdentifierMap) Get(key flow.Identifier) ([]flow.Identifier, bool)
- func (i *IdentifierMap) Has(key flow.Identifier) bool
- func (i *IdentifierMap) Keys() ([]flow.Identifier, bool)
- func (i *IdentifierMap) Rem(key flow.Identifier) bool
- func (i *IdentifierMap) RemIdFromKey(key, id flow.Identifier) error
- func (i *IdentifierMap) Size() uint
- type Identifiers
- type IncorporatedResultSeals
- func (ir *IncorporatedResultSeals) Add(seal *flow.IncorporatedResultSeal) (bool, error)
- func (ir *IncorporatedResultSeals) All() []*flow.IncorporatedResultSeal
- func (ir *IncorporatedResultSeals) ByID(id flow.Identifier) (*flow.IncorporatedResultSeal, bool)
- func (ir *IncorporatedResultSeals) Clear()
- func (ir *IncorporatedResultSeals) PruneUpToHeight(height uint64) error
- func (ir *IncorporatedResultSeals) RegisterEjectionCallbacks(callbacks ...mempool.OnEjection)
- func (ir *IncorporatedResultSeals) Rem(id flow.Identifier) bool
- func (ir *IncorporatedResultSeals) Size() uint
- type LRUEjector
- type OptionFunc
- type PendingReceipts
- type Queues
- type QueuesBackdata
- type Receipts
- type Results
- type Time
- type Times
- type TransactionTimings
- func (t *TransactionTimings) Add(tx *flow.TransactionTiming) bool
- func (t *TransactionTimings) Adjust(txID flow.Identifier, f func(*flow.TransactionTiming) *flow.TransactionTiming) (*flow.TransactionTiming, bool)
- func (t *TransactionTimings) All() []*flow.TransactionTiming
- func (t *TransactionTimings) ByID(txID flow.Identifier) (*flow.TransactionTiming, bool)
- func (t *TransactionTimings) Rem(txID flow.Identifier) bool
- type Transactions
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
func EjectFakeRandom ¶
func EjectFakeRandom(entities map[flow.Identifier]flow.Entity) (flow.Identifier, flow.Entity)
EjectFakeRandom relies on the random map iteration in Go to pick the entity we eject from the entity set. It picks the first entity upon iteration, thus being the fastest way to pick an entity to be evicted; at the same time, it conserves the random bias of the Go map iteration.
func EjectPanic ¶
func EjectPanic(entities map[flow.Identifier]flow.Entity) (flow.Identifier, flow.Entity)
EjectPanic simply panics, crashing the program. Useful when cache is not expected to grow beyond certain limits, but ejecting is not applicable
func EjectTrueRandom ¶
func EjectTrueRandom(entities map[flow.Identifier]flow.Entity) (flow.Identifier, flow.Entity)
EjectTrueRandom relies on a random generator to pick a random entity to eject from the entity set. It will, on average, iterate through half the entities of the set. However, it provides us with a truly evenly distributed random selection.
Types ¶
type Assignments ¶
type Assignments struct {
*Backend
}
Assignments implements the chunk assignment memory pool.
func NewAssignments ¶
func NewAssignments(limit uint) (*Assignments, error)
NewAssignments creates a new memory pool for Assignments.
func (*Assignments) Add ¶
func (a *Assignments) Add(fingerprint flow.Identifier, assignment *chunkmodels.Assignment) bool
Add adds an Assignment to the mempool.
func (*Assignments) All ¶
func (a *Assignments) All() []*chunkmodels.Assignment
All returns all chunk data packs from the pool.
func (*Assignments) ByID ¶
func (a *Assignments) ByID(assignmentID flow.Identifier) (*chunkmodels.Assignment, bool)
ByID retrieves the chunk assignment from mempool based on provided ID
func (*Assignments) Has ¶
func (a *Assignments) Has(assignmentID flow.Identifier) bool
Has checks whether the Assignment with the given hash is currently in the memory pool.
func (*Assignments) Rem ¶
func (a *Assignments) Rem(assignmentID flow.Identifier) bool
Rem will remove the given Assignment from the memory pool; it will return true if the Assignment was known and removed.
func (*Assignments) Size ¶
func (a *Assignments) Size() uint
Size will return the current size of the memory pool.
type Backdata ¶
type Backdata struct {
// contains filtered or unexported fields
}
Backdata implements a generic memory pool backed by a Go map.
func NewBackdata ¶
func NewBackdata() Backdata
func (*Backdata) Adjust ¶
func (b *Backdata) Adjust(entityID flow.Identifier, f func(flow.Entity) flow.Entity) (flow.Entity, bool)
Adjust will adjust the value item using the given function if the given key can be found. Returns a bool which indicates whether the value was updated as well as the updated value
func (*Backdata) Clear ¶ added in v0.11.0
func (b *Backdata) Clear()
Clear removes all entities from the pool.
func (*Backdata) Has ¶
func (b *Backdata) Has(entityID flow.Identifier) bool
Has checks if we already contain the item with the given hash.
func (*Backdata) Hash ¶
func (b *Backdata) Hash() flow.Identifier
Hash will use a merkle root hash to hash all items.
type Backend ¶
Backend provides synchronized access to a backdata
func NewBackend ¶
func NewBackend(options ...OptionFunc) *Backend
NewBackend creates a new memory pool backend.
func (*Backend) Adjust ¶
func (b *Backend) Adjust(entityID flow.Identifier, f func(flow.Entity) flow.Entity) (flow.Entity, bool)
Adjust will adjust the value item using the given function if the given key can be found. Returns a bool which indicates whether the value was updated.
func (*Backend) Clear ¶ added in v0.11.0
func (b *Backend) Clear()
Clear removes all entities from the pool.
func (*Backend) Has ¶
func (b *Backend) Has(entityID flow.Identifier) bool
Has checks if we already contain the item with the given hash.
func (*Backend) Hash ¶
func (b *Backend) Hash() flow.Identifier
Hash will use a merkle root hash to hash all items.
func (*Backend) RegisterEjectionCallbacks ¶ added in v0.13.0
func (b *Backend) RegisterEjectionCallbacks(callbacks ...mempool.OnEjection)
RegisterEjectionCallbacks adds the provided OnEjection callbacks
func (*Backend) Rem ¶
func (b *Backend) Rem(entityID flow.Identifier) bool
Rem will remove the item with the given hash.
type BlockByCollectionBackdata ¶
type BlockByCollectionBackdata struct {
*Backdata
}
BlockByCollectionBackdata contains all the collections is being requested, for each collection it stores the blocks that contains the collection. the Backdata is essentially map<collectionID>map<blockID>*ExecutableBlock
func (*BlockByCollectionBackdata) ByID ¶
func (b *BlockByCollectionBackdata) ByID(id flow.Identifier) (*entity.BlocksByCollection, bool)
type BlockByCollections ¶
type BlockByCollections struct {
*Backend
}
Hold all the missing collections. Each entry is a missing collection, and all the blocks that contain this collection
func NewBlockByCollections ¶
func NewBlockByCollections() *BlockByCollections
func (*BlockByCollections) Add ¶
func (b *BlockByCollections) Add(block *entity.BlocksByCollection) bool
func (*BlockByCollections) Get ¶
func (b *BlockByCollections) Get(collID flow.Identifier) (*entity.BlocksByCollection, bool)
func (*BlockByCollections) Run ¶
func (b *BlockByCollections) Run(f func(backdata *BlockByCollectionBackdata) error) error
type Blocks ¶
type Blocks struct {
*Backend
}
Blocks implements the blocks memory pool.
type ChunkDataPacks ¶
type ChunkDataPacks struct {
*Backend
}
ChunkDataPacks implements the ChunkDataPack memory pool.
func NewChunkDataPacks ¶
func NewChunkDataPacks(limit uint) (*ChunkDataPacks, error)
NewChunkDataPacks creates a new memory pool for ChunkDataPacks.
func (*ChunkDataPacks) Add ¶
func (c *ChunkDataPacks) Add(cdp *flow.ChunkDataPack) bool
Add adds an chunkDataPack to the mempool.
func (*ChunkDataPacks) All ¶
func (c *ChunkDataPacks) All() []*flow.ChunkDataPack
All returns all chunk data packs from the pool.
func (*ChunkDataPacks) ByChunkID ¶
func (c *ChunkDataPacks) ByChunkID(chunkID flow.Identifier) (*flow.ChunkDataPack, bool)
ByChunkID returns the chunk data pack with the given chunkID from the mempool.
func (*ChunkDataPacks) Has ¶
func (c *ChunkDataPacks) Has(chunkID flow.Identifier) bool
Has checks whether the ChunkDataPack with the given chunkID is currently in the memory pool.
func (*ChunkDataPacks) Hash ¶
func (c *ChunkDataPacks) Hash() flow.Identifier
Hash will return a hash of the contents of the memory pool.
func (*ChunkDataPacks) Rem ¶
func (c *ChunkDataPacks) Rem(chunkID flow.Identifier) bool
Rem will remove chunk data pack by ID
func (*ChunkDataPacks) Size ¶
func (c *ChunkDataPacks) Size() uint
Size will return the current size of the memory pool.
type ChunkRequests ¶ added in v0.17.0
type ChunkRequests struct {
*Backend
}
ChunkRequests is an implementation of in-memory storage for maintaining chunk requests data objects.
In this implementation, the ChunkRequests wraps the ChunkDataPackRequests around an internal ChunkRequestStatus data object, and maintains the wrapped version in memory.
func NewChunkRequests ¶ added in v0.17.0
func NewChunkRequests(limit uint) *ChunkRequests
func (*ChunkRequests) Add ¶ added in v0.17.0
func (cs *ChunkRequests) Add(request *verification.ChunkDataPackRequest) bool
Add provides insertion functionality into the memory pool. The insertion is only successful if there is no duplicate chunk request with the same chunk ID in the memory. Otherwise, it aborts the insertion and returns false.
func (*ChunkRequests) All ¶ added in v0.17.0
func (cs *ChunkRequests) All() []*verification.ChunkDataPackRequest
All returns all chunk requests stored in this memory pool.
func (*ChunkRequests) ByID ¶ added in v0.17.0
func (cs *ChunkRequests) ByID(chunkID flow.Identifier) (*verification.ChunkDataPackRequest, bool)
ByID returns a chunk request by its chunk ID.
There is a one-to-one correspondence between the chunk requests in memory, and their chunk ID.
func (*ChunkRequests) IncrementAttempt ¶ added in v0.17.0
func (cs *ChunkRequests) IncrementAttempt(chunkID flow.Identifier) bool
IncrementAttempt increments the Attempt field of the corresponding status of the chunk request in memory pool that has the specified chunk ID. If such chunk ID does not exist in the memory pool, it returns false.
The increments are done atomically, thread-safe, and in isolation.
func (*ChunkRequests) Rem ¶ added in v0.17.0
func (cs *ChunkRequests) Rem(chunkID flow.Identifier) bool
Rem provides deletion functionality from the memory pool. If there is a chunk request with this ID, Rem removes it and returns true. Otherwise it returns false.
func (*ChunkRequests) RequestHistory ¶ added in v0.17.0
func (cs *ChunkRequests) RequestHistory(chunkID flow.Identifier) (uint64, time.Time, time.Duration, bool)
RequestHistory returns the number of times the chunk has been requested, last time the chunk has been requested, and the retryAfter duration of the underlying request status of this chunk.
The last boolean parameter returns whether a chunk request for this chunk ID exists in memory-pool.
func (ChunkRequests) Size ¶ added in v0.17.1
func (cs ChunkRequests) Size() uint
Size returns total number of chunk requests in the memory pool.
func (*ChunkRequests) UpdateRequestHistory ¶ added in v0.17.0
func (cs *ChunkRequests) UpdateRequestHistory(chunkID flow.Identifier, updater mempool.ChunkRequestHistoryUpdaterFunc) (uint64, time.Time, time.Duration, bool)
UpdateRequestHistory updates the request history of the specified chunk ID. If the update was successful, i.e., the updater returns true, the result of update is committed to the mempool, and the time stamp of the chunk request is updated to the current time. Otherwise, it aborts and returns false.
It returns the updated request history values.
The updates under this method are atomic, thread-safe, and done in isolation.
type ChunkStatuses ¶ added in v0.17.0
type ChunkStatuses struct {
*Backend
}
ChunkStatuses is an implementation of in-memory storage for maintaining the chunk status data objects.
func NewChunkStatuses ¶ added in v0.17.0
func NewChunkStatuses(limit uint) *ChunkStatuses
func (*ChunkStatuses) Add ¶ added in v0.17.0
func (cs *ChunkStatuses) Add(status *verification.ChunkStatus) bool
Add provides insertion functionality into the memory pool. The insertion is only successful if there is no duplicate status with the same chunk ID in the memory. Otherwise, it aborts the insertion and returns false.
func (ChunkStatuses) All ¶ added in v0.17.0
func (cs ChunkStatuses) All() []*verification.ChunkStatus
All returns all chunk statuses stored in this memory pool.
func (ChunkStatuses) ByID ¶ added in v0.17.0
func (cs ChunkStatuses) ByID(chunkID flow.Identifier) (*verification.ChunkStatus, bool)
ByID returns a chunk status by its chunk ID. There is a one-to-one correspondence between the chunk statuses in memory, and their chunk ID.
func (*ChunkStatuses) Rem ¶ added in v0.17.0
func (cs *ChunkStatuses) Rem(chunkID flow.Identifier) bool
Rem provides deletion functionality from the memory pool. If there is a chunk status with this ID, Rem removes it and returns true. Otherwise it returns false.
func (ChunkStatuses) Size ¶ added in v0.17.1
func (cs ChunkStatuses) Size() uint
Size returns total number of chunk statuses in the memory pool.
type Collections ¶
type Collections struct {
*Backend
}
Collections implements a mempool storing collections.
func NewCollections ¶
func NewCollections(limit uint) (*Collections, error)
NewCollections creates a new memory pool for collection.
func (*Collections) Add ¶
func (c *Collections) Add(coll *flow.Collection) bool
Add adds a collection to the mempool.
func (*Collections) All ¶
func (c *Collections) All() []*flow.Collection
All returns all collections from the mempool.
func (*Collections) ByID ¶
func (c *Collections) ByID(collID flow.Identifier) (*flow.Collection, bool)
ByID returns the collection with the given ID from the mempool.
func (*Collections) Rem ¶
func (c *Collections) Rem(collID flow.Identifier) bool
Rem removes a collection by ID from memory
type EjectFunc ¶
type EjectFunc func(entities map[flow.Identifier]flow.Entity) (flow.Identifier, flow.Entity)
EjectFunc is a function used to pick an entity to evict from the memory pool backend when it overflows its limit. A custom eject function can be injected into the memory pool upon creation, which allows us to hook into the eject to clean up auxiliary data and/or to change the strategy of eviction.
type Guarantees ¶
type Guarantees struct {
*Backend
}
Guarantees implements the collections memory pool of the consensus nodes, used to store collection guarantees and to generate block payloads.
func NewGuarantees ¶
func NewGuarantees(limit uint) (*Guarantees, error)
NewGuarantees creates a new memory pool for collection guarantees.
func (*Guarantees) Add ¶
func (g *Guarantees) Add(guarantee *flow.CollectionGuarantee) bool
Add adds a collection guarantee guarantee to the mempool.
func (*Guarantees) All ¶
func (g *Guarantees) All() []*flow.CollectionGuarantee
All returns all collection guarantees from the mempool.
func (*Guarantees) ByID ¶
func (g *Guarantees) ByID(collID flow.Identifier) (*flow.CollectionGuarantee, bool)
ByID returns the collection guarantee with the given ID from the mempool.
type IdentifierMap ¶
type IdentifierMap struct {
*Backend
}
IdentifierMap represents a concurrency-safe memory pool for IdMapEntity.
func NewIdentifierMap ¶
func NewIdentifierMap(limit uint) (*IdentifierMap, error)
NewIdentifierMap creates a new memory pool for IdMapEntity.
func (*IdentifierMap) Append ¶
func (i *IdentifierMap) Append(key, id flow.Identifier) error
Append will append the id to the list of identifiers associated with key.
func (*IdentifierMap) Get ¶
func (i *IdentifierMap) Get(key flow.Identifier) ([]flow.Identifier, bool)
Get returns list of all identifiers associated with key and true, if the key exists in the mempool. Otherwise it returns nil and false.
func (*IdentifierMap) Has ¶
func (i *IdentifierMap) Has(key flow.Identifier) bool
Has returns true if the key exists in the map, i.e., there is at least an id attached to it.
func (*IdentifierMap) Keys ¶
func (i *IdentifierMap) Keys() ([]flow.Identifier, bool)
Keys returns a list of all keys in the mempool
func (*IdentifierMap) Rem ¶
func (i *IdentifierMap) Rem(key flow.Identifier) bool
Rem removes the given key with all associated identifiers.
func (*IdentifierMap) RemIdFromKey ¶
func (i *IdentifierMap) RemIdFromKey(key, id flow.Identifier) error
RemIdFromKey removes the id from the list of identifiers associated with key. If the list becomes empty, it also removes the key from the map.
func (*IdentifierMap) Size ¶
func (i *IdentifierMap) Size() uint
Size returns number of IdMapEntities in mempool
type Identifiers ¶
type Identifiers struct {
*Backend
}
Identifiers represents a concurrency-safe memory pool for IDs.
func NewIdentifiers ¶
func NewIdentifiers(limit uint) (*Identifiers, error)
NewIdentifiers creates a new memory pool for identifiers.
func (*Identifiers) Add ¶
func (i *Identifiers) Add(id flow.Identifier) bool
Add will add the given identifier to the memory pool or it will error if the identifier is already in the memory pool.
func (*Identifiers) All ¶
func (i *Identifiers) All() flow.IdentifierList
All returns all identifiers stored in the mempool
func (*Identifiers) Has ¶
func (i *Identifiers) Has(id flow.Identifier) bool
Has checks whether the mempool has the identifier
func (*Identifiers) Rem ¶
func (i *Identifiers) Rem(id flow.Identifier) bool
Rem removes the given identifier from the memory pool; it will return true if the identifier was known and removed.
type IncorporatedResultSeals ¶ added in v0.11.0
type IncorporatedResultSeals struct { *Backend // contains filtered or unexported fields }
IncorporatedResultSeals implements the incorporated result seals memory pool of the consensus nodes, used to store seals that need to be added to blocks.
func NewIncorporatedResultSeals ¶ added in v0.11.0
func NewIncorporatedResultSeals(limit uint) *IncorporatedResultSeals
NewIncorporatedResultSeals creates a mempool for the incorporated result seals
func (*IncorporatedResultSeals) Add ¶ added in v0.11.0
func (ir *IncorporatedResultSeals) Add(seal *flow.IncorporatedResultSeal) (bool, error)
Add adds an IncorporatedResultSeal to the mempool
func (*IncorporatedResultSeals) All ¶ added in v0.11.0
func (ir *IncorporatedResultSeals) All() []*flow.IncorporatedResultSeal
All returns all the items in the mempool
func (*IncorporatedResultSeals) ByID ¶ added in v0.11.0
func (ir *IncorporatedResultSeals) ByID(id flow.Identifier) (*flow.IncorporatedResultSeal, bool)
ByID gets an IncorporatedResultSeal by IncorporatedResult ID
func (*IncorporatedResultSeals) Clear ¶ added in v0.13.0
func (ir *IncorporatedResultSeals) Clear()
func (*IncorporatedResultSeals) PruneUpToHeight ¶ added in v0.18.1
func (ir *IncorporatedResultSeals) PruneUpToHeight(height uint64) error
PruneUpToHeight remove all seals for blocks whose height is strictly smaller that height. Note: seals for blocks at height are retained. After pruning, seals below for blocks below the given height are dropped.
Monotonicity Requirement: The pruned height cannot decrease, as we cannot recover already pruned elements. If `height` is smaller than the previous value, the previous value is kept and the sentinel empool.NewDecreasingPruningHeightError is returned.
func (*IncorporatedResultSeals) RegisterEjectionCallbacks ¶ added in v0.13.0
func (ir *IncorporatedResultSeals) RegisterEjectionCallbacks(callbacks ...mempool.OnEjection)
RegisterEjectionCallbacks adds the provided OnEjection callbacks
func (*IncorporatedResultSeals) Rem ¶ added in v0.11.0
func (ir *IncorporatedResultSeals) Rem(id flow.Identifier) bool
Rem removes an IncorporatedResultSeal from the mempool
func (*IncorporatedResultSeals) Size ¶ added in v0.19.0
func (ir *IncorporatedResultSeals) Size() uint
Size returns the size of the underlying backing store
type LRUEjector ¶
LRUEjector provides a swift FIFO ejection functionality
func NewLRUEjector ¶
func NewLRUEjector() *LRUEjector
func (*LRUEjector) Eject ¶
func (q *LRUEjector) Eject(entities map[flow.Identifier]flow.Entity) (flow.Identifier, flow.Entity)
Eject implements EjectFunc for LRUEjector. It finds the entity with the lowest sequence number (i.e., the oldest entity). It also untracks
func (*LRUEjector) Track ¶
func (q *LRUEjector) Track(entityID flow.Identifier)
Track should be called every time a new entity is added to the mempool. It tracks the entity for later ejection.
func (*LRUEjector) Untrack ¶
func (q *LRUEjector) Untrack(entityID flow.Identifier)
Untrack simply removes the tracker of the ejector off the entityID
type OptionFunc ¶
type OptionFunc func(*Backend)
OptionFunc is a function that can be provided to the backend on creation in order to set a certain custom option.
func WithEject ¶
func WithEject(eject EjectFunc) OptionFunc
WithEject can be provided to the backend on creation in order to set a custom eject function to pick the entity to be evicted upon overflow, as well as hooking into it for additional cleanup work.
func WithLimit ¶
func WithLimit(limit uint) OptionFunc
WithLimit can be provided to the backend on creation in order to set a custom maximum limit of entities in the memory pool.
type PendingReceipts ¶ added in v0.14.1
type PendingReceipts struct { *Backend // contains filtered or unexported fields }
PendingReceipts stores pending receipts indexed by the id. It also maintains a secondary index on the previous result id. in order to allow to find receipts by the previous result id.
func NewPendingReceipts ¶ added in v0.14.1
func NewPendingReceipts(limit uint) *PendingReceipts
NewPendingReceipts creates a new memory pool for execution receipts.
func (*PendingReceipts) Add ¶ added in v0.14.1
func (r *PendingReceipts) Add(receipt *flow.ExecutionReceipt) bool
Add adds an execution receipt to the mempool.
func (*PendingReceipts) ByPreviousResultID ¶ added in v0.14.1
func (r *PendingReceipts) ByPreviousResultID(previousResultID flow.Identifier) []*flow.ExecutionReceipt
ByPreviousResultID returns receipts whose previous result ID matches the given ID
func (*PendingReceipts) Rem ¶ added in v0.14.1
func (r *PendingReceipts) Rem(receiptID flow.Identifier) bool
Rem will remove a receipt by ID.
func (*PendingReceipts) Size ¶ added in v0.14.1
func (r *PendingReceipts) Size() uint
Size will return the total number of pending receipts
type QueuesBackdata ¶
type QueuesBackdata struct {
*Backdata
}
QueuesBackdata is mempool map for ingestion.Queues (head Node ID -> Queues)
func (*QueuesBackdata) All ¶
func (b *QueuesBackdata) All() []*queue.Queue
func (*QueuesBackdata) ByID ¶
func (b *QueuesBackdata) ByID(queueID flow.Identifier) (*queue.Queue, bool)
type Receipts ¶
type Receipts struct {
*Backend
}
Receipts implements the execution receipts memory pool of the consensus node, used to store execution receipts and to generate block seals.
func NewReceipts ¶
NewReceipts creates a new memory pool for execution receipts.
func (*Receipts) Add ¶
func (r *Receipts) Add(receipt *flow.ExecutionReceipt) bool
Add adds an execution receipt to the mempool.
func (*Receipts) All ¶
func (r *Receipts) All() []*flow.ExecutionReceipt
All will return all execution receipts in the memory pool.
func (*Receipts) ByID ¶
func (r *Receipts) ByID(receiptID flow.Identifier) (*flow.ExecutionReceipt, bool)
ByID will retrieve an approval by ID.
type Results ¶
type Results struct {
*Backend
}
Results implements the execution results memory pool of the consensus node, used to store execution results and to generate block seals.
func NewResults ¶
NewResults creates a new memory pool for execution results.
func (*Results) Add ¶
func (r *Results) Add(result *flow.ExecutionResult) bool
Add adds an execution result to the mempool.
func (*Results) All ¶
func (r *Results) All() []*flow.ExecutionResult
All will return all execution results in the memory pool.
func (*Results) ByID ¶
func (r *Results) ByID(resultID flow.Identifier) (*flow.ExecutionResult, bool)
ByID will retrieve an approval by ID.
type Time ¶
type Time struct {
// contains filtered or unexported fields
}
func (*Time) Checksum ¶
func (t *Time) Checksum() flow.Identifier
func (*Time) ID ¶
func (t *Time) ID() flow.Identifier
type Times ¶
type Times struct {
*Backend
}
Times implements the times memory pool used to store time.Times for an idetifier to track transaction metrics in access nodes
type TransactionTimings ¶
type TransactionTimings struct {
*Backend
}
TransactionTimings implements the transaction timings memory pool of access nodes, used to store transaction timings to report the timing of individual transactions
func NewTransactionTimings ¶
func NewTransactionTimings(limit uint) (*TransactionTimings, error)
NewTransactionTimings creates a new memory pool for transaction timings
func (*TransactionTimings) Add ¶
func (t *TransactionTimings) Add(tx *flow.TransactionTiming) bool
Add adds a transaction timing to the mempool.
func (*TransactionTimings) Adjust ¶
func (t *TransactionTimings) Adjust(txID flow.Identifier, f func(*flow.TransactionTiming) *flow.TransactionTiming) ( *flow.TransactionTiming, bool)
Adjust will adjust the transaction timing using the given function if the given key can be found. Returns a bool which indicates whether the value was updated as well as the updated value.
func (*TransactionTimings) All ¶
func (t *TransactionTimings) All() []*flow.TransactionTiming
All returns all transaction timings from the mempool.
func (*TransactionTimings) ByID ¶
func (t *TransactionTimings) ByID(txID flow.Identifier) (*flow.TransactionTiming, bool)
ByID returns the transaction timing with the given ID from the mempool.
func (*TransactionTimings) Rem ¶
func (t *TransactionTimings) Rem(txID flow.Identifier) bool
Rem removes the transaction timing with the given ID.
type Transactions ¶
type Transactions struct {
*Backend
}
Transactions implements the transactions memory pool of the consensus nodes, used to store transactions and to generate block payloads.
func NewTransactions ¶
func NewTransactions(limit uint) *Transactions
NewTransactions creates a new memory pool for transctions.
func (*Transactions) Add ¶
func (t *Transactions) Add(tx *flow.TransactionBody) bool
Add adds a transaction to the mempool.
func (*Transactions) All ¶
func (t *Transactions) All() []*flow.TransactionBody
All returns all transactions from the mempool.
func (*Transactions) ByID ¶
func (t *Transactions) ByID(txID flow.Identifier) (*flow.TransactionBody, bool)
ByID returns the transaction with the given ID from the mempool.
Source Files
¶
- assignments.go
- backend.go
- blockbycollections.go
- blocks.go
- chunk_data_packs.go
- chunk_requests.go
- chunk_statuses.go
- collections.go
- eject.go
- guarantees.go
- identifier_map.go
- identifiers.go
- incorporated_result_seals.go
- options.go
- pending_receipts.go
- queues.go
- receipts.go
- results.go
- times.go
- transaction_timings.go
- transactions.go