Общедоступный API

Обзор

Ниже представлен простой обзор общедоступного API.

Модули MJS

import diagnostics_channel from 'node:diagnostics_channel';

// Get a reusable channel object
const channel = diagnostics_channel.channel('my-channel');

function onMessage(message, name) {
  // Received data
}

// Subscribe to the channel
diagnostics_channel.subscribe('my-channel', onMessage);

// Check if the channel has an active subscriber
if (channel.hasSubscribers) {
  // Publish data to the channel
  channel.publish({
    some: 'data',
  });
}

// Unsubscribe from the channel
diagnostics_channel.unsubscribe('my-channel', onMessage);

Модули CJS

const diagnostics_channel = require('node:diagnostics_channel');

// Get a reusable channel object
const channel = diagnostics_channel.channel('my-channel');

function onMessage(message, name) {
  // Received data
}

// Subscribe to the channel
diagnostics_channel.subscribe('my-channel', onMessage);

// Check if the channel has an active subscriber
if (channel.hasSubscribers) {
  // Publish data to the channel
  channel.publish({
    some: 'data',
  });
}

// Unsubscribe from the channel
diagnostics_channel.unsubscribe('my-channel', onMessage);

diagnostics_channel.hasSubscribers(name)

• name <строка> | <символ> Имя канала
• Возвращает: <логическое значение> Есть ли активные подписчики

Проверяет, есть ли активные подписчики на указанный канал. Это полезно, если сообщение, которое вы хотите отправить, может быть дорогостоящим для подготовки.

Этот API необязателен, но полезен, когда вы пытаетесь публиковать сообщения из кода, чувствительного к производительности.

Модули MJS

import diagnostics_channel from 'node:diagnostics_channel';

if (diagnostics_channel.hasSubscribers('my-channel')) {
  // There are subscribers, prepare and publish message
}

Модули CJS

const diagnostics_channel = require('node:diagnostics_channel');

if (diagnostics_channel.hasSubscribers('my-channel')) {
  // There are subscribers, prepare and publish message
}

diagnostics_channel.channel(name)

• name <строка> | <символ> Имя канала
• Возвращает: <Канал> Объект канала с указанным именем

Это основная точка входа для любого, кто хочет опубликовать сообщение в канал с заданным именем. Он создает объект канала, оптимизированный для минимизации накладных расходов при публикации, насколько это возможно.

Модули MJS

import diagnostics_channel from 'node:diagnostics_channel';

const channel = diagnostics_channel.channel('my-channel');

Модули CJS

const diagnostics_channel = require('node:diagnostics_channel');

const channel = diagnostics_channel.channel('my-channel');

diagnostics_channel.subscribe(name, onMessage)

• name <строка> | <символ> Имя канала
• onMessage <Функция> Обработчик для получения сообщений канала
  • message <любой> Данные сообщения
  • name <строка> | <символ> Имя канала

Регистрирует обработчик сообщений для подписки на этот канал. Этот обработчик будет выполняться синхронно всякий раз, когда в канал публикуется сообщение. Любые ошибки, возникшие в обработчике сообщений, приведут к срабатыванию события 'uncaughtException'.

Модули MJS

import diagnostics_channel from 'node:diagnostics_channel';

diagnostics_channel.subscribe('my-channel', (message, name) => {
  // Received data
});

Модули CJS

const diagnostics_channel = require('node:diagnostics_channel');

diagnostics_channel.subscribe('my-channel', (message, name) => {
  // Received data
});

diagnostics_channel.unsubscribe(name, onMessage)

• name <строка> | <символ> Имя канала
• onMessage <Функция> Предыдущий обработчик подписки для удаления
• Возвращает: <логическое значение> true если обработчик был найден, false в противном случае.

Удаляет обработчик сообщений, ранее зарегистрированный для этого канала с помощью diagnostics_channel.subscribe(name, onMessage).

Модули MJS

import diagnostics_channel from 'node:diagnostics_channel';

function onMessage(message, name) {
  // Received data
}

diagnostics_channel.subscribe('my-channel', onMessage);

diagnostics_channel.unsubscribe('my-channel', onMessage);

Модули CJS

const diagnostics_channel = require('node:diagnostics_channel');

function onMessage(message, name) {
  // Received data
}

diagnostics_channel.subscribe('my-channel', onMessage);

diagnostics_channel.unsubscribe('my-channel', onMessage);

Класс: Channel

