你当前正在访问 Microsoft Azure Global Edition 技术文档网站。如果需要访问由世纪互联运营的 Microsoft Azure 中国技术文档网站，请访问 https://docs.azure.cn。

ServiceReceiver interface

参考

包:: azure-iothub

扩展: Receiver

方法

abandon(Message, Callback<MessageAbandoned>)
complete(Message, Callback<MessageCompleted>)
reject(Message, Callback<MessageRejected>)

继承的方法

addListener<K>(string \| symbol, (args: any[]) => void)	`emitter.on(eventName, listener)`的别名。
emit<K>(string \| symbol, AnyRest)	同步调用为名为 `eventName`的事件注册的每个侦听器，按照注册的顺序，将提供的参数传递给每个侦听器。如果事件具有侦听器，则返回 `true`，否则 `false`。 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
eventNames()	返回一个数组，其中列出发出器已注册侦听器的事件。数组中的值为字符串或 `Symbol`s。 `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) ]`
getMaxListeners()	返回由 `EventEmitter` 设置的 `emitter.setMaxListeners(n)` 的当前最大侦听器值，或默认值为 defaultMaxListeners。
listenerCount<K>(string \| symbol, Function)	返回侦听名为 `eventName`的事件的侦听器数。如果提供了 `listener`，它将返回在事件的侦听器列表中找到的侦听器的次数。
listeners<K>(string \| symbol)	返回名为 `eventName`的事件的侦听器数组的副本。 `server.on('connection', (stream) => { console.log('someone connected!'); }); console.log(util.inspect(server.listeners('connection'))); // Prints: [ [Function] ]`
off<K>(string \| symbol, (args: any[]) => void)	`emitter.removeListener()`的别名。
on("errorReceived", (err: Error) => void)
on("message", (msg: Message) => void)
on(string, Function)
once<K>(string \| symbol, (args: any[]) => void)	为名为的事件添加 `listenereventName` 函数。下次触发 `eventName` 时，将删除此侦听器，然后调用。 `server.once('connection', (stream) => { console.log('Ah, we have our first user!'); });` 返回对 `EventEmitter`的引用，以便可以链接调用。默认情况下，以添加事件侦听器的顺序调用事件侦听器。 `emitter.prependOnceListener()` 方法可用作将事件侦听器添加到侦听器数组开头的替代方法。 `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`
prependListener<K>(string \| symbol, (args: any[]) => void)	将函数添加到名为的事件的侦听器数组的开始。不会进行检查，以查看是否已添加 `listener`。传递 `eventName` 和 `listener` 相同组合的多个调用将导致添加 `listener` 并多次调用。 `server.prependListener('connection', (stream) => { console.log('someone connected!'); });` 返回对 `EventEmitter`的引用，以便可以链接调用。
prependOnceListener<K>(string \| symbol, (args: any[]) => void)	将名为的事件一次性函数添加到侦听器数组开始。下次触发 `eventName` 时，将删除此侦听器，然后调用。 `server.prependOnceListener('connection', (stream) => { console.log('Ah, we have our first user!'); });` 返回对 `EventEmitter`的引用，以便可以链接调用。
rawListeners<K>(string \| symbol)	返回名为 `eventName`的事件的侦听器数组的副本，包括任何包装器（如由 `.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');
removeAllListeners(string \| symbol)	删除所有侦听器或指定 `eventName`的侦听器。删除代码中的其他位置添加的侦听器是错误的做法，尤其是在由其他组件或模块（例如套接字或文件流）创建 `EventEmitter` 实例时。返回对 `EventEmitter`的引用，以便可以链接调用。
removeListener<K>(string \| symbol, (args: any[]) => void)	从名为 `listener`的事件的侦听器数组中删除指定的 `eventName`。 `const callback = (stream) => { console.log('someone connected!'); }; server.on('connection', callback); // ... server.removeListener('connection', callback);` `removeListener()` 最多会从侦听器数组中删除侦听器的一个实例。如果为指定的 `eventName`向侦听器数组添加了多次单个侦听器，则必须多次调用 `removeListener()` 才能删除每个实例。发出事件后，在发出时附加到该事件的所有侦听器将按顺序调用。这意味着在发出和之后，任何或调用，最后一个侦听器完成执行不会将其从正在进行的中删除。后续事件的行为与预期相同。 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 由于侦听器是使用内部数组管理的，因此调用这将更改删除侦听器后注册的任何侦听器的位置索引。这不会影响调用侦听器的顺序，但这意味着需要重新创建 `emitter.listeners()` 方法返回的侦听器数组的任何副本。将单个函数添加为单个事件的处理程序多次（如以下示例所示），`removeListener()` 将删除最近添加的实例。在示例中，删除 `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');` 返回对 `EventEmitter`的引用，以便可以链接调用。
setMaxListeners(number)	默认情况下，如果为特定事件添加了多个 `EventEmitter` 侦听器，`10`将打印警告。这是一个有用的默认值，可帮助查找内存泄漏。 `emitter.setMaxListeners()` 方法允许修改此特定 `EventEmitter` 实例的限制。该值可以设置为 `Infinity`（或 `0`），以指示无限数量的侦听器。返回对 `EventEmitter`的引用，以便可以链接调用。
[captureRejectionSymbol]<K>(Error, string \| symbol, AnyRest)

