REDROOM

Navigation

Breadcrumbs

/ / opt / cpanel / ea-nodejs20 / include / node

Create

Create File | Create Folder | Upload Files | Run Command

Preview: v8-microtask-queue.h Size: 4.95 KB

//opt/cpanel/ea-nodejs20/include/node/v8-microtask-queue.h

// Copyright 2021 the V8 project authors. All rights reserved.
// Use of this source code is governed by a BSD-style license that can be
// found in the LICENSE file.

#ifndef INCLUDE_V8_MICROTASKS_QUEUE_H_
#define INCLUDE_V8_MICROTASKS_QUEUE_H_

#include <stddef.h>

#include <memory>

#include "v8-local-handle.h"  // NOLINT(build/include_directory)
#include "v8-microtask.h"     // NOLINT(build/include_directory)
#include "v8config.h"         // NOLINT(build/include_directory)

namespace v8 {

class Function;

namespace internal {
class Isolate;
class MicrotaskQueue;
}  // namespace internal

/**
 * Represents the microtask queue, where microtasks are stored and processed.
 * https://html.spec.whatwg.org/multipage/webappapis.html#microtask-queue
 * https://html.spec.whatwg.org/multipage/webappapis.html#enqueuejob(queuename,-job,-arguments)
 * https://html.spec.whatwg.org/multipage/webappapis.html#perform-a-microtask-checkpoint
 *
 * A MicrotaskQueue instance may be associated to multiple Contexts by passing
 * it to Context::New(), and they can be detached by Context::DetachGlobal().
 * The embedder must keep the MicrotaskQueue instance alive until all associated
 * Contexts are gone or detached.
 *
 * Use the same instance of MicrotaskQueue for all Contexts that may access each
 * other synchronously. E.g. for Web embedding, use the same instance for all
 * origins that share the same URL scheme and eTLD+1.
 */
class V8_EXPORT MicrotaskQueue {
 public:
  /**
   * Creates an empty MicrotaskQueue instance.
   */
  static std::unique_ptr<MicrotaskQueue> New(
      Isolate* isolate, MicrotasksPolicy policy = MicrotasksPolicy::kAuto);

  virtual ~MicrotaskQueue() = default;

  /**
   * Enqueues the callback to the queue.
   */
  virtual void EnqueueMicrotask(Isolate* isolate,
                                Local<Function> microtask) = 0;

  /**
   * Enqueues the callback to the queue.
   */
  virtual void EnqueueMicrotask(v8::Isolate* isolate,
                                MicrotaskCallback callback,
                                void* data = nullptr) = 0;

  /**
   * Adds a callback to notify the embedder after microtasks were run. The
   * callback is triggered by explicit RunMicrotasks call or automatic
   * microtasks execution (see Isolate::SetMicrotasksPolicy).
   *
   * Callback will trigger even if microtasks were attempted to run,
   * but the microtasks queue was empty and no single microtask was actually
   * executed.
   *
   * Executing scripts inside the callback will not re-trigger microtasks and
   * the callback.
   */
  virtual void AddMicrotasksCompletedCallback(
      MicrotasksCompletedCallbackWithData callback, void* data = nullptr) = 0;

  /**
   * Removes callback that was installed by AddMicrotasksCompletedCallback.
   */
  virtual void RemoveMicrotasksCompletedCallback(
      MicrotasksCompletedCallbackWithData callback, void* data = nullptr) = 0;

  /**
   * Runs microtasks if no microtask is running on this MicrotaskQueue instance.
   */
  virtual void PerformCheckpoint(Isolate* isolate) = 0;

  /**
   * Returns true if a microtask is running on this MicrotaskQueue instance.
   */
  virtual bool IsRunningMicrotasks() const = 0;

  /**
   * Returns the current depth of nested MicrotasksScope that has
   * kRunMicrotasks.
   */
  virtual int GetMicrotasksScopeDepth() const = 0;

  MicrotaskQueue(const MicrotaskQueue&) = delete;
  MicrotaskQueue& operator=(const MicrotaskQueue&) = delete;

 private:
  friend class internal::MicrotaskQueue;
  MicrotaskQueue() = default;
};

/**
 * This scope is used to control microtasks when MicrotasksPolicy::kScoped
 * is used on Isolate. In this mode every non-primitive call to V8 should be
 * done inside some MicrotasksScope.
 * Microtasks are executed when topmost MicrotasksScope marked as kRunMicrotasks
 * exits.
 * kDoNotRunMicrotasks should be used to annotate calls not intended to trigger
 * microtasks.
 */
class V8_EXPORT V8_NODISCARD MicrotasksScope {
 public:
  enum Type { kRunMicrotasks, kDoNotRunMicrotasks };

