fml::Thread Class Reference

#include <thread.h>

Classes
struct	ThreadConfig
	The ThreadConfig is the thread info include thread name, thread priority. More...

Public Types
enum class	ThreadPriority : int {   kBackground ,   kNormal ,   kDisplay ,   kRaster }
	Valid values for priority of Thread. More...
using	ThreadConfigSetter = std::function< void(const ThreadConfig &)>

Public Member Functions
	Thread (const std::string &name="")
	Thread (const ThreadConfigSetter &setter, const ThreadConfig &config=ThreadConfig())
	~Thread ()
fml::RefPtr< fml::TaskRunner >	GetTaskRunner () const
void	Join ()

Static Public Member Functions
static void	SetCurrentThreadName (const ThreadConfig &config)
static size_t	GetDefaultStackSize ()

Detailed Description

Definition at line 20 of file thread.h.

Member Typedef Documentation

ThreadConfigSetter

using fml::Thread::ThreadConfigSetter = std::function<void(const ThreadConfig&)>

Definition at line 48 of file thread.h.

Member Enumeration Documentation

ThreadPriority

enum class fml::Thread::ThreadPriority : int

strong

Valid values for priority of Thread.

Enumerator
kBackground	Suitable for threads that shouldn't disrupt high priority work.
kNormal	Default priority level.
kDisplay	Suitable for threads which generate data for the display.
kRaster	Suitable for thread which raster data.

Definition at line 23 of file thread.h.

                            : int {
    /// Suitable for threads that shouldn't disrupt high priority work.
    kBackground,
    /// Default priority level.
    kNormal,
    /// Suitable for threads which generate data for the display.
    kDisplay,
    /// Suitable for thread which raster data.
    kRaster,
  };

Constructor & Destructor Documentation

Thread() [1/2]

fml::Thread::Thread ( const std::string &  name = "" )

explicit

Definition at line 139 of file thread.cc.

    : Thread(Thread::SetCurrentThreadName, ThreadConfig(name)) {}

Thread() [2/2]

fml::Thread::Thread ( const ThreadConfigSetter &  setter, const ThreadConfig &  config = ThreadConfig()  )

explicit

Definition at line 142 of file thread.cc.

    : joined_(false) {
  fml::AutoResetWaitableEvent latch;
  fml::RefPtr<fml::TaskRunner> runner;
 
  thread_ = std::make_unique<ThreadHandle>(
      [&latch, &runner, setter, config]() -> void {
        setter(config);
        fml::MessageLoop::EnsureInitializedForCurrentThread();
        auto& loop = MessageLoop::GetCurrent();
        runner = loop.GetTaskRunner();
        latch.Signal();
        loop.Run();
      });
  latch.Wait();
  task_runner_ = runner;
}

References fml::MessageLoop::EnsureInitializedForCurrentThread(), fml::MessageLoop::GetCurrent(), fml::AutoResetWaitableEvent::Signal(), and fml::AutoResetWaitableEvent::Wait().

~Thread()

fml::Thread::~Thread

(

)

Definition at line 160 of file thread.cc.

                {
  Join();
}

References Join().

Member Function Documentation

GetDefaultStackSize()

size_t fml::Thread::GetDefaultStackSize ( )

static

Definition at line 177 of file thread.cc.

                                   {
  return 1024 * 1024 * 2;
}

Referenced by TEST(), and fml::ThreadHandle::ThreadHandle().

GetTaskRunner()

fml::RefPtr< fml::TaskRunner > fml::Thread::GetTaskRunner

(

)

const

Definition at line 164 of file thread.cc.

                                                     {
  return task_runner_;
}

Referenced by flutter::testing::GetThreadMergerFromRasterThread(), flutter::GTestActivity::OnNativeWindowCreated(), fml::TEST(), fml::testing::TEST(), TEST(), TEST(), TEST(), TEST(), TEST(), and flutter::testing::TEST_F().

Join()

void fml::Thread::Join

(

)

Definition at line 168 of file thread.cc.

                  {
  if (joined_) {
    return;
  }
  joined_ = true;
  task_runner_->PostTask([]() { MessageLoop::GetCurrent().Terminate(); });
  thread_->Join();
}

References fml::MessageLoop::GetCurrent(), fml::TaskRunner::PostTask(), and fml::MessageLoop::Terminate().

Referenced by TEST(), TEST(), TEST(), TEST(), and ~Thread().

SetCurrentThreadName()

void fml::Thread::SetCurrentThreadName ( const ThreadConfig &  config )

static

Definition at line 135 of file thread.cc.

                                                                  {
  SetThreadName(config.name);
}

References fml::Thread::ThreadConfig::name, and fml::SetThreadName().

Referenced by flutter::AndroidPlatformThreadConfigSetter(), fml::ConcurrentMessageLoop::ConcurrentMessageLoop(), flutter_runner::Engine::CreateThreadHost(), FlutterEngineInitialize(), and IOSPlatformThreadConfigSetter().

---

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

• fml/thread.h
• fml/thread.cc