方法详细信息

abandon(Message, Callback<MessageAbandoned>)

function abandon(message: Message, done?: Callback<MessageAbandoned>)

参数

message: Message

done: Callback<MessageAbandoned>

complete(Message, Callback<MessageCompleted>)

function complete(message: Message, done?: Callback<MessageCompleted>)

参数

message: Message

done: Callback<MessageCompleted>

reject(Message, Callback<MessageRejected>)

function reject(message: Message, done?: Callback<MessageRejected>)

参数

message: Message

done: Callback<MessageRejected>

继承的方法详细信息

addListener<K>(string | symbol, (args: any[]) => void)

emitter.on(eventName, listener)的别名。

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

参数

eventName: string | symbol

listener: (args: any[]) => void

ServiceReceiver

继承自 Receiver.addListener

emit<K>(string | symbol, AnyRest)

同步调用为名为 eventName的事件注册的每个侦听器，按照注册的顺序，将提供的参数传递给每个侦听器。

如果事件具有侦听器，则返回 true，否则 false。

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<K>(eventName: string | symbol, args: AnyRest): boolean

参数

eventName: string | symbol

args: AnyRest

boolean

继承自 Receiver.emit

eventNames()

返回一个数组，其中列出发出器已注册侦听器的事件。数组中的值为字符串或 Symbols。

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)[]

(string | symbol)[]

继承自 Receiver.eventNames

getMaxListeners()

返回由 EventEmitter 设置的 emitter.setMaxListeners(n) 的当前最大侦听器值，或默认值为 defaultMaxListeners。

function getMaxListeners(): number

number

继承自 Receiver.getMaxListeners

listenerCount<K>(string | symbol, Function)

返回侦听名为 eventName的事件的侦听器数。如果提供了 listener，它将返回在事件的侦听器列表中找到的侦听器的次数。

function listenerCount<K>(eventName: string | symbol, listener?: Function): number

参数

eventName: string | symbol

正在侦听的事件的名称

listener: Function

事件处理程序函数

number

继承自 Receiver.listenerCount 的

listeners<K>(string | symbol)

返回名为 eventName的事件的侦听器数组的副本。

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

function listeners<K>(eventName: string | symbol): Function[]

参数

eventName: string | symbol

Function[]

继承自 Receiver.listeners

off<K>(string | symbol, (args: any[]) => void)

emitter.removeListener()的别名。

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

参数

eventName: string | symbol

listener: (args: any[]) => void

ServiceReceiver

继承自 Receiver.off

on("errorReceived", (err: Error) => void)

function on(type: "errorReceived", func: (err: Error) => void): ServiceReceiver

参数

type: "errorReceived"

func: (err: Error) => void

ServiceReceiver

继承自 Receiver.on

on("message", (msg: Message) => void)

function on(type: "message", func: (msg: Message) => void): ServiceReceiver

参数

type: "message"

func: (msg: Message) => void

ServiceReceiver

继承自 Receiver.on

on(string, Function)

function on(type: string, func: Function): ServiceReceiver

参数

type: string

func: Function

ServiceReceiver

继承自 Receiver.on

once<K>(string | symbol, (args: any[]) => void)

为名为的事件添加 listenereventName 函数。下次触发 eventName 时，将删除此侦听器，然后调用。

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

返回对 EventEmitter的引用，以便可以链接调用。

默认情况下，以添加事件侦听器的顺序调用事件侦听器。 emitter.prependOnceListener() 方法可用作将事件侦听器添加到侦听器数组开头的替代方法。

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<K>(eventName: string | symbol, listener: (args: any[]) => void): ServiceReceiver

参数

eventName: string | symbol

事件的名称。

listener: (args: any[]) => void

回调函数

ServiceReceiver

继承自 Receiver.once

prependListener<K>(string | symbol, (args: any[]) => void)

将函数添加到名为的事件的侦听器数组的开始。不会进行检查，以查看是否已添加 listener。传递 eventName 和 listener 相同组合的多个调用将导致添加 listener 并多次调用。

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

返回对 EventEmitter的引用，以便可以链接调用。

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

