FlutterEngineTerminationHandler Class Reference

#include <FlutterEngine_Internal.h>

Inheritance diagram for FlutterEngineTerminationHandler:

Instance Methods
(instancetype)	- initWithEngine:terminator:
(void)	- handleRequestAppExitMethodCall:result:
(void)	- requestApplicationTermination:exitType:result:
(instancetype)	- initWithEngine:terminator: [implementation]
(void)	- requestApplicationTermination:exitType:result: [implementation]

Properties
BOOL	shouldTerminate
BOOL	acceptingRequests

Detailed Description

A handler interface for handling application termination that the FlutterAppDelegate can use to coordinate an application exit by sending messages through the platform channel managed by the engine.

Definition at line 188 of file FlutterEngine.mm.

Method Documentation

handleRequestAppExitMethodCall:result:

- (void) handleRequestAppExitMethodCall:		(NSDictionary<NSString*, id>*)	data
result:		(FlutterResult)	result

Definition at line 190 of file FlutterEngine.mm.

                                      :(NSDictionary<NSString*, id>*)arguments
                                result:(FlutterResult)result {
  NSString* type = arguments[@"type"];
  // Ignore the "exitCode" value in the arguments because AppKit doesn't have
  // any good way to set the process exit code other than calling exit(), and
  // that bypasses all of the native applicationShouldExit shutdown events,
  // etc., which we don't want to skip.
 
  FlutterAppExitType exitType =
      [type isEqualTo:@"cancelable"] ? kFlutterAppExitTypeCancelable : kFlutterAppExitTypeRequired;
 
  [self requestApplicationTermination:[NSApplication sharedApplication]
                             exitType:exitType
                               result:result];
}

initWithEngine:terminator: [1/2]

- (instancetype) initWithEngine: (FlutterEngine*)  engine terminator: (FlutterTerminationCallback)  terminator

implementation

Definition at line 190 of file FlutterEngine.mm.

                              :(FlutterEngine*)engine
                    terminator:(FlutterTerminationCallback)terminator {
  self = [super init];
  _acceptingRequests = NO;
  _engine = engine;
  _terminator = terminator ? terminator : ^(id sender) {
    // Default to actually terminating the application. The terminator exists to
    // allow tests to override it so that an actual exit doesn't occur.
    [[NSApplication sharedApplication] terminate:sender];
  };
  id<NSApplicationDelegate> appDelegate = [[NSApplication sharedApplication] delegate];
  if ([appDelegate respondsToSelector:@selector(setTerminationHandler:)]) {
    FlutterAppDelegate* flutterAppDelegate = reinterpret_cast<FlutterAppDelegate*>(appDelegate);
    flutterAppDelegate.terminationHandler = self;
  }
  return self;
}

initWithEngine:terminator: [2/2]

- (instancetype) initWithEngine:		(FlutterEngine *)	engine
terminator:		(nullable FlutterTerminationCallback)	terminator

requestApplicationTermination:exitType:result: [1/2]

- (void) requestApplicationTermination: (id)  sender exitType: (FlutterAppExitType)  type result: (nullable FlutterResult)  result

implementation

Definition at line 190 of file FlutterEngine.mm.

                                     :(id)sender
                             exitType:(FlutterAppExitType)type
                               result:(nullable FlutterResult)result {
  _shouldTerminate = YES;
  if (![self acceptingRequests]) {
    // Until the Dart application has signaled that it is ready to handle
    // termination requests, the app will just terminate when asked.
    type = kFlutterAppExitTypeRequired;
  }
  switch (type) {
    case kFlutterAppExitTypeCancelable: {
      FlutterJSONMethodCodec* codec = [FlutterJSONMethodCodec sharedInstance];
      FlutterMethodCall* methodCall =
          [FlutterMethodCall methodCallWithMethodName:@"System.requestAppExit" arguments:nil];
      [_engine sendOnChannel:kFlutterPlatformChannel
                     message:[codec encodeMethodCall:methodCall]
                 binaryReply:^(NSData* _Nullable reply) {
                   NSAssert(_terminator, @"terminator shouldn't be nil");
                   id decoded_reply = [codec decodeEnvelope:reply];
                   if ([decoded_reply isKindOfClass:[FlutterError class]]) {
                     FlutterError* error = (FlutterError*)decoded_reply;
                     NSLog(@"Method call returned error[%@]: %@ %@", [error code], [error message],
                           [error details]);
                     _terminator(sender);
                     return;
                   }
                   if (![decoded_reply isKindOfClass:[NSDictionary class]]) {
                     NSLog(@"Call to System.requestAppExit returned an unexpected object: %@",
                           decoded_reply);
                     _terminator(sender);
                     return;
                   }
                   NSDictionary* replyArgs = (NSDictionary*)decoded_reply;
                   if ([replyArgs[@"response"] isEqual:@"exit"]) {
                     _terminator(sender);
                   } else if ([replyArgs[@"response"] isEqual:@"cancel"]) {
                     _shouldTerminate = NO;
                   }
                   if (result != nil) {
                     result(replyArgs);
                   }
                 }];
      break;
    }
    case kFlutterAppExitTypeRequired:
      NSAssert(_terminator, @"terminator shouldn't be nil");
      _terminator(sender);
      break;
  }
}

requestApplicationTermination:exitType:result: [2/2]

- (void) requestApplicationTermination:		(NSApplication *)	sender
exitType:		(FlutterAppExitType)	type
result:		(nullable FlutterResult)	result

Property Documentation

acceptingRequests

- (BOOL) acceptingRequests

readwritenonatomicassign

Definition at line 60 of file FlutterEngine_Internal.h.

shouldTerminate

- (BOOL) shouldTerminate

readnonatomicassign

Definition at line 59 of file FlutterEngine_Internal.h.

---

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

• shell/platform/darwin/macos/framework/Source/FlutterEngine.mm
• shell/platform/darwin/macos/framework/Source/FlutterEngine_Internal.h