Класс Channel представляет собой отдельный канал с именем в конвейере данных. Он используется для отслеживания подписчиков и публикации сообщений, когда есть подписчики. Он существует как отдельный объект, чтобы избежать поиска каналов во время публикации, обеспечивая очень высокую скорость публикации и возможность интенсивного использования с минимальными затратами. Каналы создаются с помощью diagnostics_channel.channel(name), прямое создание канала с помощью new Channel(name) не поддерживается.

channel.hasSubscribers

• Возвращает: <логическое значение> Есть ли активные подписчики

Проверяет, есть ли активные подписчики на этот канал. Это полезно, если сообщение, которое вы хотите отправить, может быть дорогостоящим для подготовки.

Этот API необязателен, но полезен, когда вы пытаетесь публиковать сообщения из кода, чувствительного к производительности.

Модули MJS

import diagnostics_channel from 'node:diagnostics_channel';

const channel = diagnostics_channel.channel('my-channel');

if (channel.hasSubscribers) {
  // There are subscribers, prepare and publish message
}

Модули CJS

const diagnostics_channel = require('node:diagnostics_channel');

const channel = diagnostics_channel.channel('my-channel');

if (channel.hasSubscribers) {
  // There are subscribers, prepare and publish message
}

channel.publish(message)

• message <любой> Сообщение для отправки подписчикам канала

Опубликовать сообщение всем подписчикам канала. Это вызовет обработчики сообщений синхронно, поэтому они будут выполнены в том же контексте.

Модули MJS

import diagnostics_channel from 'node:diagnostics_channel';

const channel = diagnostics_channel.channel('my-channel');

channel.publish({
  some: 'message',
});

Модули CJS

const diagnostics_channel = require('node:diagnostics_channel');

const channel = diagnostics_channel.channel('my-channel');

channel.publish({
  some: 'message',
});

channel.subscribe(onMessage)

• onMessage <Функция> Обработчик для получения сообщений канала
  • message <любой> Данные сообщения
  • name <строка> | <символ> Имя канала

Регистрирует обработчик сообщений для подписки на этот канал. Этот обработчик будет выполняться синхронно всякий раз, когда в канал публикуется сообщение. Любые ошибки, возникшие в обработчике сообщений, приведут к срабатыванию события 'uncaughtException'.

Модули MJS

import diagnostics_channel from 'node:diagnostics_channel';

const channel = diagnostics_channel.channel('my-channel');

channel.subscribe((message, name) => {
  // Received data
});

Модули CJS

const diagnostics_channel = require('node:diagnostics_channel');

const channel = diagnostics_channel.channel('my-channel');

channel.subscribe((message, name) => {
  // Received data
});

channel.unsubscribe(onMessage)

• onMessage <Функция> Предыдущий обработчик подписки для удаления
• Возвращает: <логическое значение> true если обработчик был найден, false в противном случае.

Удаляет обработчик сообщений, ранее зарегистрированный для этого канала с помощью channel.subscribe(onMessage).

Модули MJS

import diagnostics_channel from 'node:diagnostics_channel';

const channel = diagnostics_channel.channel('my-channel');

function onMessage(message, name) {
  // Received data
}

channel.subscribe(onMessage);

channel.unsubscribe(onMessage);

Модули CJS

const diagnostics_channel = require('node:diagnostics_channel');

const channel = diagnostics_channel.channel('my-channel');

function onMessage(message, name) {
  // Received data
}

channel.subscribe(onMessage);

channel.unsubscribe(onMessage);

Встроенные каналы

Хотя API diagnostics_channel сейчас считается стабильным, встроенные каналы, которые в настоящее время доступны, таковыми не являются. Каждый канал должен быть объявлен стабильным индивидуально.

HTTP

http.client.request.start

• request <http.ClientRequest>

Выдаётся при запуске запроса клиентом.

http.client.response.finish

• request <http.ClientRequest>
• response <http.IncomingMessage>

Выдаётся, когда клиент получает ответ.

http.server.request.start

• request <http.IncomingMessage>
• response <http.ServerResponse>
• socket <net.Socket>
• server <http.Server>

Выдаётся, когда сервер получает запрос.

http.server.response.finish

• request <http.IncomingMessage>
• response <http.ServerResponse>
• socket <net.Socket>
• server <http.Server>

Имеет место при отправке сервером ответа.

net.client.socket

• socket <net.Socket>

Имеет место при создании нового TCP или сокета клиента канала.

net.server.socket

• socket <net.Socket>

Имеет место при получении нового TCP или канала соединения.

udp.socket

• socket <dgram.Socket>

Имеет место при создании нового сокета UDP.