参数

eventName: string | symbol

事件的名称。

listener: (args: any[]) => void

回调函数

ServiceReceiver

继承自 Receiver.prependListener

prependOnceListener<K>(string | symbol, (args: any[]) => void)

将名为的事件一次性函数添加到侦听器数组开始。下次触发 eventName 时，将删除此侦听器，然后调用。

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

返回对 EventEmitter的引用，以便可以链接调用。

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

参数

eventName: string | symbol

事件的名称。

listener: (args: any[]) => void

回调函数

ServiceReceiver

继承自 Receiver.prependOnceListener

rawListeners<K>(string | symbol)

返回名为 eventName的事件的侦听器数组的副本，包括任何包装器（如由 .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<K>(eventName: string | symbol): Function[]

参数

eventName: string | symbol

Function[]

继承自 Receiver.rawListeners

removeAllListeners(string | symbol)

删除所有侦听器或指定 eventName的侦听器。

删除代码中的其他位置添加的侦听器是错误的做法，尤其是在由其他组件或模块（例如套接字或文件流）创建 EventEmitter 实例时。

返回对 EventEmitter的引用，以便可以链接调用。

function removeAllListeners(eventName?: string | symbol): ServiceReceiver

参数

eventName: string | symbol

ServiceReceiver

继承自 Receiver.removeAllListeners

removeListener<K>(string | symbol, (args: any[]) => void)

从名为 listener的事件的侦听器数组中删除指定的 eventName。

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

removeListener() 最多会从侦听器数组中删除侦听器的一个实例。如果为指定的 eventName向侦听器数组添加了多次单个侦听器，则必须多次调用 removeListener() 才能删除每个实例。

发出事件后，在发出时附加到该事件的所有侦听器将按顺序调用。这意味着在发出和之后，任何或调用，最后一个侦听器完成执行不会将其从正在进行的中删除。后续事件的行为与预期相同。

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

由于侦听器是使用内部数组管理的，因此调用这将更改删除侦听器后注册的任何侦听器的位置索引。这不会影响调用侦听器的顺序，但这意味着需要重新创建 emitter.listeners() 方法返回的侦听器数组的任何副本。

将单个函数添加为单个事件的处理程序多次（如以下示例所示），removeListener() 将删除最近添加的实例。在示例中，删除 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');

返回对 EventEmitter的引用，以便可以链接调用。

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

参数

eventName: string | symbol

listener: (args: any[]) => void

ServiceReceiver

继承自 Receiver.removeListener

setMaxListeners(number)

默认情况下，如果为特定事件添加了多个 EventEmitter 侦听器，10将打印警告。这是一个有用的默认值，可帮助查找内存泄漏。 emitter.setMaxListeners() 方法允许修改此特定 EventEmitter 实例的限制。该值可以设置为 Infinity（或 0），以指示无限数量的侦听器。

返回对 EventEmitter的引用，以便可以链接调用。

function setMaxListeners(n: number): ServiceReceiver

参数

n: number

ServiceReceiver

继承自 Receiver.setMaxListeners

[captureRejectionSymbol]<K>(Error, string | symbol, AnyRest)

function [captureRejectionSymbol]<K>(error: Error, event: string | symbol, args: AnyRest)

参数

error: Error

event: string | symbol

args: AnyRest

继承自 Receiver.__@captureRejectionSymbol@118 的

通过

ServiceReceiver interface

方法

继承的方法

方法详细信息

abandon(Message, Callback<MessageAbandoned>)

参数

complete(Message, Callback<MessageCompleted>)

参数

reject(Message, Callback<MessageRejected>)

参数

继承的方法详细信息

addListener<K>(string | symbol, (args: any[]) => void)

参数

返回

emit<K>(string | symbol, AnyRest)

参数

返回

eventNames()

返回

getMaxListeners()

返回

listenerCount<K>(string | symbol, Function)

参数

返回

listeners<K>(string | symbol)

参数

返回

off<K>(string | symbol, (args: any[]) => void)

参数

返回

on("errorReceived", (err: Error) => void)

参数

返回

on("message", (msg: Message) => void)

参数

返回

on(string, Function)

参数

返回

once<K>(string | symbol, (args: any[]) => void)

参数

返回

prependListener<K>(string | symbol, (args: any[]) => void)

参数

返回

prependOnceListener<K>(string | symbol, (args: any[]) => void)

参数

返回

rawListeners<K>(string | symbol)

参数

返回

removeAllListeners(string | symbol)

参数

返回

removeListener<K>(string | symbol, (args: any[]) => void)

参数

返回

setMaxListeners(number)

参数

返回

[captureRejectionSymbol]<K>(Error, string | symbol, AnyRest)

参数

其他资源