libraries/source/spidermonkey/include-win32-release/js/HelperThreadAPI.h

   1 /* -*- Mode: C++; tab-width: 8; indent-tabs-mode: nil; c-basic-offset: 2 -*-
   2  * vim: set ts=8 sts=2 et sw=2 tw=80:
   3  * This Source Code Form is subject to the terms of the Mozilla Public
   4  * License, v. 2.0. If a copy of the MPL was not distributed with this
   5  * file, You can obtain one at http://mozilla.org/MPL/2.0/. */
   6
   7 /*
   8  * API for supplying an external thread pool to run internal work off the main
   9  * thread.
  10  */
  11
  12 #ifndef js_HelperThreadAPI_h
  13 #define js_HelperThreadAPI_h
  14
  15 namespace JS {
  16
  17 /**
  18  * Set callback to dispatch a tasks to an external thread pool.
  19  *
  20  * When the task runs it should call JS::RunHelperThreadTask.
  21  */
  22 using HelperThreadTaskCallback = void (*)();
  23 extern JS_PUBLIC_API void SetHelperThreadTaskCallback(
  24     HelperThreadTaskCallback callback, size_t threadCount, size_t stackSize);
  25
  26 // Function to call from external thread pool to run a helper thread task.
  27 extern JS_PUBLIC_API void RunHelperThreadTask();
  28
  29 }  // namespace JS
  30
  31 #endif  // js_HelperThreadAPI_h