Napa.js модуль

Содержание

• Введение
• Разработка модулей
  • Модуль: JavaScript и C++
• Краткий справочник
  • JavaScript модуль
  • C++ модуль
• API
  • JavaScript API
  • C++ API
    • Экспорт класса JavaScript из модулей C++
    • V8 помощники
    • Использование STL с пользовательскими распределителями
• Специальные темы
  • Тема №1: Обеспечение возможности совместного использования объектов в нескольких потоках JavaScript
  • Тема №2: Асинхронные функции
  • Тема №3: Управление памятью в модулях C++

Введение

Napa.js следует конвенциям Node.js для поддержки модулей, что означает:

1. Поддерживаются как модули JavaScript, так и модули C++.
2. Разрешение модулей следует тому же алгоритму, за исключением того, что вместо поиска расширения файла .node для аддонов, Napa.JS ищет .napa.
3. Поддерживает NPM, с тем же способом создания и публикации модулей.
4. API создания модулей C++ (аддонов) аналогичны. Napa.JS представил макросы, которые позволяют компилировать один и тот же исходный код для создания аддона Napa.js и аддона Node.js.

Но есть и отличия:

1. Модуль C++, разработанный/реализованный для Napa.js, может работать на Node.JS (нужны разные флаги компиляции для создания файлов .napa и .node). Но не наоборот.
2. Napa.js не поддерживает все API Node.js. API Node поддерживаются постепенно на основе мотивации добавления встроенных функций и основных модулей, необходимых для выполнения сложных задач. Вы можете получить доступ ко всем возможностям Node через зону Node (см. раздел «Зона Node» в файле node-zone.md).
3. Napa.js не предоставляет функциональности uv, поэтому встроенные функции и основные модули имеют собственную реализацию. Для написания асинхронной функции в аддоне представлены методы DoAsyncWork/PostAsyncWork, которые работают как для Napa.js, так и для Node.js.
4. Napa.js поддерживает режим встраивания. Модули C++ требуют отдельной компиляции между режимом Node и режимом встраивания.

Разработка модулей

Модуль: JavaScript против C++

Быстрый взгляд на NPM покажет, что большинство модулей являются чистым JavaScript. Вот несколько причин, по которым вы можете захотеть создать модуль C++.

• Вы хотите предоставить API JavaScript для существующих функций C/C++.
• Код включает значительное количество вычислений, критичных для производительности.
• Объекты должны совместно использоваться несколькими потоками JavaScript, стоимость маршалинга/демаршалинга этих объектов нетривиальна (большой размер полезной нагрузки, сложная структура и т. д.), но разумно дёшево предоставлять API JavaScript из базовых собственных объектов.
• В режиме встраивания вы хотите общаться с хост-процессом с помощью собственных объектов.

Этот пост даёт хорошее введение в создание модуля JavaScript. Для создания модуля Napa.JS C++ обратитесь к разделу API или ознакомьтесь с примерами в разделе «Краткий справочник».

Краткий справочник

JavaScript модуль

C++ модуль

| Описание | ObjectWrap | Транспортный | Асинхронная функция | Пример кода | | ----------------------------------------------------------- | Экспорт функции JavaScript

Экспорт функции JavaScript.

Экспорт объекта JavaScript (ObjectWrap)

Экспорт объекта JavaScript, который представляет собой оболочку для объекта C++.

Совместное использование объекта C++ в разных изолятах

Совместное использование объекта C++ в разных изолятах.

Экспорт асинхронной функции JavaScript

Экспорт асинхронной функции JavaScript.

API

JavaScript

См. справочник по API (index.md).

C++

Экспорт классов JavaScript из модулей C++

TBD.

Помощники V8

TBD.

Использование STL с пользовательскими распределителями

TBD.

Специальные темы

Тема №1: сделать объекты доступными для совместного использования в нескольких потоках JavaScript

TBD.

Тема №2: асинхронные функции

TBD.

Тема №3: управление памятью в модулях C++

TBD.