gecko-dev/xpcom/threads/ThreadEventQueue.h

89 lines
2.7 KiB
C++

/* -*- Mode: C++; tab-width: 8; indent-tabs-mode: nil; c-basic-offset: 2 -*- */
/* vim: set ts=8 sts=2 et sw=2 tw=80: */
/* This Source Code Form is subject to the terms of the Mozilla Public
* License, v. 2.0. If a copy of the MPL was not distributed with this
* file, You can obtain one at http://mozilla.org/MPL/2.0/. */
#ifndef mozilla_ThreadEventQueue_h
#define mozilla_ThreadEventQueue_h
#include "mozilla/EventQueue.h"
#include "mozilla/CondVar.h"
#include "mozilla/SynchronizedEventQueue.h"
#include "nsCOMPtr.h"
#include "nsTArray.h"
class nsIEventTarget;
class nsISerialEventTarget;
class nsIThreadObserver;
namespace mozilla {
class EventQueue;
class ThreadEventTarget;
// A ThreadEventQueue implements normal monitor-style synchronization over the
// EventQueue. It also implements PushEventQueue and PopEventQueue for workers
// (see the documentation below for an explanation of those). All threads use a
// ThreadEventQueue as their event queue. Although for the main thread this
// simply forwards events to the TaskController.
class ThreadEventQueue final : public SynchronizedEventQueue {
public:
explicit ThreadEventQueue(UniquePtr<EventQueue> aQueue,
bool aIsMainThread = false);
bool PutEvent(already_AddRefed<nsIRunnable>&& aEvent,
EventQueuePriority aPriority) final;
already_AddRefed<nsIRunnable> GetEvent(
bool aMayWait, mozilla::TimeDuration* aLastEventDelay = nullptr) final;
bool HasPendingEvent() final;
bool ShutdownIfNoPendingEvents() final;
void Disconnect(const MutexAutoLock& aProofOfLock) final {}
already_AddRefed<nsISerialEventTarget> PushEventQueue() final;
void PopEventQueue(nsIEventTarget* aTarget) final;
already_AddRefed<nsIThreadObserver> GetObserver() final;
already_AddRefed<nsIThreadObserver> GetObserverOnThread() final;
void SetObserver(nsIThreadObserver* aObserver) final;
Mutex& MutexRef() { return mLock; }
size_t SizeOfExcludingThis(
mozilla::MallocSizeOf aMallocSizeOf) const override;
private:
class NestedSink;
virtual ~ThreadEventQueue();
bool PutEventInternal(already_AddRefed<nsIRunnable>&& aEvent,
EventQueuePriority aPriority, NestedSink* aQueue);
UniquePtr<EventQueue> mBaseQueue;
struct NestedQueueItem {
UniquePtr<EventQueue> mQueue;
RefPtr<ThreadEventTarget> mEventTarget;
NestedQueueItem(UniquePtr<EventQueue> aQueue,
ThreadEventTarget* aEventTarget);
};
nsTArray<NestedQueueItem> mNestedQueues;
Mutex mLock;
CondVar mEventsAvailable;
bool mEventsAreDoomed = false;
nsCOMPtr<nsIThreadObserver> mObserver;
bool mIsMainThread;
};
} // namespace mozilla
#endif // mozilla_ThreadEventQueue_h