ApiCaller<Input> mixin

Mixin containing logic to collect requests in collection and cancel them in a batch when BaseKoreInstance.dispose called

abstract class BaseBox extends BaseKoreInstance<dynamic> with ApiCaller<dynamic> {
  String get boxName;

  late final hiveWrapper = app.instances.get<HiveWrapper>();

  @mustCallSuper
  @override
  void dispose() {
    super.dispose();

    cancelAllRequests();
  }
}
Superclass constraints
Mixin applications

Properties

allPartsReady → Observable<bool>
Observable indicating that all parts are connected to this instance
finalinherited
configuration → KoreInstanceConfiguration
KoreInstanceConfiguration for this instance
no setterinherited
disposeOperations → List<Function>
List of operations that will be executed with dispose call
finalinherited
hashCode → int
The hash code for this object.
no setterinherited
initializationCompleter → Completer
finalinherited
input ↔ Input
Input for this instance
latefinalinherited
isAsync → bool
Getter that returns true if instance contains async parts or require async initialization
no setterinherited
isDisposed ↔ bool
Flag indicating that this instance is disposed
getter/setter pairinherited
isInitialized ↔ bool
Flag indicating that this instance is fully initialized
getter/setter pairinherited
isPaused ↔ bool
getter/setter pairinherited
requests → List<BaseRequest>
Collection of requests running in this instance
final
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited

Methods

cancelAllRequests() → void
Cancels all requests in local requests collection
checkEventWasReceived(Type event, {int? count}) → bool
Returns true if underlying events list contains given event name
inherited
cleanupReceivedEvents() → void
Cleans collection of received events
inherited
disposeEventBusSubscription() → void
Closes underlying stream subscription for EventBus
inherited
disposeInstance() → void
Base method for instance dispose
inherited
ensureInitialized<O>(Future<O> block()) → Future<O>
Helper function that runs given block after async initialization is completed.
inherited
executeAndCancelOnDispose<T, I, B, F>(BaseRequest<T, I, B, F> request) → Future<Response<T>>
Executes request and adds it in local requests collection
getFullPartConnectorsList() → List<PartConnector>
Returns list of parts
inherited
initialize(Input input) → void
Base method for instance initialization
inherited
initializeAsync() → Future<void>
Base method for async instance initialization.
inherited
initializeEventBusSubscription() → void
inherited
initializeInstanceParts() → void
Adds parts to local collection
inherited
initializeInstancePartsAsync() → Future<void>
Adds parts to local collection
inherited
initializeWithoutConnections(Input input) → void
Base method for lightweight instance initialization
inherited
initializeWithoutConnectionsAsync() → Future<void>
Base method for lightweight async instance initialization
inherited
markInitialized() → void
inherited
noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
on<T>(EventBusSubscriber<T> processor, {bool reactsToPause = false, bool firesAfterResume = true}) → EventBusSubscriber
Subscribes to event of given type
inherited
onAllPartReady() → void
Runs for every async part when it is initialized
inherited
onAsyncPartReady(Type type, int? index) → void
Runs for every async part when it is initialized
inherited
pauseEventBusSubscription() → void
Sets paused flag to false so events stop processing
inherited
resumeEventBusSubscription({bool sendAllEventsReceivedWhilePause = true}) → void
Resumes events processing
inherited
subscribe() → void
Map of EventBus events and function to be executed for this events
inherited
toString() → String
A string representation of this object.
inherited
useInstancePart<InstancePartType extends BaseInstancePart<dynamic, KoreInstance>>({int index = 0}) → InstancePartType
Returns initialized instance part for given type
inherited
waitTillEventIsReceived(Type event, {int? count, Duration timeout = const Duration(seconds: 1)}) → Future<void>
Waits till given event is received by this instance
inherited

Operators

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