package
0.0.0-20240419125430-e07b07e7cea4
Repository: https://github.com/probe-lab/zikade.git
Documentation: pkg.go.dev
# Functions
DefaultPoolConfig returns the default configuration options for a Pool.
DefaultQueryConfig returns the default configuration options for a Query.
NewClosestNodesIter creates a new ClosestNodesIter.
No description provided by the author
No description provided by the author
No description provided by the author
NewSequentialIter creates a new SequentialIter.
# Structs
A ClosestNodesIter iterates nodes in order of ascending distance from a key.
EventPoolAddQuery is an event that attempts to add a new query that finds closer nodes to a target key.
EventPoolAddQuery is an event that attempts to add a new query that sends a message.
EventPoolNodeFailure notifies a [Pool] that an attempt to contact a node has failed.
EventPoolNodeResponse notifies a [Pool] that an attempt to contact a node has received a successful response.
EventPoolPoll is an event that signals the pool that it can perform housekeeping work such as time out queries.
EventPoolStopQuery notifies a [Pool] to stop a query.
EventQueryMessageResponse notifies a query to stop all work and enter the finished state.
EventQueryNodeFailure notifies a [Query] that an attempt to to contact a node has failed.
EventQueryNodeResponse notifies a [Query] that an attempt to contact a node has received a successful response.
EventQueryPoll is an event that signals a [Query] that it can perform housekeeping work.
No description provided by the author
No description provided by the author
PoolConfig specifies optional configuration for a Pool.
No description provided by the author
QueryConfig specifies optional configuration for a Query.
No description provided by the author
A SequentialIter iterates nodes in the order they were added to the iterator.
StateNodeFailed indicates that the attempt to contact the node failed.
StateNodeNotContacted indicates that the node has not been contacted yet.
StateNodeSucceeded indicates that the attempt to contact the node succeeded.
StateNodeUnresponsive indicates that the node did not respond within the configured timeout.
StateNodeWaiting indicates that a query is waiting for a response from the node.
StatePoolFindCloser indicates that a pool query wants to send a find closer nodes message to a node.
StatePoolIdle indicates that the pool is idle, i.e.
StatePoolQueryFinished indicates that a query has finished.
StatePoolQueryTimeout indicates that a query has timed out.
StatePoolSendMessage indicates that a pool query wants to send a message to a node.
StatePoolWaitingAtCapacity indicates that at least one query is waiting for results and the pool has reached its maximum number of concurrent queries.
StatePoolWaitingWithCapacity indicates that at least one query is waiting for results but capacity to start more is available.
StateQueryFindCloser indicates that the [Query] wants to send a find closer nodes message to a node.
StateQueryFinished indicates that the [Query] has finished.
StateQuerySendMessage indicates that the [Query] wants to send a message to a node.
StateQueryWaitingAtCapacity indicates that the [Query] is waiting for results and is at capacity.
StateQueryWaitingWithCapacity indicates that the [Query] is waiting for results but has no further nodes to contact.
# Interfaces
A NodeIter iterates nodes according to some strategy.
No description provided by the author
PoolEvent is an event intended to advance the state of a pool.
No description provided by the author
No description provided by the author
No description provided by the author