fml::MessageLoop Class Reference

#include <message_loop.h>

Public Member Functions
void	Run ()
void	Terminate ()
void	AddTaskObserver (intptr_t key, const fml::closure &callback)
void	RemoveTaskObserver (intptr_t key)
fml::RefPtr< fml::TaskRunner >	GetTaskRunner () const
void	RunExpiredTasksNow ()
	~MessageLoop ()

Static Public Member Functions
static FML_EMBEDDER_ONLY MessageLoop &	GetCurrent ()
static void	EnsureInitializedForCurrentThread ()
static bool	IsInitializedForCurrentThread ()
static TaskQueueId	GetCurrentTaskQueueId ()

Friends
class	TaskRunner
class	MessageLoopImpl

Detailed Description

An event loop associated with a thread.

This class is the generic front-end to the MessageLoop, differences in implementation based on the running platform are in the subclasses of flutter::MessageLoopImpl (ex flutter::MessageLoopAndroid).

For scheduling events on the message loop see flutter::TaskRunner.

See also

fml::TaskRunner

fml::MessageLoopImpl

fml::MessageLoopTaskQueues

fml::Wakeable

Definition at line 28 of file message_loop.h.

Constructor & Destructor Documentation

~MessageLoop()

fml::MessageLoop::~MessageLoop ( )

default

Member Function Documentation

AddTaskObserver()

void fml::MessageLoop::AddTaskObserver	(	intptr_t	key,
		const fml::closure &	callback
	)

Definition at line 64 of file message_loop.cc.

                                                                          {
  loop_->AddTaskObserver(key, callback);
}

EnsureInitializedForCurrentThread()

void fml::MessageLoop::EnsureInitializedForCurrentThread ( )

static

Definition at line 27 of file message_loop.cc.

                                                    {
  if (tls_message_loop.get() != nullptr) {
    // Already initialized.
    return;
  }
  tls_message_loop.reset(new MessageLoop());
}

GetCurrent()

MessageLoop & fml::MessageLoop::GetCurrent ( )

static

Definition at line 19 of file message_loop.cc.

                                     {
  auto* loop = tls_message_loop.get();
  FML_CHECK(loop != nullptr)
      << "MessageLoop::EnsureInitializedForCurrentThread was not called on "
         "this thread prior to message loop use.";
  return *loop;
}

GetCurrentTaskQueueId()

TaskQueueId fml::MessageLoop::GetCurrentTaskQueueId ( )

static

Gets the unique identifier for the TaskQueue associated with the current thread.

See also

fml::MessageLoopTaskQueues

Definition at line 76 of file message_loop.cc.

                                               {
  auto* loop = tls_message_loop.get();
  FML_CHECK(loop != nullptr)
      << "MessageLoop::EnsureInitializedForCurrentThread was not called on "
         "this thread prior to message loop use.";
  return loop->GetLoopImpl()->GetTaskQueueId();
}

GetTaskRunner()

fml::RefPtr< fml::TaskRunner > fml::MessageLoop::GetTaskRunner

(

)

const

Definition at line 56 of file message_loop.cc.

                                                          {
  return task_runner_;
}

IsInitializedForCurrentThread()

bool fml::MessageLoop::IsInitializedForCurrentThread ( )

static

Returns true if EnsureInitializedForCurrentThread has been called on this thread already.

Definition at line 35 of file message_loop.cc.

                                                {
  return tls_message_loop.get() != nullptr;
}

RemoveTaskObserver()

void fml::MessageLoop::RemoveTaskObserver

(

intptr_t

key

)

Definition at line 68 of file message_loop.cc.

                                                 {
  loop_->RemoveTaskObserver(key);
}

Run()

void fml::MessageLoop::Run

(

)

Definition at line 48 of file message_loop.cc.

                      {
  loop_->DoRun();
}

RunExpiredTasksNow()

void fml::MessageLoop::RunExpiredTasksNow

(

)

Definition at line 72 of file message_loop.cc.

                                     {
  loop_->RunExpiredTasksNow();
}

Terminate()

void fml::MessageLoop::Terminate

(

)

Definition at line 52 of file message_loop.cc.

                            {
  loop_->DoTerminate();
}

Friends And Related Symbol Documentation

MessageLoopImpl

friend class MessageLoopImpl

friend

Definition at line 62 of file message_loop.h.

TaskRunner

friend class TaskRunner

friend

Definition at line 61 of file message_loop.h.

---

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

• fml/message_loop.h
• fml/message_loop.cc