FlutterRunLoop Class Reference

#import <FlutterRunLoop.h>

Inheritance diagram for FlutterRunLoop:

Instance Methods
(void)	- performBlock:
(void)	- performBlock:afterDelay:
(void)	- pollFlutterMessagesOnce

Class Methods
(void)	+ ensureMainLoopInitialized
(FlutterRunLoop *)	+ mainRunLoop

Detailed Description

Interface for scheduling tasks on the run loop.

Main difference between using FlutterRunLoop to schedule tasks compared to dispatch_async or [NSRunLoop performBlock:] is that FlutterRunLoop schedules the task in both common run loop mode and a private run loop mode, which allows it to run in mode where it only processes Flutter messages ([FlutterRunLoop pollFlutterMessagesOnce]).

Definition at line 15 of file FlutterRunLoop.h.

Method Documentation

ensureMainLoopInitialized

+ (void) ensureMainLoopInitialized

Ensures that the FlutterRunLoop for main thread is initialized. Only needs to be called once and must be called on the main thread.

Definition at line 31 of file FlutterRunLoop.mm.

                                  {
  FML_DCHECK(NSRunLoop.currentRunLoop == NSRunLoop.mainRunLoop);
  if (mainLoop == nil) {
    mainLoop = [[FlutterRunLoop alloc] init];
  }
}

Referenced by FlutterDisplayLinkTest::SetUp(), and FlutterVSyncWaiterTest::SetUp().

mainRunLoop

+ (FlutterRunLoop *) mainRunLoop

Returns the FlutterRunLoop for the main thread.

Definition at line 31 of file FlutterRunLoop.mm.

                               {
  FML_DCHECK(mainLoop != nil);
  return mainLoop;
}

Referenced by TEST().

performBlock:

- (void) performBlock:

(void(^)(void))

block

Schedules a block to be executed on the main thread.

Definition at line 31 of file FlutterRunLoop.mm.

                    :(void (^)(void))block {
  [self performBlock:block afterDelay:0];
}

performBlock:afterDelay:

- (void) performBlock:		(void(^)(void))	block
afterDelay:		(NSTimeInterval)	delay

Schedules a block to be executed on the main thread after a delay.

Definition at line 31 of file FlutterRunLoop.mm.

                    :(void (^)(void))block afterDelay:(NSTimeInterval)delay {
  @synchronized(self) {
    _tasks.emplace_back(block, CFAbsoluteTimeGetCurrent() + delay);
    if (delay > 0) {
      [self rearmTimer];
    } else {
      CFRunLoopSourceSignal(_source);
      CFRunLoopWakeUp(_runLoop);
    }
  }
}

pollFlutterMessagesOnce

- (void) pollFlutterMessagesOnce

Executes single iteration of the run loop in the mode where only Flutter messages are processed.

Definition at line 31 of file FlutterRunLoop.mm.

                                {
  CFRunLoopRunInMode(kFlutterRunLoopMode, 0.1, YES);
}

Referenced by TEST_F().

---

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

• shell/platform/darwin/macos/framework/Source/FlutterRunLoop.h
• shell/platform/darwin/macos/framework/Source/FlutterRunLoop.mm