FlutterEngineGroup Class Reference

#import <FlutterEngineGroup.h>

Inheritance diagram for FlutterEngineGroup:

Instance Methods
(instancetype)	- NS_UNAVAILABLE
(instancetype)	- initWithName:project:
(FlutterEngine *)	- makeEngineWithEntrypoint:libraryURI:
(FlutterEngine *)	- makeEngineWithEntrypoint:libraryURI:initialRoute:
(FlutterEngine *)	- makeEngineWithOptions:

Detailed Description

Represents a collection of FlutterEngines who share resources which allows them to be created with less time const and occupy less memory than just creating multiple FlutterEngines.

Deleting a FlutterEngineGroup doesn't invalidate existing FlutterEngines, but it eliminates the possibility to create more FlutterEngines in that group.

Warning

This class is a work-in-progress and may change.

See also

https://github.com/flutter/flutter/issues/72009

Definition at line 56 of file FlutterEngineGroup.h.

Method Documentation

initWithName:project:

- (instancetype) initWithName:		(NSString*)	name
project:		(nullable FlutterDartProject*)	NS_DESIGNATED_INITIALIZER

Initialize a new FlutterEngineGroup.

Parameters

name	The name that will present in the threads shared across the engines in this group.
project	The FlutterDartProject that all FlutterEngines in this group will be executing.

Definition at line 22 of file FlutterEngineGroup.mm.

                            :(NSString*)name project:(nullable FlutterDartProject*)project {
  self = [super init];
  if (self) {
    _name = [name copy];
    _engines = [[NSMutableArray<NSValue*> alloc] init];
    _project = project;
  }
  return self;
}

References _name.

makeEngineWithEntrypoint:libraryURI:

- (FlutterEngine *) makeEngineWithEntrypoint:		(nullable NSString*)	entrypoint
libraryURI:		(nullable NSString*)	libraryURI

Creates a running FlutterEngine that shares components with this group.

Parameters

entrypoint	The name of a top-level function from a Dart library. If this is FlutterDefaultDartEntrypoint (or nil); this will default to main(). If it is not the app's main() function, that function must be decorated with @pragma(vm:entry-point) to ensure the method is not tree-shaken by the Dart compiler.
libraryURI	The URI of the Dart library which contains the entrypoint method. IF nil, this will default to the same library as the main() function in the Dart program.

See also

FlutterEngineGroup

Definition at line 32 of file FlutterEngineGroup.mm.

                                          :(nullable NSString*)entrypoint
                                libraryURI:(nullable NSString*)libraryURI {
  return [self makeEngineWithEntrypoint:entrypoint libraryURI:libraryURI initialRoute:nil];
}

References makeEngineWithEntrypoint:libraryURI:initialRoute:.

makeEngineWithEntrypoint:libraryURI:initialRoute:

- (FlutterEngine *) makeEngineWithEntrypoint:		(nullable NSString*)	entrypoint
libraryURI:		(nullable NSString*)	libraryURI
initialRoute:		(nullable NSString*)	initialRoute

Creates a running FlutterEngine that shares components with this group.

Parameters

entrypoint	The name of a top-level function from a Dart library. If this is FlutterDefaultDartEntrypoint (or nil); this will default to main(). If it is not the app's main() function, that function must be decorated with @pragma(vm:entry-point) to ensure the method is not tree-shaken by the Dart compiler.
libraryURI	The URI of the Dart library which contains the entrypoint method. IF nil, this will default to the same library as the main() function in the Dart program.
initialRoute	The name of the initial Flutter Navigator Route to load. If this is FlutterDefaultInitialRoute (or nil), it will default to the "/" route.

See also

FlutterEngineGroup

Definition at line 37 of file FlutterEngineGroup.mm.

                                          :(nullable NSString*)entrypoint
                                libraryURI:(nullable NSString*)libraryURI
                              initialRoute:(nullable NSString*)initialRoute {
  FlutterEngineGroupOptions* options = [[FlutterEngineGroupOptions alloc] init];
  options.entrypoint = entrypoint;
  options.libraryURI = libraryURI;
  options.initialRoute = initialRoute;
  return [self makeEngineWithOptions:options];
}

References FlutterEngineGroupOptions::entrypoint, FlutterEngineGroupOptions::initialRoute, FlutterEngineGroupOptions::libraryURI, and makeEngineWithOptions:.

Referenced by makeEngineWithEntrypoint:libraryURI:.

makeEngineWithOptions:

- (FlutterEngine *) makeEngineWithOptions:

(nullable FlutterEngineGroupOptions*)

options

Creates a running FlutterEngine that shares components with this group.

Parameters

options

Options that control how a FlutterEngine should be created.

See also

FlutterEngineGroupOptions

Definition at line 47 of file FlutterEngineGroup.mm.

                                       :(nullable FlutterEngineGroupOptions*)options {
  NSString* entrypoint = options.entrypoint;
  NSString* libraryURI = options.libraryURI;
  NSString* initialRoute = options.initialRoute;
  NSArray<NSString*>* entrypointArgs = options.entrypointArgs;
 
  FlutterEngine* engine;
  if (self.engines.count <= 0) {
    engine = [self makeEngine];
    [engine runWithEntrypoint:entrypoint
                   libraryURI:libraryURI
                 initialRoute:initialRoute
               entrypointArgs:entrypointArgs];
  } else {
    FlutterEngine* spawner = (FlutterEngine*)[self.engines[0] pointerValue];
    engine = [spawner spawnWithEntrypoint:entrypoint
                               libraryURI:libraryURI
                             initialRoute:initialRoute
                           entrypointArgs:entrypointArgs];
  }
  // TODO(cbracken): https://github.com/flutter/flutter/issues/155943
  [self.engines addObject:[NSValue valueWithPointer:(__bridge void*)engine]];
 
  NSNotificationCenter* center = [NSNotificationCenter defaultCenter];
  [center addObserver:self
             selector:@selector(onEngineWillBeDealloced:)
                 name:kFlutterEngineWillDealloc
               object:engine];
 
  return engine;
}

References engine, FlutterEngineGroupOptions::entrypoint, FlutterEngineGroupOptions::entrypointArgs, FlutterEngineGroupOptions::initialRoute, FlutterEngineGroupOptions::libraryURI, FlutterEngine::runWithEntrypoint:libraryURI:initialRoute:entrypointArgs:, and FlutterEngine::spawnWithEntrypoint:libraryURI:initialRoute:entrypointArgs:.

Referenced by makeEngineWithEntrypoint:libraryURI:initialRoute:.

NS_UNAVAILABLE

- (instancetype) NS_UNAVAILABLE

---

The documentation for this class was generated from the following files:

• shell/platform/darwin/ios/framework/Headers/FlutterEngineGroup.h
• shell/platform/darwin/ios/framework/Source/FlutterEngineGroup.mm