GruntMixin<SELF extends Grunt> mixin

Implemented types
Available extensions

Properties

channel GruntChannel
no setteroverride
create GruntFactoryFn<SELF>
no setterinherited
currentStatus WorkStatus
no setteroverride
encoding PayloadHandler
The encoding you use for this type of operation
no setteroverride
error ErrorStack?
getter/setter pair
fallbackEncoding PayloadHandler
no setter
hashCode int
The hash code for this object.
no setterinherited
isShuttingDown bool

Available on Grunt, provided by the GruntExt extension

no setter
jobId String
The specific job that this grunt is processing currently
final
key String
A unique key that identifies this worker
no setterinherited
log → Logger
no setteroverride
message String?
getter/setter pair
package String?
no setterinherited
params ↔ dynamic
getter/setter pair
progress double
getter/setter pair
runtimeType Type
A representation of the runtime type of the object.
no setterinherited
state Map<String, dynamic>?
getter/setter pair
total double?
getter/setter pair
workPhase WorkPhase
getter/setter pairoverride

Methods

decodePayload(int? contentType, dynamic content, PayloadDecoder next) → dynamic
doInitialize() FutureOr
encodePayload(Payload payload, PayloadEncoder next) Payload
Override this to customize encoding strategy. Call next to chain them together, or just return something custom
execute(dynamic params) Future
initialize(GruntChannel channel, [dynamic params]) → void
Initializes and creates a job id
override
noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
onError(ErrorStack? err) FutureOr
onStop() FutureOr
register() → void

Available on GruntFactory<Grunt>, provided by the GruntFactoryRegister extension

sendStatus() → void

Available on Grunt, provided by the GruntExt extension

sendUpdate({String? message, double? progress, Map<String, dynamic>? state}) → void
start(dynamic params) Future
Instructs the agent to start processing
override
stop() → void
Instructs the agent to stop
override
toString() String
A string representation of this object.
inherited
withPhase(WorkPhase phase, FutureOr exec()) bool

Available on Grunt, provided by the GruntExt extension

Operators

operator ==(Object other) bool
The equality operator.
inherited