IotEdgeAuthenticationProvider class

type: AuthenticationType

Valor de propiedad

Heredado deSharedAccessKeyAuthenticationProvider.type

function getTrustBundle(callback: (err?: Error, ca?: string) => void)

Parámetros

Alias para emitter.on(eventName, listener).

function addListener<E>(eventName: string | symbol, listener: (args: any[]) => void): IotEdgeAuthenticationProvider

Parámetros

Devoluciones

heredado deSharedAccessKeyAuthenticationProvider.addListener

Llama sincrónicamente a cada uno de los agentes de escucha registrados para el evento denominado eventName, en el orden en que se registraron, pasando los argumentos proporcionados a cada uno.

Devuelve true si el evento tenía agentes de escucha, false de lo contrario.

import { EventEmitter } from 'node:events';
const myEmitter = new EventEmitter();

// First listener
myEmitter.on('event', function firstListener() {
  console.log('Helloooo! first listener');
});
// Second listener
myEmitter.on('event', function secondListener(arg1, arg2) {
  console.log(`event with parameters ${arg1}, ${arg2} in second listener`);
});
// Third listener
myEmitter.on('event', function thirdListener(...args) {
  const parameters = args.join(', ');
  console.log(`event with parameters ${parameters} in third listener`);
});

console.log(myEmitter.listeners('event'));

myEmitter.emit('event', 1, 2, 3, 4, 5);

// Prints:
// [
//   [Function: firstListener],
//   [Function: secondListener],
//   [Function: thirdListener]
// ]
// Helloooo! first listener
// event with parameters 1, 2 in second listener
// event with parameters 1, 2, 3, 4, 5 in third listener

function emit<E>(eventName: string | symbol, args: any[]): boolean

Parámetros

Devoluciones

heredado deSharedAccessKeyAuthenticationProvider.emit

Devuelve una matriz que enumera los eventos para los que el emisor ha registrado agentes de escucha.

import { EventEmitter } from 'node:events';

const myEE = new EventEmitter();
myEE.on('foo', () => {});
myEE.on('bar', () => {});

const sym = Symbol('symbol');
myEE.on(sym, () => {});

console.log(myEE.eventNames());
// Prints: [ 'foo', 'bar', Symbol(symbol) ]

function eventNames(): (string | symbol)[]

Devoluciones

heredado desharedAccessKeyAuthenticationProvider.eventNames

Crea un nuevo SharedAccessKeyAuthenticationProvider a partir de una cadena de conexión

static function fromConnectionString(connectionString: string, tokenValidTimeInSeconds?: number, tokenRenewalMarginInSeconds?: number): SharedAccessKeyAuthenticationProvider

Parámetros

Devoluciones

heredado deSharedAccessKeyAuthenticationProvider.fromConnectionString

function getDeviceCredentials(): Promise<TransportConfig>

Devoluciones

Heredado deSharedAccessKeyAuthenticationProvider.getDeviceCredentials

El transporte usa este método para obtener las credenciales de dispositivo más actuales en forma de un objeto TransportConfig.

function getDeviceCredentials(callback?: Callback<TransportConfig>)

Parámetros

Heredado deSharedAccessKeyAuthenticationProvider.getDeviceCredentials

Devuelve el valor máximo actual del agente de escucha para el EventEmitter que se establece mediante emitter.setMaxListeners(n) o los valores predeterminados en events.defaultMaxListeners.

function getMaxListeners(): number

Devoluciones

heredado deSharedAccessKeyAuthenticationProvider.getMaxListeners

Devuelve el número de agentes de escucha que escuchan el evento denominado eventName. Si se proporciona listener, devolverá cuántas veces se encuentra el agente de escucha en la lista de agentes de escucha del evento.

function listenerCount<E>(eventName: string | symbol, listener?: (args: any[]) => void): number

Parámetros

Devoluciones

Heredado deSharedAccessKeyAuthenticationProvider.listenerCount

Devuelve una copia de la matriz de agentes de escucha del evento denominado eventName.

server.on('connection', (stream) => {
  console.log('someone connected!');
});
console.log(util.inspect(server.listeners('connection')));
// Prints: [ [Function] ]

function listeners<E>(eventName: string | symbol): (args: any[]) => void[]

Parámetros

Devoluciones

heredado desharedAccessKeyAuthenticationProvider.listeners

Alias para emitter.removeListener().

function off<E>(eventName: string | symbol, listener: (args: any[]) => void): IotEdgeAuthenticationProvider

Parámetros

Devoluciones

Heredado deSharedAccessKeyAuthenticationProvider.off

Agrega la función listener al final de la matriz de agentes de escucha para el evento denominado eventName. No se realizan comprobaciones para ver si ya se ha agregado el listener. Varias llamadas que pasan la misma combinación de eventName y listener darán lugar a que se agregue el listener y se llame varias veces.

