FlutterKeyCallbackGuard Class Reference

Inheritance diagram for FlutterKeyCallbackGuard:

Instance Methods
(nonnull instancetype)	- initWithCallback:
(void)	- pendTo:withId:
(void)	- resolveTo:
(nonnull instancetype)	- initWithCallback:
(void)	- pendTo:withId:
(void)	- resolveTo:

Properties
BOOL	handled
NSString *	debugHandleSource
BOOL	sentAnyEvents

Detailed Description

Guards a |FlutterAsyncKeyCallback| to make sure it's handled exactly once throughout the process of handling an event in |FlutterEmbedderKeyResponder|.

A callback can either be handled with |pendTo:withId:|, or with |resolveTo:|. Either way, the callback cannot be handled again, or an assertion will be thrown.

Guards a |FlutterAsyncKeyCallback| to make sure it's handled exactly once throughout |FlutterEmbedderKeyResponder.handleEvent|.

A callback can either be handled with |pendTo:withId:|, or with |resolveTo:|. Either way, the callback cannot be handled again, or an assertion will be thrown.

Definition at line 287 of file FlutterEmbedderKeyResponder.mm.

Method Documentation

initWithCallback: [1/2]

- (nonnull instancetype) initWithCallback:

(FlutterAsyncKeyCallback)

callback

Initial value:

{
  
  
  FlutterAsyncKeyCallback _callback

Definition at line 308 of file FlutterEmbedderKeyResponder.mm.

                                        :(FlutterAsyncKeyCallback)callback {
  self = [super init];
  if (self != nil) {
    _callback = [callback copy];
    _handled = FALSE;
  }
  return self;
}

initWithCallback: [2/2]

- (nonnull instancetype) initWithCallback:

(FlutterAsyncKeyCallback)

callback

pendTo:withId: [1/2]

- (void) pendTo:		(nonnull NSMutableDictionary<NSNumber*, FlutterAsyncKeyCallback>*)	pendingResponses
withId:		(uint64_t)	responseId

Handle the callback by storing it to pending responses.

Definition at line 308 of file FlutterEmbedderKeyResponder.mm.

              :(nonnull NSMutableDictionary<NSNumber*, FlutterAsyncKeyCallback>*)pendingResponses
        withId:(uint64_t)responseId {
  NSAssert(!_handled, @"This callback has been handled by %@.", _debugHandleSource);
  if (_handled) {
    return;
  }
  pendingResponses[@(responseId)] = _callback;
  _handled = TRUE;
  NSAssert(
      ((_debugHandleSource = [NSString stringWithFormat:@"pending event %llu", responseId]), TRUE),
      @"");
}

pendTo:withId: [2/2]

- (void) pendTo:		(nonnull NSMutableDictionary< NSNumber *, FlutterAsyncKeyCallback > *)	pendingResponses
withId:		(uint64_t)	responseId

Handle the callback by storing it to pending responses.

resolveTo: [1/2]

- (void) resolveTo:

(BOOL)

handled

Handle the callback by calling it with a result.

Definition at line 308 of file FlutterEmbedderKeyResponder.mm.

                 :(BOOL)handled {
  NSAssert(!_handled, @"This callback has been handled by %@.", _debugHandleSource);
  if (_handled) {
    return;
  }
  _callback(handled);
  _handled = TRUE;
  NSAssert(((_debugHandleSource = [NSString stringWithFormat:@"resolved with %d", _handled]), TRUE),
           @"");
}

resolveTo: [2/2]

- (void) resolveTo:

(BOOL)

handled

Handle the callback by calling it with a result.

Property Documentation

debugHandleSource

- (NSString *) debugHandleSource

readwritenonatomiccopy

A string indicating how the callback is handled.

Only set in debug mode. Nil in release mode, or if the callback has not been handled.

Definition at line 308 of file FlutterEmbedderKeyResponder.mm.

handled

- (BOOL) handled

readwritenonatomicassign

Definition at line 301 of file FlutterEmbedderKeyResponder.mm.

sentAnyEvents

- (BOOL) sentAnyEvents

readwritenonatomicassign

Definition at line 282 of file FlutterEmbedderKeyResponder.mm.

---

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

• shell/platform/darwin/ios/framework/Source/FlutterEmbedderKeyResponder.mm
• shell/platform/darwin/macos/framework/Source/FlutterEmbedderKeyResponder.mm