BaseWrapper<Input> class
abstract
Base class that wraps logic for working with third party dependency
Wrappers can contain dependencies and receive events They also can contain parts You also can execute requests and cancel them automatically when wrapper will be disposed with ApiCaller.executeAndCancelOnDispose method
Also wrappers can execute operations in sync with SynchronizedKoreInstance.enqueue
Example:
@singleton
class StripeWrapper extends BaseWrapper<String> {
}
- Inheritance
-
- Object
- BaseKoreInstance<
Input?> - BaseWrapper
- Mixed-in types
-
- DependentKoreInstance<
Input?> - SynchronizedKoreInstance<
Input?> - ApiCaller<
Input?>
- DependentKoreInstance<
Constructors
Properties
-
allDependenciesReady
→ Observable<
bool> -
Observable holding value of successfull dependencies initialization
finalinherited
-
allPartsReady
→ Observable<
bool> -
Observable indicating that all parts are connected to this instance
finalinherited
- configuration → DependentKoreInstanceConfiguration
-
DependentKoreInstanceConfiguration 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
finalinherited
- runtimeType → Type
-
A representation of the runtime type of the object.
no setterinherited
Methods
-
cancelAllRequests(
) → void -
Cancels all requests in local requests collection
inherited
-
cancelPendingOperations(
) → void -
Cancels all operations in current queue
inherited
-
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
-
dispose(
) → void -
override
-
disposeDependencies(
) → void -
Disposes all dependencies
inherited
-
disposeEventBusSubscription(
) → void -
Closes underlying stream subscription for EventBus
inherited
-
disposeInstance(
) → void -
Base method for instance dispose
inherited
-
enqueue(
{bool discardOnDispose = true, Duration? timeout, required Future< void> operation(), FutureOr<void> onTimeout()?}) → Future<void> -
Executes operation in sync meaning that if you wrap any code in this function
the code will be executed in place if currently there are no other operations running
otherwise function will add operation to queue and it will be executed after all previously executed operations are completed
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
inherited
-
getFullConnectorsList(
) → List< Connector> -
Returns list of dependencies from every module
and combines it with local dependencies
inherited
-
getFullPartConnectorsList(
) → List< PartConnector> -
Returns list of parts from every module
and combines it with local parts
inherited
-
initialize(
Input? input) → void -
Base method for instance initialization
override
-
initializeAsync(
) → Future< void> -
Base method for async instance initialization.
override
-
initializeDependencies(
) → void -
Initializes all dependencies and increase reference count in ScopedContainer
inherited
-
initializeDependenciesAsync(
) → Future< void> -
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
-
onAllDependenciesReady(
) → void -
Runs after every async instance is initialized
inherited
-
onAllPartReady(
) → void -
Runs for every async part when it is initialized
inherited
-
onAsyncInstanceReady(
Type type, int? index) → void -
Runs for every async instance 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
-
useAsyncLazyLocalInstance<
T extends BaseKoreInstance> ({int index = 0}) → Future< T> -
Returns connected instance of given type
inherited
-
useInstancePart<
InstancePartType extends BaseInstancePart< (dynamic, KoreInstance> >{int index = 0}) → InstancePartType -
Returns initialized instance part for given type
inherited
-
useLazyLocalInstance<
T extends BaseKoreInstance> ({int index = 0}) → T -
Returns connected instance of given type
inherited
-
useLocalInstance<
T extends BaseKoreInstance> ({int index = 0}) → T -
Returns connected instance of given type
inherited
-
useModule<
T extends InstancesModule> () → T -
Connects module from dependencies and returns its reference
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