fml::MessageLoopImpl Class Reference

#include <message_loop_impl.h>

Inheritance diagram for fml::MessageLoopImpl:

Public Member Functions
virtual	~MessageLoopImpl ()
virtual void	Run ()=0
virtual void	Terminate ()=0
void	PostTask (const fml::closure &task, fml::TimePoint target_time)
void	AddTaskObserver (intptr_t key, const fml::closure &callback)
void	RemoveTaskObserver (intptr_t key)
void	DoRun ()
void	DoTerminate ()
virtual TaskQueueId	GetTaskQueueId () const
Public Member Functions inherited from fml::Wakeable
virtual	~Wakeable ()
virtual void	WakeUp (fml::TimePoint time_point)=0
Public Member Functions inherited from fml::RefCountedThreadSafe< MessageLoopImpl >
void	Release () const
Public Member Functions inherited from fml::internal::RefCountedThreadSafeBase
void	AddRef () const
bool	HasOneRef () const
void	AssertHasOneRef () const

Static Public Member Functions
static fml::RefPtr< MessageLoopImpl >	Create ()

Protected Member Functions
void	RunExpiredTasksNow ()
void	RunSingleExpiredTaskNow ()
	MessageLoopImpl ()
Protected Member Functions inherited from fml::RefCountedThreadSafe< MessageLoopImpl >
	RefCountedThreadSafe ()
	~RefCountedThreadSafe ()
Protected Member Functions inherited from fml::internal::RefCountedThreadSafeBase
	RefCountedThreadSafeBase ()
	~RefCountedThreadSafeBase ()
bool	Release () const
void	Adopt ()

Friends
class	MessageLoop

Detailed Description

An abstract class that represents the differences in implementation of a fml::MessageLoop depending on the platform.

See also

fml::MessageLoop

fml::MessageLoopAndroid

fml::MessageLoopDarwin

Definition at line 31 of file message_loop_impl.h.

Constructor & Destructor Documentation

~MessageLoopImpl()

fml::MessageLoopImpl::~MessageLoopImpl ( )

virtual

Definition at line 52 of file message_loop_impl.cc.

                                  {
  task_queue_->Dispose(queue_id_);
}

References fml::MessageLoopTaskQueues::Dispose().

MessageLoopImpl()

fml::MessageLoopImpl::MessageLoopImpl ( )

protected

Definition at line 45 of file message_loop_impl.cc.

    : task_queue_(MessageLoopTaskQueues::GetInstance()),
      queue_id_(task_queue_->CreateTaskQueue()),
      terminated_(false) {
  task_queue_->SetWakeable(queue_id_, this);
}

References fml::MessageLoopTaskQueues::SetWakeable().

Member Function Documentation

AddTaskObserver()

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

Definition at line 67 of file message_loop_impl.cc.

                                                                  {
  FML_DCHECK(callback != nullptr);
  FML_DCHECK(MessageLoop::GetCurrent().GetLoopImpl().get() == this)
      << "Message loop task observer must be added on the same thread as the "
         "loop.";
  if (callback != nullptr) {
    task_queue_->AddTaskObserver(queue_id_, key, callback);
  } else {
    FML_LOG(ERROR) << "Tried to add a null TaskObserver.";
  }
}

References fml::MessageLoopTaskQueues::AddTaskObserver(), callback, FML_DCHECK, FML_LOG, fml::MessageLoop::GetCurrent(), and key.

Create()

fml::RefPtr< MessageLoopImpl > fml::MessageLoopImpl::Create ( )

static

Definition at line 29 of file message_loop_impl.cc.

                                                   {
#if FML_OS_MACOSX
  return fml::MakeRefCounted<MessageLoopDarwin>();
#elif FML_OS_ANDROID
  return fml::MakeRefCounted<MessageLoopAndroid>();
#elif OS_FUCHSIA
  return fml::MakeRefCounted<MessageLoopFuchsia>();
#elif FML_OS_LINUX
  return fml::MakeRefCounted<MessageLoopLinux>();
#elif FML_OS_WIN
  return fml::MakeRefCounted<MessageLoopWin>();
#else
  return nullptr;
#endif
}

