package
0.0.0-20250303191223-d8329aeac5c7
Repository: https://github.com/mongodb/amboy.git
Documentation: pkg.go.dev
# Functions
DefaultMongoDBOptions constructs a new options object with default values: connecting to a MongoDB instance on localhost, using the "amboy" database.
NewBasicRetryHandler initializes and returns an BasicRetryHandler that can be used as an amboy.RetryHandler implementation.
NewCacheWithCleanupHook defines a cache but allows implementations to add additional cleanup logic to the prune and Close operations.
NewDispatcher constructs a default dispatching implementation.
NewGroupCache produces a GroupCache implementation that supports a default TTL setting, and supports cloning and closing operations.
NewLocalLimitedSize constructs a queue instance with the specified number of workers and maximum capacity.
NewLocalLimitedSizeSerializable constructs a local limited-size retryable queue instance with the specified number of workers and maximum capacity.
NewLocalLimitedSizeSerializableWithOptions constructs a local limited-size retryable queue instance with the given options.
NewLocalQueueGroup constructs a new local queue group.
NewLocalScopeManager constructs a ScopeManager implementation suitable for use in most local (in memory) queue implementations.
NewMongoDBQueue builds a new queue that persists jobs to a MongoDB instance.
NewMongoDBSingleQueueGroup constructs a new remote queue group.
# Structs
BasicRetryHandler implements the amboy.RetryHandler interface.
LocalLimitedSizeSerializableOptions provides options to configure and initialize a limited-size local amboy.RetryableQueue.
LocalQueueGroupOptions describe options passed to NewLocalQueueGroup.
LocalQueueOptions represent options to construct a local queue.
MongoDBOptions represents options for creating a MongoDB driver to communicate MongoDB-specific settings about the driver's behavior and operation.
MongoDBQueueGroupOptions describe options to create a queue group backed by MongoDB.
MongoDBQueueOptions represent options to create a queue that stores jobs in a persistence layer to support distributed systems of workers.
PreferredIndexOptions provide options to explicitly set the index for use in specific scenarios.
RegexpMongoDBQueueOptions represents a mapping from a regular expression to match named queues in a queue group to options for those queues.
RetryableQueueOptions represent common options to configure an amboy.RetryableQueue.
# Interfaces
Dispatcher provides a common mechanism shared between queue implementations to handle job locking to prevent multiple workers from running the same job.
GroupCache provides a common mechanism for managing collections of queues, for use in specific group cache situations.
ScopeManager provides a service to queue implementations to support additional locking semantics for queues that cannot push that into their backing storage.