server.on('connection', (stream) => {
  console.log('someone connected!');
});

Devuelve una referencia al EventEmitter, para que las llamadas se puedan encadenar.

De forma predeterminada, los agentes de escucha de eventos se invocan en el orden en que se agregan. El método emitter.prependListener() se puede usar como alternativa para agregar el agente de escucha de eventos al principio de la matriz de agentes de escucha.

import { EventEmitter } from 'node:events';
const myEE = new EventEmitter();
myEE.on('foo', () => console.log('a'));
myEE.prependListener('foo', () => console.log('b'));
myEE.emit('foo');
// Prints:
//   b
//   a

function on<E>(eventName: string | symbol, listener: (args: any[]) => void): IotEdgeAuthenticationProvider

Parámetros

Devoluciones

se hereda deSharedAccessKeyAuthenticationProvider.on

Agrega una función de única para el evento denominado . La próxima vez que se desencadene eventName, se quita este agente de escucha y, a continuación, se invoca.

server.once('connection', (stream) => {
  console.log('Ah, we have our first user!');
});

Devuelve una referencia al EventEmitter, para que las llamadas se puedan encadenar.

De forma predeterminada, los agentes de escucha de eventos se invocan en el orden en que se agregan. El método emitter.prependOnceListener() se puede usar como alternativa para agregar el agente de escucha de eventos al principio de la matriz de agentes de escucha.

import { EventEmitter } from 'node:events';
const myEE = new EventEmitter();
myEE.once('foo', () => console.log('a'));
myEE.prependOnceListener('foo', () => console.log('b'));
myEE.emit('foo');
// Prints:
//   b
//   a

function once<E>(eventName: string | symbol, listener: (args: any[]) => void): IotEdgeAuthenticationProvider

Parámetros

Devoluciones

Heredado deSharedAccessKeyAuthenticationProvider.once

Agrega la función listener al que comienza de la matriz de agentes de escucha para el evento denominado eventName. No se realizan comprobaciones para ver si ya se ha agregado el listener. Varias llamadas que pasan la misma combinación de eventName y listener darán lugar a que se agregue el listener y se llame varias veces.

server.prependListener('connection', (stream) => {
  console.log('someone connected!');
});

Devuelve una referencia al EventEmitter, para que las llamadas se puedan encadenar.

function prependListener<E>(eventName: string | symbol, listener: (args: any[]) => void): IotEdgeAuthenticationProvider

Parámetros

Devoluciones

heredado desharedAccessKeyAuthenticationProvider.prependListener

Agrega una función de de única para el evento denominado al principio de la matriz de agentes de escucha. La próxima vez que se desencadene eventName, se quita este agente de escucha y, a continuación, se invoca.

server.prependOnceListener('connection', (stream) => {
  console.log('Ah, we have our first user!');
});

Devuelve una referencia al EventEmitter, para que las llamadas se puedan encadenar.

function prependOnceListener<E>(eventName: string | symbol, listener: (args: any[]) => void): IotEdgeAuthenticationProvider

Parámetros

Devoluciones

heredado desharedAccessKeyAuthenticationProvider.prependOnceListener

Devuelve una copia de la matriz de agentes de escucha para el evento denominado eventName, incluidos los contenedores (como los creados por .once()).

import { EventEmitter } from 'node:events';
const emitter = new EventEmitter();
emitter.once('log', () => console.log('log once'));

// Returns a new Array with a function `onceWrapper` which has a property
// `listener` which contains the original listener bound above
const listeners = emitter.rawListeners('log');
const logFnWrapper = listeners[0];

// Logs "log once" to the console and does not unbind the `once` event
logFnWrapper.listener();

// Logs "log once" to the console and removes the listener
logFnWrapper();

emitter.on('log', () => console.log('log persistently'));
// Will return a new Array with a single function bound by `.on()` above
const newListeners = emitter.rawListeners('log');

// Logs "log persistently" twice
newListeners[0]();
emitter.emit('log');

function rawListeners<E>(eventName: string | symbol): (args: any[]) => void[]

Parámetros

Devoluciones

heredado desharedAccessKeyAuthenticationProvider.rawListeners

Quita todos los agentes de escucha o los del eventNameespecificado.

Es un procedimiento incorrecto quitar agentes de escucha agregados en otro lugar del código, especialmente cuando la instancia de EventEmitter se creó mediante algún otro componente o módulo (por ejemplo, sockets o flujos de archivos).

Devuelve una referencia al EventEmitter, para que las llamadas se puedan encadenar.

function removeAllListeners<E>(eventName?: string | symbol): IotEdgeAuthenticationProvider

Parámetros

Devoluciones

se hereda desharedAccessKeyAuthenticationProvider.removeAllListeners

Quita el listener especificado de la matriz del agente de escucha para el evento denominado eventName.

const callback = (stream) => {
  console.log('someone connected!');
};
server.on('connection', callback);
// ...
server.removeListener('connection', callback);

