Documentation ¶
Overview ¶
(c) 2019 Dapper Labs - ALL RIGHTS RESERVED
Index ¶
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type Approvals ¶
type Approvals interface { // Add will add the given result approval to the memory pool. It will return // false if it was already in the mempool. Add(approval *flow.ResultApproval) (bool, error) // Rem will attempt to remove all the approvals associated with a chunk. Rem(resultID flow.Identifier, chunkIndex uint64) bool // ByChunk returns all the approvals associated with a chunk. It returns an // empty map if there is nothing. ByChunk(resultID flow.Identifier, chunkIndex uint64) map[flow.Identifier]*flow.ResultApproval // All will return a list of all approvals in the memory pool. All() []*flow.ResultApproval // Size will return the current size of the memory pool. Size() uint }
Approvals represents a concurrency-safe memory pool for result approvals.
type Assignments ¶
type Assignments interface { // Has checks whether the Assignment with the given hash is currently in // the memory pool. Has(assignmentID flow.Identifier) bool // Add will add the given assignment to the memory pool. It will return // false if it was already in the mempool. Add(assignmentFingerprint flow.Identifier, assignment *chunkmodels.Assignment) bool // Rem will remove the given Assignment from the memory pool; it will // return true if the Assignment was known and removed. Rem(assignmentID flow.Identifier) bool // ByID retrieve the chunk assigment with the given ID from the memory pool. // It will return false if it was not found in the mempool. ByID(assignmentID flow.Identifier) (*chunkmodels.Assignment, bool) // Size will return the current size of the memory pool. Size() uint // All will retrieve all Assignments that are currently in the memory pool // as a slice. All() []*chunkmodels.Assignment }
Assignments represents a concurrency-safe memory pool for chunk assignments
type Blocks ¶
type Blocks interface { // Has checks whether the block with the given hash is currently in // the memory pool. Has(blockID flow.Identifier) bool // Add will add the given block to the memory pool. It will return // false if it was already in the mempool. Add(block *flow.Block) bool // Rem will remove the given block from the memory pool; it will // will return true if the block was known and removed. Rem(blockID flow.Identifier) bool // ByID retrieve the block with the given ID from the memory pool. // It will return false if it was not found in the mempool. ByID(blockID flow.Identifier) (*flow.Block, bool) // Size will return the current size of the memory pool. Size() uint // All will retrieve all blocks that are currently in the memory pool // as a slice. All() []*flow.Block // Hash will return a hash of the contents of the memory pool. Hash() flow.Identifier }
Blocks represents a concurrency-safe memory pool for blocks.
type ChunkDataPacks ¶
type ChunkDataPacks interface { // Has checks whether the ChunkDataPack with the given chunkID is currently in // the memory pool. Has(chunkID flow.Identifier) bool // Add will add the given chunk datapack to the memory pool. It will return // false if it was already in the mempool. Add(cdp *flow.ChunkDataPack) bool // Rem will remove the given ChunkDataPack from the memory pool; it will // return true if the ChunkDataPack was known and removed. Rem(chunkID flow.Identifier) bool // ByID retrieve the chunk datapacke with the given chunk ID from the memory // pool. It will return false if it was not found in the mempool. ByChunkID(chunkID flow.Identifier) (*flow.ChunkDataPack, bool) // Size will return the current size of the memory pool. Size() uint // All will retrieve all ChunkDataPacks that are currently in the memory pool // as a slice. All() []*flow.ChunkDataPack // Hash will return a hash of the contents of the memory pool. Hash() flow.Identifier }
ChunkDataPacks represents a concurrency-safe memory pool for chunk data packs.
type Collections ¶
type Collections interface { // Has checks whether the collection with the given hash is currently in // the memory pool. Has(collID flow.Identifier) bool // Add will add the given collection to the memory pool. It will return // false if it was already in the mempool. Add(coll *flow.Collection) bool // Rem will remove the given collection from the memory pool; it will // return true if the collection was known and removed. Rem(collID flow.Identifier) bool // ByID retrieve the collection with the given ID from the memory pool. // It will return false if it was not found in the mempool. ByID(collID flow.Identifier) (*flow.Collection, bool) // Size will return the current size of the memory pool. Size() uint // All will retrieve all collections that are currently in the memory pool // as a slice. All() []*flow.Collection // Hash will return a hash of the contents of the memory pool. Hash() flow.Identifier }
Collections represents a concurrency-safe memory pool for collections.
type Guarantees ¶
type Guarantees interface { // Has checks whether the collection guarantee with the given hash is // currently in the memory pool. Has(collID flow.Identifier) bool // Add will add the given collection guarantee to the memory pool. It will // return false if it was already in the mempool. Add(guarantee *flow.CollectionGuarantee) bool // Rem will remove the given collection guarantees from the memory pool; it // will return true if the collection guarantees was known and removed. Rem(collID flow.Identifier) bool // ByID retrieve the collection guarantee with the given ID from the memory // pool. It will return false if it was not found in the mempool. ByID(collID flow.Identifier) (*flow.CollectionGuarantee, bool) // Size will return the current size of the memory pool. Size() uint // All will retrieve all collection guarantees that are currently in the memory pool // as a slice. All() []*flow.CollectionGuarantee // Hash will return a fingerprint has representing the contents of the // entire memory pool. Hash() flow.Identifier }
Guarantees represents a concurrency-safe memory pool for collection guarantees.
type IdentifierMap ¶
type IdentifierMap interface { // Append will append the id to the list of identifiers associated with key. Append(key, id flow.Identifier) error // Rem removes the given key with all associated identifiers. Rem(key flow.Identifier) bool // 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. RemIdFromKey(key, id flow.Identifier) error // Get returns list of all identifiers associated with key and true, if the key exists in the mempool. // Otherwise it returns nil and false. Get(key flow.Identifier) ([]flow.Identifier, bool) // Has returns true if the key exists in the map, i.e., there is at least an id // attached to it. Has(key flow.Identifier) bool // Keys returns a list of all keys in the mempool Keys() ([]flow.Identifier, bool) // Size returns number of IdMapEntities in mempool Size() uint }
IdentifierMap represents a concurrency-safe memory pool for mapping an identifier to a list of identifiers
type Identifiers ¶
type Identifiers interface { // Has checks whether the mempool has the identifier Has(id flow.Identifier) bool // Add will add the given identifier to the memory pool. It will return // false if it was already in the mempool. Add(id flow.Identifier) bool // Rem removes the given identifier Rem(id flow.Identifier) bool // Size returns total number of identifiers in mempool Size() uint // All will retrieve all identifiers that are currently in the memory pool // as an IdentityList All() flow.IdentifierList }
Identifiers represents a concurrency-safe memory pool for identifiers
type ReceiptDataPacks ¶
type ReceiptDataPacks interface { // Add will add the given ReceiptDataPack to the memory pool. It will return // false if it was already in the mempool. Add(rdp *verification.ReceiptDataPack) bool // Get returns the ReceiptDataPack and true, if the ReceiptDataPack is in the // mempool. Otherwise, it returns nil and false. Get(rdpID flow.Identifier) (*verification.ReceiptDataPack, bool) // Has checks if the given ReceiptDataPack is part of the memory pool. Has(rdpID flow.Identifier) bool // Rem will remove a ReceiptDataPack by ID. Rem(rdpID flow.Identifier) bool // Size returns total number ReceiptDataPacks in mempool Size() uint // All will return a list of all ReceiptDataPacks in the memory pool. All() []*verification.ReceiptDataPack }
ReceiptDataPacks represents a concurrency-safe memory pool for ReceiptDataPack data structure.
type Receipts ¶
type Receipts interface { // Add will add the given execution receipt to the memory pool. It will // return false if it was already in the mempool. Add(receipt *flow.ExecutionReceipt) bool // Has checks if the given receipt is part of the memory pool. Has(receiptID flow.Identifier) bool // Rem will remove a receipt by ID. Rem(receiptID flow.Identifier) bool // ByID retrieve the execution receipt with the given ID from the memory // pool. It will return false if it was not found in the mempool. ByID(receiptID flow.Identifier) (*flow.ExecutionReceipt, bool) // Size will return the current size of the memory pool. Size() uint // All will return a list of all receipts in the memory pool. All() []*flow.ExecutionReceipt }
Receipts represents a concurrency-safe memory pool for execution receipts.
type ResultDataPacks ¶
type ResultDataPacks interface { // Add will add the given ResultDataPack to the mempool. It will return // false if it was already in the mempool. Add(result *verification.ResultDataPack) bool // Has returns true if a ResultDataPack with the specified identifier exists. Has(resultID flow.Identifier) bool // Rem will remove the pending result from the memory pool Rem(resultID flow.Identifier) bool // Get returns the ResultDataPack and true, if the ResultDataPack is in the // mempool. Otherwise, it returns nil and false. Get(resultID flow.Identifier) (*verification.ResultDataPack, bool) // Size returns total number ResultDataPacks in mempool Size() uint }
ResultDataPacks represents a concurrency-safe memory pool for ResultDataPack data structure.
type Results ¶
type Results interface { // Has will check if the given result is in the memory pool. Has(resultID flow.Identifier) bool // Add will add the given execution result to the memory pool. It will return // false if it was already in the mempool. Add(result *flow.ExecutionResult) bool // Rem will attempt to remove the result from the memory pool. Rem(resultID flow.Identifier) bool // ByID retrieve the execution result with the given ID from the memory pool. // It will return false if it was not found in the mempool. ByID(resultID flow.Identifier) (*flow.ExecutionResult, bool) // Size will return the current size of the memory pool. Size() uint // All will return a list of all approvals in the memory pool. All() []*flow.ExecutionResult }
Results represents a concurrency-safe memory pool for execution results.
type Seals ¶
type Seals interface { // Has checks whether the block seal with the given hash is currently in // the memory pool. Has(sealID flow.Identifier) bool // Add will add the given block seal to the memory pool. It will return // false if it was already in the mempool. Add(seal *flow.Seal) bool // Rem will remove the given block seal from the memory pool; it will // will return true if the block seal was known and removed. Rem(sealID flow.Identifier) bool // ByID retrieve the block seal with the given ID from the memory // pool. It will return false if it was not found in the mempool. ByID(sealID flow.Identifier) (*flow.Seal, bool) // Size will return the current size of the memory pool. Size() uint // Limit will return the maximum size of the memory pool Limit() uint // All will retrieve all block seals that are currently in the memory pool // as a slice. All() []*flow.Seal // Hash will return a fingerprint has representing the contents of the // entire memory pool. Hash() flow.Identifier }
Seals represents a concurrency-safe memory pool for block seals.
type TransactionTimings ¶
type TransactionTimings interface { // Add adds a transaction timing to the mempool. Add(tx *flow.TransactionTiming) bool // ByID returns the transaction timing with the given ID from the mempool. ByID(txID flow.Identifier) (*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. Adjust(txID flow.Identifier, f func(*flow.TransactionTiming) *flow.TransactionTiming) (*flow.TransactionTiming, bool) // All returns all transaction timings from the mempool. All() []*flow.TransactionTiming // Rem removes the transaction timing with the given ID. Rem(txID flow.Identifier) bool }
TransactionTimings represents a concurrency-safe memory pool for transaction timings.
type Transactions ¶
type Transactions interface { // Has checks whether the transaction with the given hash is currently in // the memory pool. Has(txID flow.Identifier) bool // Add will add the given transaction body to the memory pool. It will // return false if it was already in the mempool. Add(tx *flow.TransactionBody) bool // Rem will remove the given transaction from the memory pool; it will // will return true if the transaction was known and removed. Rem(txID flow.Identifier) bool // ByID retrieve the transaction with the given ID from the memory // pool. It will return false if it was not found in the mempool. ByID(txID flow.Identifier) (*flow.TransactionBody, bool) // Size will return the current size of the memory pool. Size() uint // All will retrieve all transactions that are currently in the memory pool // as a slice. All() []*flow.TransactionBody // Hash will return a fingerprint has representing the contents of the // entire memory pool. Hash() flow.Identifier }
Transactions represents a concurrency-safe memory pool for transactions.