  V8_DEPRECATE_SOON(
      "May be incorrect if context was created with non-default microtask "
      "queue")
  MicrotasksScope(Isolate* isolate, Type type);

  MicrotasksScope(Local<Context> context, Type type);
  MicrotasksScope(Isolate* isolate, MicrotaskQueue* microtask_queue, Type type);
  ~MicrotasksScope();

  /**
   * Runs microtasks if no kRunMicrotasks scope is currently active.
   */
  static void PerformCheckpoint(Isolate* isolate);

  /**
   * Returns current depth of nested kRunMicrotasks scopes.
   */
  static int GetCurrentDepth(Isolate* isolate);

  /**
   * Returns true while microtasks are being executed.
   */
  static bool IsRunningMicrotasks(Isolate* isolate);

  // Prevent copying.
  MicrotasksScope(const MicrotasksScope&) = delete;
  MicrotasksScope& operator=(const MicrotasksScope&) = delete;

 private:
  internal::Isolate* const i_isolate_;
  internal::MicrotaskQueue* const microtask_queue_;
  bool run_;
};

}  // namespace v8

#endif  // INCLUDE_V8_MICROTASKS_QUEUE_H_

Directory Contents

Dirs: 4 × Files: 63

Sort:

Enable drag-to-move

Name	Size	Perms	Modified	Actions
cppgc DIR	-	drwxr-xr-x	2026-02-03 09:33:34	Edit Download recursive recursive
libplatform DIR	-	drwxr-xr-x	2026-02-03 09:33:34	Edit Download recursive recursive
openssl DIR	-	drwxr-xr-x	2026-02-03 09:33:34	Edit Download recursive recursive
uv DIR	-	drwxr-xr-x	2026-02-03 09:33:34	Edit Download recursive recursive
common.gypi	24.67 KB	lrw-r--r--	2026-01-16 18:04:27	Edit Download recursive recursive
config.gypi	27.42 KB	lrw-r--r--	2026-01-16 18:04:27	Edit Download recursive recursive
js_native_api.h	31.43 KB	lrw-r--r--	2026-01-16 18:04:27	Edit Download recursive recursive
js_native_api_types.h	6.87 KB	lrw-r--r--	2026-01-16 18:04:27	Edit Download recursive recursive
node.h	67.17 KB	lrw-r--r--	2026-01-16 18:04:27	Edit Download recursive recursive
node_api.h	9.96 KB	lrw-r--r--	2026-01-16 18:04:27	Edit Download recursive recursive
node_api_types.h	1.57 KB	lrw-r--r--	2026-01-16 18:04:27	Edit Download recursive recursive
node_buffer.h	3.60 KB	lrw-r--r--	2026-01-16 18:04:27	Edit Download recursive recursive
node_object_wrap.h	3.78 KB	lrw-r--r--	2026-01-16 18:04:27	Edit Download recursive recursive
node_version.h	4.08 KB	lrw-r--r--	2026-01-16 18:04:27	Edit Download recursive recursive
uv.h	67.74 KB	lrw-r--r--	2026-01-16 18:04:27	Edit Download recursive recursive
v8-array-buffer.h	17.75 KB	lrw-r--r--	2026-01-16 18:04:27	Edit Download recursive recursive
v8-callbacks.h	15.03 KB	lrw-r--r--	2026-01-16 18:04:27	Edit Download recursive recursive
v8-container.h	3.40 KB	lrw-r--r--	2026-01-16 18:04:27	Edit Download recursive recursive
v8-context.h	16.13 KB	lrw-r--r--	2026-01-16 18:04:27	Edit Download recursive recursive
v8-cppgc.h	7.46 KB	lrw-r--r--	2026-01-16 18:04:27	Edit Download recursive recursive
v8-data.h	1.58 KB	lrw-r--r--	2026-01-16 18:04:27	Edit Download recursive recursive
v8-date.h	1.19 KB	lrw-r--r--	2026-01-16 18:04:27	Edit Download recursive recursive
v8-debug.h	5.04 KB	lrw-r--r--	2026-01-16 18:04:27	Edit Download recursive recursive
v8-embedder-heap.h	1.90 KB	lrw-r--r--	2026-01-16 18:04:27	Edit Download recursive recursive
v8-embedder-state-scope.h	1.51 KB	lrw-r--r--	2026-01-16 18:04:27	Edit Download recursive recursive
v8-exception.h	6.98 KB	lrw-r--r--	2026-01-16 18:04:27	Edit Download recursive recursive
v8-extension.h	1.83 KB	lrw-r--r--	2026-01-16 18:04:27	Edit Download recursive recursive
v8-external.h	924 B	lrw-r--r--	2026-01-16 18:04:27	Edit Download recursive recursive
v8-forward.h	1.62 KB	lrw-r--r--	2026-01-16 18:04:27	Edit Download recursive recursive
v8-function-callback.h	15.87 KB	lrw-r--r--	2026-01-16 18:04:27	Edit Download recursive recursive
v8-function.h	4.24 KB	lrw-r--r--	2026-01-16 18:04:27	Edit Download recursive recursive
v8-initialization.h	10.23 KB	lrw-r--r--	2026-01-16 18:04:27	Edit Download recursive recursive
v8-internal.h	39.18 KB	lrw-r--r--	2026-01-16 18:04:27	Edit Download recursive recursive
v8-isolate.h	60.97 KB	lrw-r--r--	2026-01-16 18:04:27	Edit Download recursive recursive
v8-json.h	1.32 KB	lrw-r--r--	2026-01-16 18:04:27	Edit Download recursive recursive
v8-local-handle.h	14.98 KB	lrw-r--r--	2026-01-16 18:04:27	Edit Download recursive recursive
v8-locker.h	3.86 KB	lrw-r--r--	2026-01-16 18:04:27	Edit Download recursive recursive
v8-maybe.h	4.47 KB	lrw-r--r--	2026-01-16 18:04:27	Edit Download recursive recursive
v8-memory-span.h	1.25 KB	lrw-r--r--	2026-01-16 18:04:27	Edit Download recursive recursive
v8-message.h	6.29 KB	lrw-r--r--	2026-01-16 18:04:27	Edit Download recursive recursive
v8-microtask-queue.h	4.95 KB	lrw-r--r--	2026-01-16 18:04:27	Edit Download recursive recursive
v8-microtask.h	861 B	lrw-r--r--	2026-01-16 18:04:27	Edit Download recursive recursive
v8-object.h	28.51 KB	lrw-r--r--	2026-01-16 18:04:27	Edit Download recursive recursive
v8-persistent-handle.h	18.70 KB	lrw-r--r--	2026-01-16 18:04:27	Edit Download recursive recursive
v8-platform.h	41.37 KB	lrw-r--r--	2026-01-16 18:04:27	Edit Download recursive recursive
v8-primitive-object.h	2.53 KB	lrw-r--r--	2026-01-16 18:04:27	Edit Download recursive recursive
v8-primitive.h	27.65 KB	lrw-r--r--	2026-01-16 18:04:27	Edit Download recursive recursive
v8-profiler.h	40.47 KB	lrw-r--r--	2026-01-16 18:04:27	Edit Download recursive recursive
v8-promise.h	5.17 KB	lrw-r--r--	2026-01-16 18:04:27	Edit Download recursive recursive
v8-proxy.h	1.23 KB	lrw-r--r--	2026-01-16 18:04:27	Edit Download recursive recursive
v8-regexp.h	3.10 KB	lrw-r--r--	2026-01-16 18:04:27	Edit Download recursive recursive
v8-script.h	28.08 KB	lrw-r--r--	2026-01-16 18:04:27	Edit Download recursive recursive
v8-snapshot.h	6.97 KB	lrw-r--r--	2026-01-16 18:04:27	Edit Download recursive recursive
v8-statistics.h	6.80 KB	lrw-r--r--	2026-01-16 18:04:27	Edit Download recursive recursive
v8-template.h	37.42 KB	lrw-r--r--	2026-01-16 18:04:27	Edit Download recursive recursive
v8-traced-handle.h	11.85 KB	lrw-r--r--	2026-01-16 18:04:27	Edit Download recursive recursive
v8-typed-array.h	8.06 KB	lrw-r--r--	2026-01-16 18:04:27	Edit Download recursive recursive
v8-unwinder.h	4.63 KB	lrw-r--r--	2026-01-16 18:04:27	Edit Download recursive recursive
v8-value-serializer.h	10.09 KB	lrw-r--r--	2026-01-16 18:04:27	Edit Download recursive recursive
v8-value.h	13.45 KB	lrw-r--r--	2026-01-16 18:04:27	Edit Download recursive recursive
v8-version.h	772 B	lrw-r--r--	2026-01-16 18:04:27	Edit Download recursive recursive
v8-wasm.h	6.00 KB	lrw-r--r--	2026-01-16 18:04:27	Edit Download recursive recursive
v8-weak-callback-info.h	2.41 KB	lrw-r--r--	2026-01-16 18:04:27	Edit Download recursive recursive
v8.h	3.69 KB	lrw-r--r--	2026-01-16 18:04:27	Edit Download recursive recursive
v8config.h	31.61 KB	lrw-r--r--	2026-01-16 18:04:27	Edit Download recursive recursive
zconf.h	16.60 KB	lrw-r--r--	2026-01-16 18:04:27	Edit Download recursive recursive
zlib.h	95.17 KB	lrw-r--r--	2026-01-16 18:04:27	Edit Download recursive recursive