package
1.1.3
Repository: https://github.com/infinitbyte/framework.git
Documentation: pkg.go.dev

# Functions

No description provided by the author
AllowedFields checks that only allowed fields are used in the configuration.
Cap returns the capacity of this default pool.
No description provided by the author
No description provided by the author
No description provided by the author
Free returns the available goroutines to work.
No description provided by the author
No description provided by the author
MutuallyExclusiveRequiredFields checks that only one of the given fields is used at the same time.
NewConditional returns a constructor suitable for registering when conditionals as a plugin.
NewConditionList takes a slice of Config objects and turns them into real Condition objects.
NewConditionRule returns a processor that will execute the provided processor if the condition is true.
NewPipeline creates new DAG.
No description provided by the author
No description provided by the author
NewFilterConditional returns a constructor suitable for registering when conditionals as a plugin.
NewFilterConditionList takes a slice of Config objects and turns them into real Condition objects.
NewFilterConditionRule returns a processor that will execute the provided processor if the condition is true.
No description provided by the author
NewIfElseThenFilter construct a new IfThenElseFilter.
NewIfElseThenProcessor construct a new IfThenElseProcessor.
No description provided by the author
No description provided by the author
No description provided by the author
NewPool generates an instance of ants pool.
NewPoolWithFunc generates an instance of ants pool with a specific function.
No description provided by the author
No description provided by the author
Reboot reboots the default pool.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
Release Closes the default pool.
ReleaseContext could be called concurrently Doesn't handle context lifecycle, only recycle the resources Mark the context as released, quit the pipeline loop automatically.
RequireFields checks that the required fields are present in the configuration.
Running returns the number of the currently running goroutines.
Submit submits a task to pool.
WithExpiryDuration sets up the interval time of cleaning up goroutines.
WithLogger sets up a customized logger.
WithMaxBlockingTasks sets up the maximum number of goroutines that are blocked when it reaches the capacity of pool.
WithNonblocking indicates that pool will return nil when there is no available workers.
WithOptions accepts the whole options config.
WithPanicHandler sets up panic handler.
WithPreAlloc indicates whether it should malloc for workers.

# Constants

CLOSED represents that the pool is closed.
DefaultAntsPoolSize is the default capacity for a default goroutine pool.
DefaultCleanIntervalTime is the interval time to clean up goroutines.
No description provided by the author
No description provided by the author
OPENED represents that the pool is opened.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author

# Variables

ErrInvalidPoolExpiry will be returned when setting a negative number as the periodic duration to purge goroutines.
ErrInvalidPreAllocSize will be returned when trying to set up a negative capacity under PreAlloc mode.
ErrLackPoolFunc will be returned when invokers don't provide function for pool.
ErrPoolClosed will be returned when submitting task to a closed pool.
ErrPoolOverload will be returned when the pool is full and no workers available.
ErrTimeout will be returned after the operations timed out.

# Structs

No description provided by the author
Dag represents directed acyclic graph.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
IfThenElseFilter executes one set of processors (then) if the condition is true and another set of processors (else) if the condition is false.
IfThenElseProcessor executes one set of processors (then) if the condition is true and another set of processors (else) if the condition is false.
Job - Each job consists of one or more tasks Each Job can runs tasks in order(Sequential) or unordered.
No description provided by the author
Options contains all options which will be applied when instantiating an ants pool.
No description provided by the author
Pool accepts the tasks from client, it limits the total of goroutines to a given number by recycling goroutines.
PoolWithFunc accepts the tasks from client, it limits the total of goroutines to a given number by recycling goroutines.
No description provided by the author
No description provided by the author
No description provided by the author
WhenFilter is a tuple of condition plus a Processor.
WhenProcessor is a tuple of condition plus a Processor.

# Interfaces

No description provided by the author
No description provided by the author
Logger is used for logging formatted messages.
No description provided by the author
No description provided by the author
No description provided by the author

# Type aliases

No description provided by the author
No description provided by the author
Option represents the optional function.
No description provided by the author
No description provided by the author