gecko-dev/dom/workers/WorkerHolder.h

111 строки
3.0 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_dom_workers_WorkerHolder_h
#define mozilla_dom_workers_WorkerHolder_h
#include "mozilla/dom/WorkerCommon.h"
namespace mozilla {
namespace dom {
class WorkerPrivate;
/**
* Use this chart to help figure out behavior during each of the closing
* statuses. Details below.
*
* +=============================================+
* | Closing Statuses |
* +=============+=============+=================+
* | status | clear queue | abort execution |
* +=============+=============+=================+
* | Closing | yes | no |
* +-------------+-------------+-----------------+
* | Terminating | yes | yes |
* +-------------+-------------+-----------------+
* | Canceling | yes | yes |
* +-------------+-------------+-----------------+
* | Killing | yes | yes |
* +-------------+-------------+-----------------+
*/
enum WorkerStatus
{
// Not yet scheduled.
Pending = 0,
// This status means that the worker is active.
Running,
// Inner script called close() on the worker global scope. Setting this
// status causes the worker to clear its queue of events but does not abort
// the currently running script.
Closing,
// Outer script called terminate() on the worker or the worker object was
// garbage collected in its outer script. Setting this status causes the
// worker to abort immediately and clear its queue of events.
Terminating,
// Either the user navigated away from the owning page or the owning page fell
// out of bfcache. Setting this status causes the worker to abort immediately.
// Since the page has gone away the worker may not post any messages.
Canceling,
// The application is shutting down. Setting this status causes the worker to
// abort immediately.
Killing,
// The worker is effectively dead.
Dead
};
class WorkerHolder
{
public:
enum Behavior {
AllowIdleShutdownStart,
PreventIdleShutdownStart,
};
explicit WorkerHolder(const char* aName,
Behavior aBehavior = PreventIdleShutdownStart);
virtual ~WorkerHolder();
bool HoldWorker(WorkerPrivate* aWorkerPrivate, WorkerStatus aFailStatus);
void ReleaseWorker();
virtual bool Notify(WorkerStatus aStatus) = 0;
Behavior GetBehavior() const;
const char*
Name() const
{
return mName;
}
protected:
void ReleaseWorkerInternal();
WorkerPrivate* MOZ_NON_OWNING_REF mWorkerPrivate;
private:
void AssertIsOwningThread() const;
const Behavior mBehavior;
// For debugging only.
void* mThread;
const char* mName;
};
} // dom namespace
} // mozilla namespace
#endif /* mozilla_dom_workers_WorkerHolder_h */