DoRun()

void fml::MessageLoopImpl::DoRun

(

)

Definition at line 87 of file message_loop_impl.cc.

                            {
  if (terminated_) {
    // Message loops may be run only once.
    return;
  }
 
  // Allow the implementation to do its thing.
  Run();
 
  // The loop may have been implicitly terminated. This can happen if the
  // implementation supports termination via platform specific APIs or just
  // error conditions. Set the terminated flag manually.
  terminated_ = true;
 
  // The message loop is shutting down. Check if there are expired tasks. This
  // is the last chance for expired tasks to be serviced. Make sure the
  // terminated flag is already set so we don't accrue additional tasks now.
  RunExpiredTasksNow();
 
  // When the message loop is in the process of shutting down, pending tasks
  // should be destructed on the message loop's thread. We have just returned
  // from the implementations |Run| method which we know is on the correct
  // thread. Drop all pending tasks on the floor.
  task_queue_->DisposeTasks(queue_id_);
}

References fml::MessageLoopTaskQueues::DisposeTasks(), Run(), and RunExpiredTasksNow().

DoTerminate()

void fml::MessageLoopImpl::DoTerminate

(

)

Definition at line 113 of file message_loop_impl.cc.

                                  {
  terminated_ = true;
  Terminate();
}

References Terminate().

GetTaskQueueId()

TaskQueueId fml::MessageLoopImpl::GetTaskQueueId ( ) const

virtual

Definition at line 146 of file message_loop_impl.cc.

                                                  {
  return queue_id_;
}

PostTask()

void fml::MessageLoopImpl::PostTask	(	const fml::closure &	task,
		fml::TimePoint	target_time
	)

Definition at line 56 of file message_loop_impl.cc.

                                                         {
  FML_DCHECK(task != nullptr);
  if (terminated_) {
    // If the message loop has already been terminated, PostTask should destruct
    // |task| synchronously within this function.
    return;
  }
  task_queue_->RegisterTask(queue_id_, task, target_time);
}

References FML_DCHECK, and fml::MessageLoopTaskQueues::RegisterTask().

RemoveTaskObserver()

void fml::MessageLoopImpl::RemoveTaskObserver

(

intptr_t

key

)

Definition at line 80 of file message_loop_impl.cc.

                                                     {
  FML_DCHECK(MessageLoop::GetCurrent().GetLoopImpl().get() == this)
      << "Message loop task observer must be removed from the same thread as "
         "the loop.";
  task_queue_->RemoveTaskObserver(queue_id_, key);
}

References FML_DCHECK, fml::MessageLoop::GetCurrent(), key, and fml::MessageLoopTaskQueues::RemoveTaskObserver().

Run()

virtual void fml::MessageLoopImpl::Run ( )

pure virtual

Referenced by DoRun().

RunExpiredTasksNow()

void fml::MessageLoopImpl::RunExpiredTasksNow ( )

protected

Definition at line 138 of file message_loop_impl.cc.

                                         {
  FlushTasks(FlushType::kAll);
}

References fml::kAll.

Referenced by DoRun().

RunSingleExpiredTaskNow()

void fml::MessageLoopImpl::RunSingleExpiredTaskNow ( )

protected

Definition at line 142 of file message_loop_impl.cc.

                                              {
  FlushTasks(FlushType::kSingle);
}

References fml::kSingle.

Terminate()

virtual void fml::MessageLoopImpl::Terminate ( )

pure virtual

Referenced by DoTerminate().

Friends And Related Symbol Documentation

MessageLoop

friend class MessageLoop

friend

Definition at line 57 of file message_loop_impl.h.

---

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

• fml/message_loop_impl.h
• fml/message_loop_impl.cc