removeListener() quitará, como máximo, una instancia de un agente de escucha de la matriz del agente de escucha. Si se ha agregado varias veces alguna escucha única a la matriz del agente de escucha para el eventNameespecificado, se debe llamar a removeListener() varias veces para quitar cada instancia.

Una vez emitido un evento, se llama a todos los agentes de escucha adjuntos en el momento de emitir en orden. Esto implica que cualquier removeListener()removeAllListeners() llamada tras emitir y antes de que el último oyente termine la ejecución no las eliminará del emit() proceso de ejecución. Los eventos posteriores se comportan según lo previsto.

import { EventEmitter } from 'node:events';
class MyEmitter extends EventEmitter {}
const myEmitter = new MyEmitter();

const callbackA = () => {
  console.log('A');
  myEmitter.removeListener('event', callbackB);
};

const callbackB = () => {
  console.log('B');
};

myEmitter.on('event', callbackA);

myEmitter.on('event', callbackB);

// callbackA removes listener callbackB but it will still be called.
// Internal listener array at time of emit [callbackA, callbackB]
myEmitter.emit('event');
// Prints:
//   A
//   B

// callbackB is now removed.
// Internal listener array [callbackA]
myEmitter.emit('event');
// Prints:
//   A

Como los oyentes se gestionan mediante un array interno, llamar a esto cambiará los índices de posición de cualquier oyente registrado tras la eliminación del oyente. Esto no afectará al orden en el que se llama a los agentes de escucha, pero significa que las copias de la matriz del agente de escucha tal y como devuelve el método emitter.listeners() deberán volver a crearse.

Cuando se ha agregado una sola función como controlador varias veces para un solo evento (como en el ejemplo siguiente), removeListener() quitará la instancia agregada más recientemente. En el ejemplo, se quita el agente de escucha once('ping'):

import { EventEmitter } from 'node:events';
const ee = new EventEmitter();

function pong() {
  console.log('pong');
}

ee.on('ping', pong);
ee.once('ping', pong);
ee.removeListener('ping', pong);

ee.emit('ping');
ee.emit('ping');

Devuelve una referencia al EventEmitter, para que las llamadas se puedan encadenar.

function removeListener<E>(eventName: string | symbol, listener: (args: any[]) => void): IotEdgeAuthenticationProvider

Parámetros

Devoluciones

heredado desharedAccessKeyAuthenticationProvider.removeListener

De forma predeterminada, EventEmitters imprimirán una advertencia si se agregan más de 10 agentes de escucha para un evento determinado. Este es un valor predeterminado útil que ayuda a encontrar fugas de memoria. El método emitter.setMaxListeners() permite modificar el límite para esta instancia de EventEmitter específica. El valor se puede establecer en Infinity (o 0) para indicar un número ilimitado de agentes de escucha.

Devuelve una referencia al EventEmitter, para que las llamadas se puedan encadenar.

function setMaxListeners(n: number): IotEdgeAuthenticationProvider

Parámetros

Devoluciones

Se hereda desharedAccessKeyAuthenticationProvider.setMaxListeners

Este método permite al autor de la llamada establecer nuevos valores para la renovación de autenticación.

Esta función se completa de forma sincrónica, PERO, hará que las acciones se produzcan de forma asincrónica. Si el proveedor ya está realizando renovaciones de tokens, por ejemplo, si se ha realizado una conexión de red, invocar esta función hará que se produzca una nueva renovación en casi inmediatamente. En función del protocolo, esto podría provocar que se produzca una desconexión y una reconexión. Sin embargo, si las renovaciones NO se producen actualmente, simplemente guardamos los nuevos valores para usarlos más adelante.

function setTokenRenewalValues(tokenValidTimeInSeconds: number, tokenRenewalMarginInSeconds: number)

Parámetros

Heredado deSharedAccessKeyAuthenticationProvider.setTokenRenewalValues

Detiene el temporizador usado para renovar el token de SAS.

function stop()

heredado deSharedAccessKeyAuthenticationProvider.stop

El Symbol.for('nodejs.rejection') método se llama en caso de que ocurra un rechazo de promesa al emitir un evento y captureRejections está habilitado en el emisor. Es posible usarlo events.captureRejectionSymbol en lugar de Symbol.for('nodejs.rejection').

import { EventEmitter, captureRejectionSymbol } from 'node:events';

class MyClass extends EventEmitter {
  constructor() {
    super({ captureRejections: true });
  }

  [captureRejectionSymbol](err, event, ...args) {
    console.log('rejection happened for', event, 'with', err, ...args);
    this.destroy(err);
  }

  destroy(err) {
    // Tear the resource down here.
  }
}

function [captureRejectionSymbol](error: Error, event: string | symbol, args: any[])

Parámetros

Heredado deSharedAccessKeyAuthenticationProvider. [captureRejectionSymbol]