Client class
IoT Hub klient urządzenia używany do łączenia urządzenia z usługą Azure IoT Hub.
Użytkownicy zestawu SDK powinni wywołać jedną z metod fabrycznych z pozycjiConnectionString lub zSharedAccessSignature w celu utworzenia klienta urządzenia IoT Hub.
- Extends
-
InternalClient
Konstruktory
Client(Device |
Właściwości dziedziczone
capture |
Wartość: wartość logiczna Zmień domyślną |
capture |
Wartość: Zobacz, jak napisać niestandardowy |
default |
Domyślnie dla dowolnego pojedynczego Należy zachować ostrożność podczas ustawiania To nie jest twardy limit. Wystąpienie
Flaga Emitowane |
error |
Ten symbol służy do instalowania odbiornika tylko do monitorowania Instalowanie odbiornika przy użyciu tego symbolu nie zmienia zachowania po |
Metody
close() | |
close(Callback<Disconnected>) | Zamyka połączenie transportowe i niszczy zasoby klienta. Uwaga: po wywołaniu tej metody nie można ponownie użyć obiektu Client. |
from |
Tworzy klienta urządzenia IoT Hub z danej metody uwierzytelniania i przy użyciu danego typu transportu. |
from |
Tworzy klienta urządzenia IoT Hub z danego parametry połączenia przy użyciu danego typu transportu. |
from |
Tworzy klienta urządzenia IoT Hub z danego sygnatury dostępu współdzielonego przy użyciu danego typu transportu. |
get |
|
get |
Pobiera |
notify |
|
notify |
Metoda |
on |
Rejestruje wywołanie zwrotne dla metody o nazwie |
set |
|
set |
|
upload |
|
upload |
Metoda |
Metody dziedziczone
abandon(Message) | |
abandon(Message, Callback<Message |
|
add |
Nasłuchuje raz zdarzenia
Ten interfejs API umożliwia bezpieczne korzystanie z Zwraca jednorazowy element, dzięki czemu można go łatwiej anulować.
|
add |
Alias dla . |
complete(Message) | |
complete(Message, Callback<Message |
|
emit<K>(string | symbol, Any |
Synchronicznie wywołuje każdy odbiornik zarejestrowany dla zdarzenia o nazwie Zwraca
|
event |
Zwraca tablicę zawierającą listę zdarzeń, dla których emiter zarejestrował odbiorniki. Wartości w tablicy to ciągi lub
|
get |
Zwraca kopię tablicy odbiorników dla zdarzenia o nazwie W przypadku Dla
|
get |
Zwraca bieżącą wartość maksymalnego odbiornika, |
get |
Zwraca obecnie ustawioną maksymalną ilość odbiorników. W przypadku Dla
|
get |
|
get |
|
listener |
Metoda klasy zwracająca liczbę odbiorników dla danej
|
listener |
Zwraca liczbę odbiorników nasłuchujących zdarzenia o nazwie |
listeners<K>(string | symbol) | Zwraca kopię tablicy odbiorników dla zdarzenia o nazwie
|
off<K>(string | symbol, (args: any[]) => void) | Alias dla . |
on(Event |
Zwraca wartość, która Element
|
on<K>(string | symbol, (args: any[]) => void) |
Zwraca odwołanie do elementu Domyślnie odbiorniki zdarzeń są wywoływane w kolejności, w której są dodawane. Metoda
|
once(Event |
Ta metoda jest celowo ogólna i współpracuje z interfejsem platformy internetowej EventTarget , który nie ma specjalnej
Specjalna obsługa
Element
|
once(Event |
|
once<K>(string | symbol, (args: any[]) => void) | Dodaje funkcję jednorazową
Zwraca odwołanie do elementu Domyślnie odbiorniki zdarzeń są wywoływane w kolejności, w której są dodawane. Metoda
|
open() | |
open(Callback<Connected>) | |
prepend |
Zwraca odwołanie do elementu |
prepend |
Dodaje jednorazową
Zwraca odwołanie do elementu |
raw |
Zwraca kopię tablicy odbiorników dla zdarzenia o nazwie
|
reject(Message) | |
reject(Message, Callback<Message |
|
remove |
Usuwa wszystkie odbiorniki lub te z określonej wartości Źle jest usunąć odbiorniki dodane w innym miejscu w kodzie, szczególnie w przypadku utworzenia Zwraca odwołanie do elementu |
remove |
Usuwa określony
Po emisji zdarzenia wszystkie odbiorniki dołączone do niego w momencie emitowania są wywoływane w kolejności. Oznacza to, że wszystkie
Ponieważ odbiorniki są zarządzane przy użyciu tablicy wewnętrznej, wywołanie spowoduje zmianę indeksów pozycji każdego odbiornika zarejestrowanego po usunięciu odbiornika. Nie wpłynie to na kolejność wywoływanych odbiorników, ale oznacza to, że wszystkie kopie tablicy odbiorników zwrócone przez Po dodaniu pojedynczej funkcji jako procedury obsługi wiele razy dla pojedynczego zdarzenia (jak w poniższym przykładzie),
Zwraca odwołanie do elementu |
send |
|
send |
|
send |
|
send |
|
set |
Domyślnie Zwraca odwołanie do elementu |
set |
|
set |
Ustawia zasady ponawiania prób używane przez klienta we wszystkich operacjach. Wartość domyślna to ExponentialBackoffWithJitter. |
set |
|
set |
|
update |
|
[capture |
Szczegóły konstruktora
Client(DeviceTransport, string, BlobUploadClient, FileUploadInterface)
new Client(transport: DeviceTransport, connStr?: string, blobUploadClient?: BlobUploadClient, fileUploadApi?: FileUploadInterface)
Parametry
- transport
- DeviceTransport
Obiekt, który implementuje interfejs oczekiwany dla obiektu transportu, np. Http.
- connStr
-
string
Parametry połączenia (opcjonalnie: jeśli nie podano aktualizacjiSharedAccessSignature musi zostać wywołana w celu bezpośredniego ustawienia tokenu SharedAccessSignature).
- blobUploadClient
-
BlobUploadClient
Obiekt, który może przekazać strumień do obiektu blob.
- fileUploadApi
-
FileUploadInterface
Obiekt używany do komunikowania się z IoT Hub w przypadku akcji związanych z usługą Blob Storage.
Szczegóły właściwości dziedziczonej
captureRejections
Wartość: wartość logiczna
Zmień domyślną captureRejections
opcję na wszystkich nowych EventEmitter
obiektach.
static captureRejections: boolean
Wartość właściwości
boolean
Dziedziczone z InternalClient.captureRejections
captureRejectionSymbol
Wartość: Symbol.for('nodejs.rejection')
Zobacz, jak napisać niestandardowy rejection handler
element .
static captureRejectionSymbol: typeof captureRejectionSymbol
Wartość właściwości
typeof captureRejectionSymbol
Dziedziczone z InternalClient.captureRejectionSymbol
defaultMaxListeners
Domyślnie dla dowolnego pojedynczego 10
zdarzenia można zarejestrować maksymalnie odbiorniki. Ten limit można zmienić dla poszczególnych EventEmitter
wystąpień przy użyciu emitter.setMaxListeners(n)
metody . Aby zmienić wartość domyślną dla wszystkichEventEmitter
wystąpień, events.defaultMaxListeners
można użyć właściwości . Jeśli ta wartość nie jest liczbą dodatnią, RangeError
jest zgłaszana wartość .
Należy zachować ostrożność podczas ustawiania events.defaultMaxListeners
elementu , ponieważ zmiana wpływa na wszystkieEventEmitter
wystąpienia, w tym te utworzone przed wprowadzeniem zmiany. Jednak wywołanie emitter.setMaxListeners(n)
nadal ma pierwszeństwo przed .events.defaultMaxListeners
To nie jest twardy limit. Wystąpienie EventEmitter
umożliwi dodanie większej liczby odbiorników, ale wyświetli ostrzeżenie śledzenia do stderr wskazujące, że wykryto "możliwy wyciek pamięci eventEmitter". W przypadku dowolnej pojedynczej EventEmitter
metody emitter.getMaxListeners()
i emitter.setMaxListeners()
można użyć do tymczasowego uniknięcia tego ostrzeżenia:
import { EventEmitter } from 'node:events';
const emitter = new EventEmitter();
emitter.setMaxListeners(emitter.getMaxListeners() + 1);
emitter.once('event', () => {
// do stuff
emitter.setMaxListeners(Math.max(emitter.getMaxListeners() - 1, 0));
});
Flaga --trace-warnings
wiersza polecenia może służyć do wyświetlania śladu stosu dla takich ostrzeżeń.
Emitowane process.on('warning')
ostrzeżenie można sprawdzić i będzie mieć dodatkowe emitter
właściwości , type
i count
odwołujące się odpowiednio do wystąpienia emitera zdarzeń, nazwy zdarzenia i liczby dołączonych odbiorników.
Jego name
właściwość jest ustawiona na 'MaxListenersExceededWarning'
wartość .
static defaultMaxListeners: number
Wartość właściwości
number
Dziedziczone z InternalClient.defaultMaxListeners
errorMonitor
Ten symbol służy do instalowania odbiornika tylko do monitorowania 'error'
zdarzeń. Odbiorniki zainstalowane przy użyciu tego symbolu są wywoływane przed wywołaniami zwykłych 'error'
odbiorników.
Instalowanie odbiornika przy użyciu tego symbolu nie zmienia zachowania po 'error'
emisji zdarzenia. W związku z tym proces będzie nadal ulegał awarii, jeśli nie zainstalowano zwykłego 'error'
odbiornika.
static errorMonitor: typeof errorMonitor
Wartość właściwości
typeof errorMonitor
Dziedziczone z InternalClient.errorMonitor
Szczegóły metody
close()
function close(): Promise<Disconnected>
Zwraca
Promise<Disconnected>
close(Callback<Disconnected>)
Zamyka połączenie transportowe i niszczy zasoby klienta.
Uwaga: po wywołaniu tej metody nie można ponownie użyć obiektu Client.
function close(closeCallback?: Callback<Disconnected>)
Parametry
- closeCallback
-
Callback<Disconnected>
Opcjonalna funkcja wywoływana po rozłączeniu transportu i zamknięciu klienta.
fromAuthenticationProvider(AuthenticationProvider, any)
Tworzy klienta urządzenia IoT Hub z danej metody uwierzytelniania i przy użyciu danego typu transportu.
static function fromAuthenticationProvider(authenticationProvider: AuthenticationProvider, transportCtor: any): Client
Parametry
- authenticationProvider
-
AuthenticationProvider
Obiekt używany do uzyskiwania parametrów uwierzytelniania dla centrum IoT.
- transportCtor
-
any
Protokół transportu używany do nawiązywania połączenia z centrum IoT.
Zwraca
fromConnectionString(string, any)
Tworzy klienta urządzenia IoT Hub z danego parametry połączenia przy użyciu danego typu transportu.
static function fromConnectionString(connStr: string, transportCtor: any): Client
Parametry
- connStr
-
string
Parametry połączenia, który hermetyzuje uprawnienia "device connect" w centrum IoT.
- transportCtor
-
any
Konstruktor transportu.
Zwraca
fromSharedAccessSignature(string, any)
Tworzy klienta urządzenia IoT Hub z danego sygnatury dostępu współdzielonego przy użyciu danego typu transportu.
static function fromSharedAccessSignature(sharedAccessSignature: string, transportCtor: any): Client
Parametry
- sharedAccessSignature
-
string
Sygnatura dostępu współdzielonego, która hermetyzuje uprawnienia "device connect" w centrum IoT.
- transportCtor
-
any
Zwraca
getBlobSharedAccessSignature(string)
function getBlobSharedAccessSignature(blobName: string): Promise<UploadParams>
Parametry
- blobName
-
string
Zwraca
Promise<UploadParams>
getBlobSharedAccessSignature(string, Callback<UploadParams>)
Pobiera getBlobSharedAccessSignature
połączony token SAS konta magazynu z IoT Hub
function getBlobSharedAccessSignature(blobName: string, callback?: Callback<UploadParams>)
Parametry
- blobName
-
string
Nazwa do użycia dla obiektu blob, który zostanie utworzony z zawartością strumienia.
- callback
-
Callback<UploadParams>
Opcjonalne wywołanie zwrotne do wywołania po zakończeniu przekazywania.
notifyBlobUploadStatus(string, boolean, number, string)
function notifyBlobUploadStatus(correlationId: string, isSuccess: boolean, statusCode: number, statusDescription: string): Promise<void>
Parametry
- correlationId
-
string
- isSuccess
-
boolean
- statusCode
-
number
- statusDescription
-
string
Zwraca
Promise<void>
notifyBlobUploadStatus(string, boolean, number, string, ErrorCallback)
Metoda notifyBlobUploadStatus
wysyła IoT Hub wynik przekazywania obiektów blob.
function notifyBlobUploadStatus(correlationId: string, isSuccess: boolean, statusCode: number, statusDescription: string, callback?: ErrorCallback)
Parametry
- correlationId
-
string
Identyfikator korelowania stanu przekazywania do określonego obiektu blob. Wygenerowano podczas wywołania metody getBlobSharedAccessSignature
.
- isSuccess
-
boolean
Stan powodzenia lub niepowodzenia z wyniku operacji obiektu blob magazynu.
- statusCode
-
number
Kod stanu HTTP skojarzony z wynikiem obiektu blob magazynu.
- statusDescription
-
string
Opis kodu stanu HTTP.
- callback
-
ErrorCallback
Opcjonalne wywołanie zwrotne do wywołania po zakończeniu przekazywania.
onDeviceMethod(string, (request: DeviceMethodRequest, response: DeviceMethodResponse) => void)
Rejestruje wywołanie zwrotne dla metody o nazwie methodName
.
function onDeviceMethod(methodName: string, callback: (request: DeviceMethodRequest, response: DeviceMethodResponse) => void)
Parametry
- methodName
-
string
Nazwa metody, która będzie obsługiwana przez wywołanie zwrotne
- callback
-
(request: DeviceMethodRequest, response: DeviceMethodResponse) => void
Funkcja, która jest wywoływana za każdym razem, gdy zostanie odebrane żądanie metody dla metody o nazwie methodName
.
setOptions(DeviceClientOptions)
function setOptions(options: DeviceClientOptions): Promise<TransportConfigured>
Parametry
- options
- DeviceClientOptions
Zwraca
Promise<TransportConfigured>
setOptions(DeviceClientOptions, Callback<TransportConfigured>)
function setOptions(options: DeviceClientOptions, done: Callback<TransportConfigured>)
Parametry
- options
- DeviceClientOptions
- done
-
Callback<TransportConfigured>
uploadToBlob(string, Stream, number)
function uploadToBlob(blobName: string, stream: Stream, streamLength: number): Promise<void>
Parametry
- blobName
-
string
- stream
-
Stream
- streamLength
-
number
Zwraca
Promise<void>
uploadToBlob(string, Stream, number, ErrorCallback)
Metoda uploadToBlob
przekazuje strumień do obiektu blob.
function uploadToBlob(blobName: string, stream: Stream, streamLength: number, callback: ErrorCallback)
Parametry
- blobName
-
string
Nazwa do użycia dla obiektu blob, który zostanie utworzony z zawartością strumienia.
- stream
-
Stream
Dane do tego powinny zostać przekazane do obiektu blob.
- streamLength
-
number
Rozmiar danych, które powinny zostać przekazane do obiektu blob.
- callback
-
ErrorCallback
Szczegóły metody dziedziczonej
abandon(Message)
function abandon(message: Message): Promise<MessageAbandoned>
Parametry
- message
- Message
Zwraca
Promise<MessageAbandoned>
Dziedziczone z InternalClient.abandon
abandon(Message, Callback<MessageAbandoned>)
function abandon(message: Message, abandonCallback: Callback<MessageAbandoned>)
Parametry
- message
- Message
- abandonCallback
-
Callback<MessageAbandoned>
Dziedziczone z InternalClient.abandon
addAbortListener(AbortSignal, (event: Event) => void)
Nasłuchuje raz zdarzenia abort
w podanym signal
obiekcie .
abort
Nasłuchiwanie zdarzenia za pomocą sygnałów przerwania jest niebezpieczne i może prowadzić do wycieków zasobów, ponieważ inna firma z sygnałem może wywołać metodę e.stopImmediatePropagation()
. Niestety Node.js nie można tego zmienić, ponieważ naruszałoby to standard sieci Web. Ponadto oryginalny interfejs API ułatwia zapomnienie o usunięciu odbiorników.
Ten interfejs API umożliwia bezpieczne korzystanie z AbortSignal
interfejsów API w Node.js przez rozwiązanie tych dwóch problemów przez nasłuchiwanie zdarzenia, które stopImmediatePropagation
nie zapobiega uruchomieniu odbiornika.
Zwraca jednorazowy element, dzięki czemu można go łatwiej anulować.
import { addAbortListener } from 'node:events';
function example(signal) {
let disposable;
try {
signal.addEventListener('abort', (e) => e.stopImmediatePropagation());
disposable = addAbortListener(signal, (e) => {
// Do something when signal is aborted.
});
} finally {
disposable?.[Symbol.dispose]();
}
}
static function addAbortListener(signal: AbortSignal, resource: (event: Event) => void): Disposable
Parametry
- signal
-
AbortSignal
- resource
-
(event: Event) => void
Zwraca
Disposable
Jednorazowy abort
, który usuwa odbiornik.
Dziedziczone z InternalClient.addAbortListener
addListener<K>(string | symbol, (args: any[]) => void)
Alias dla .emitter.on(eventName, listener)
function addListener<K>(eventName: string | symbol, listener: (args: any[]) => void): Client
Parametry
- eventName
-
string | symbol
- listener
-
(args: any[]) => void
Zwraca
Dziedziczone z InternalClient.addListener
complete(Message)
function complete(message: Message): Promise<MessageCompleted>
Parametry
- message
- Message
Zwraca
Promise<MessageCompleted>
Dziedziczone z InternalClient.complete
complete(Message, Callback<MessageCompleted>)
function complete(message: Message, completeCallback: Callback<MessageCompleted>)
Parametry
- message
- Message
- completeCallback
-
Callback<MessageCompleted>
Dziedziczone z InternalClient.complete
emit<K>(string | symbol, AnyRest)
Synchronicznie wywołuje każdy odbiornik zarejestrowany dla zdarzenia o nazwie eventName
, w kolejności, w której zostały zarejestrowane, przekazując podane argumenty do każdego z nich.
Zwraca true
wartość , jeśli zdarzenie miało odbiorniki, false
w przeciwnym razie.
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
Parametry
- eventName
-
string | symbol
- args
-
AnyRest
Zwraca
boolean
Dziedziczone z InternalClient.emit
eventNames()
Zwraca tablicę zawierającą listę zdarzeń, dla których emiter zarejestrował odbiorniki. Wartości w tablicy to ciągi lub 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) ]
function eventNames(): (string | symbol)[]
Zwraca
(string | symbol)[]
Dziedziczone z InternalClient.eventNames
getEventListeners(EventEmitter<DefaultEventMap> | EventTarget, string | symbol)
Zwraca kopię tablicy odbiorników dla zdarzenia o nazwie eventName
.
W przypadku EventEmitter
elementu działa to dokładnie tak samo jak wywołanie .listeners
elementu emitującego.
Dla EventTarget
s jest to jedyny sposób, aby uzyskać odbiorniki zdarzeń dla obiektu docelowego zdarzenia. Jest to przydatne do debugowania i diagnostyki.
import { getEventListeners, EventEmitter } from 'node:events';
{
const ee = new EventEmitter();
const listener = () => console.log('Events are fun');
ee.on('foo', listener);
console.log(getEventListeners(ee, 'foo')); // [ [Function: listener] ]
}
{
const et = new EventTarget();
const listener = () => console.log('Events are fun');
et.addEventListener('foo', listener);
console.log(getEventListeners(et, 'foo')); // [ [Function: listener] ]
}
static function getEventListeners(emitter: EventEmitter<DefaultEventMap> | EventTarget, name: string | symbol): Function[]
Parametry
- emitter
-
EventEmitter<DefaultEventMap> | EventTarget
- name
-
string | symbol
Zwraca
Function[]
Dziedziczone z InternalClient.getEventListeners
getMaxListeners()
Zwraca bieżącą wartość maksymalnego odbiornika, EventEmitter
która jest ustawiona domyślnie emitter.setMaxListeners(n)
lub domyślnie ustawiona na wartość defaultMaxListeners.
function getMaxListeners(): number
Zwraca
number
Dziedziczone z InternalClient.getMaxListeners
getMaxListeners(EventEmitter<DefaultEventMap> | EventTarget)
Zwraca obecnie ustawioną maksymalną ilość odbiorników.
W przypadku EventEmitter
elementu działa to dokładnie tak samo jak wywołanie .getMaxListeners
elementu emitującego.
Dla EventTarget
s jest to jedyny sposób, aby uzyskać maksymalną liczbę odbiorników zdarzeń dla miejsca docelowego zdarzenia. Jeśli liczba procedur obsługi zdarzeń w pojedynczym obiekcie EventTarget przekracza maksymalny zestaw, usługa EventTarget wyświetli ostrzeżenie.
import { getMaxListeners, setMaxListeners, EventEmitter } from 'node:events';
{
const ee = new EventEmitter();
console.log(getMaxListeners(ee)); // 10
setMaxListeners(11, ee);
console.log(getMaxListeners(ee)); // 11
}
{
const et = new EventTarget();
console.log(getMaxListeners(et)); // 10
setMaxListeners(11, et);
console.log(getMaxListeners(et)); // 11
}
static function getMaxListeners(emitter: EventEmitter<DefaultEventMap> | EventTarget): number
Parametry
- emitter
-
EventEmitter<DefaultEventMap> | EventTarget
Zwraca
number
Dziedziczone z InternalClient.getMaxListeners
getTwin()
getTwin(Callback<Twin>)
function getTwin(done: Callback<Twin>)
Parametry
- done
-
Callback<Twin>
Dziedziczone z InternalClient.getTwin
listenerCount(EventEmitter<DefaultEventMap>, string | symbol)
Ostrzeżenie
Ten interfejs API jest już przestarzały.
Since v3.2.0 - Use listenerCount
instead.
Metoda klasy zwracająca liczbę odbiorników dla danej eventName
zarejestrowanej na danym emitter
obiekcie .
import { EventEmitter, listenerCount } from 'node:events';
const myEmitter = new EventEmitter();
myEmitter.on('event', () => {});
myEmitter.on('event', () => {});
console.log(listenerCount(myEmitter, 'event'));
// Prints: 2
static function listenerCount(emitter: EventEmitter<DefaultEventMap>, eventName: string | symbol): number
Parametry
- emitter
-
EventEmitter<DefaultEventMap>
Emiter do wykonywania zapytania
- eventName
-
string | symbol
Nazwa zdarzenia
Zwraca
number
Dziedziczone z InternalClient.listenerCount
listenerCount<K>(string | symbol, Function)
Zwraca liczbę odbiorników nasłuchujących zdarzenia o nazwie eventName
.
Jeśli listener
zostanie podana, zostanie zwrócona liczba wystąpień odbiornika na liście odbiorników zdarzenia.
function listenerCount<K>(eventName: string | symbol, listener?: Function): number
Parametry
- eventName
-
string | symbol
Nazwa zdarzenia, dla których jest nasłuchiwane
- listener
-
Function
Funkcja obsługi zdarzeń
Zwraca
number
Dziedziczone z InternalClient.listenerCount
listeners<K>(string | symbol)
Zwraca kopię tablicy odbiorników dla zdarzenia o nazwie 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[]
Parametry
- eventName
-
string | symbol
Zwraca
Function[]
Dziedziczone z InternalClient.listeners
off<K>(string | symbol, (args: any[]) => void)
Alias dla .emitter.removeListener()
function off<K>(eventName: string | symbol, listener: (args: any[]) => void): Client
Parametry
- eventName
-
string | symbol
- listener
-
(args: any[]) => void
Zwraca
Dziedziczone z InternalClient.off
on(EventEmitter<DefaultEventMap>, string, StaticEventEmitterOptions)
import { on, EventEmitter } from 'node:events';
import process from 'node:process';
const ee = new EventEmitter();
// Emit later on
process.nextTick(() => {
ee.emit('foo', 'bar');
ee.emit('foo', 42);
});
for await (const event of on(ee, 'foo')) {
// The execution of this inner block is synchronous and it
// processes one event at a time (even with await). Do not use
// if concurrent execution is required.
console.log(event); // prints ['bar'] [42]
}
// Unreachable here
Zwraca wartość, która AsyncIterator
iteruje eventName
zdarzenia. Spowoduje to zgłoszenie, jeśli emituje 'error'
wartość EventEmitter
. Usuwa wszystkie odbiorniki podczas zamykania pętli. Zwracana value
przez każdą iterację jest tablicą składającą się z emitowanych argumentów zdarzeń.
Element AbortSignal
może służyć do anulowania oczekiwania na zdarzenia:
import { on, EventEmitter } from 'node:events';
import process from 'node:process';
const ac = new AbortController();
(async () => {
const ee = new EventEmitter();
// Emit later on
process.nextTick(() => {
ee.emit('foo', 'bar');
ee.emit('foo', 42);
});
for await (const event of on(ee, 'foo', { signal: ac.signal })) {
// The execution of this inner block is synchronous and it
// processes one event at a time (even with await). Do not use
// if concurrent execution is required.
console.log(event); // prints ['bar'] [42]
}
// Unreachable here
})();
process.nextTick(() => ac.abort());
static function on(emitter: EventEmitter<DefaultEventMap>, eventName: string, options?: StaticEventEmitterOptions): AsyncIterableIterator<any>
Parametry
- emitter
-
EventEmitter<DefaultEventMap>
- eventName
-
string
Nazwa zdarzenia, dla których jest nasłuchiwane
- options
-
StaticEventEmitterOptions
Zwraca
AsyncIterableIterator<any>
Element AsyncIterator
, który iteruje eventName
zdarzenia emitowane przez emitter
Dziedziczone z InternalClient.on
on<K>(string | symbol, (args: any[]) => void)
listener
Dodaje funkcję na końcu tablicy odbiorników dla zdarzenia o nazwie eventName
. Nie są sprawdzane, czy listener
element został już dodany. Wiele wywołań przekazujących eventName
tę samą kombinację elementów i listener
spowoduje listener
dodanie i wywołanie wielu razy.
server.on('connection', (stream) => {
console.log('someone connected!');
});
Zwraca odwołanie do elementu EventEmitter
, aby można było połączyć wywołania w łańcuch.
Domyślnie odbiorniki zdarzeń są wywoływane w kolejności, w której są dodawane. Metoda emitter.prependListener()
może służyć jako alternatywa, aby dodać odbiornik zdarzeń na początku tablicy odbiorników.
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<K>(eventName: string | symbol, listener: (args: any[]) => void): Client
Parametry
- eventName
-
string | symbol
Nazwa zdarzenia.
- listener
-
(args: any[]) => void
Funkcja wywołania zwrotnego
Zwraca
Dziedziczone z InternalClient.on
once(EventEmitter<DefaultEventMap>, string | symbol, StaticEventEmitterOptions)
Promise
Tworzy obiekt, który jest spełniony, gdy EventEmitter
emituje dane zdarzenie lub jest odrzucany, jeśli EventEmitter
emituje 'error'
podczas oczekiwania.
Funkcja Promise
rozwiąże problem z tablicą wszystkich argumentów emitowanych do danego zdarzenia.
Ta metoda jest celowo ogólna i współpracuje z interfejsem platformy internetowej EventTarget , który nie ma specjalnej'error'
semantyki zdarzeń i nie nasłuchuje 'error'
zdarzenia.
import { once, EventEmitter } from 'node:events';
import process from 'node:process';
const ee = new EventEmitter();
process.nextTick(() => {
ee.emit('myevent', 42);
});
const [value] = await once(ee, 'myevent');
console.log(value);
const err = new Error('kaboom');
process.nextTick(() => {
ee.emit('error', err);
});
try {
await once(ee, 'myevent');
} catch (err) {
console.error('error happened', err);
}
Specjalna obsługa 'error'
zdarzenia jest używana tylko wtedy, gdy events.once()
jest używana do oczekiwania na inne zdarzenie. Jeśli events.once()
jest używany do oczekiwania na samo zdarzenie ,error'
jest traktowany jako dowolny inny rodzaj zdarzenia bez specjalnej obsługi:
import { EventEmitter, once } from 'node:events';
const ee = new EventEmitter();
once(ee, 'error')
.then(([err]) => console.log('ok', err.message))
.catch((err) => console.error('error', err.message));
ee.emit('error', new Error('boom'));
// Prints: ok boom
Element AbortSignal
może służyć do anulowania oczekiwania na zdarzenie:
import { EventEmitter, once } from 'node:events';
const ee = new EventEmitter();
const ac = new AbortController();
async function foo(emitter, event, signal) {
try {
await once(emitter, event, { signal });
console.log('event emitted!');
} catch (error) {
if (error.name === 'AbortError') {
console.error('Waiting for the event was canceled!');
} else {
console.error('There was an error', error.message);
}
}
}
foo(ee, 'foo', ac.signal);
ac.abort(); // Abort waiting for the event
ee.emit('foo'); // Prints: Waiting for the event was canceled!
static function once(emitter: EventEmitter<DefaultEventMap>, eventName: string | symbol, options?: StaticEventEmitterOptions): Promise<any[]>
Parametry
- emitter
-
EventEmitter<DefaultEventMap>
- eventName
-
string | symbol
- options
-
StaticEventEmitterOptions
Zwraca
Promise<any[]>
Dziedziczone z InternalClient.once
once(EventTarget, string, StaticEventEmitterOptions)
static function once(emitter: EventTarget, eventName: string, options?: StaticEventEmitterOptions): Promise<any[]>
Parametry
- emitter
-
EventTarget
- eventName
-
string
- options
-
StaticEventEmitterOptions
Zwraca
Promise<any[]>
Dziedziczone z InternalClient.once
once<K>(string | symbol, (args: any[]) => void)
Dodaje funkcję jednorazowąlistener
dla zdarzenia o nazwie eventName
. Następnym razem eventName
zostanie wyzwolony odbiornik, a następnie wywołany.
server.once('connection', (stream) => {
console.log('Ah, we have our first user!');
});
Zwraca odwołanie do elementu EventEmitter
, aby można było połączyć wywołania w łańcuch.
Domyślnie odbiorniki zdarzeń są wywoływane w kolejności, w której są dodawane. Metoda emitter.prependOnceListener()
może służyć jako alternatywa, aby dodać odbiornik zdarzeń na początku tablicy odbiorników.
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): Client
Parametry
- eventName
-
string | symbol
Nazwa zdarzenia.
- listener
-
(args: any[]) => void
Funkcja wywołania zwrotnego
Zwraca
Dziedziczone z InternalClient.once
open()
function open(): Promise<Connected>
Zwraca
Promise<Connected>
Dziedziczone z InternalClient.open
open(Callback<Connected>)
function open(openCallback: Callback<Connected>)
Parametry
- openCallback
-
Callback<Connected>
Dziedziczone z InternalClient.open
prependListener<K>(string | symbol, (args: any[]) => void)
listener
Dodaje funkcję na początku tablicy odbiorników dla zdarzenia o nazwie eventName
. Nie są sprawdzane, czy listener
element został już dodany. Wiele wywołań przekazujących eventName
tę samą kombinację elementów i listener
spowoduje listener
dodanie i wywołanie wielu razy.
server.prependListener('connection', (stream) => {
console.log('someone connected!');
});
Zwraca odwołanie do elementu EventEmitter
, aby można było połączyć wywołania w łańcuch.
function prependListener<K>(eventName: string | symbol, listener: (args: any[]) => void): Client
Parametry
- eventName
-
string | symbol
Nazwa zdarzenia.
- listener
-
(args: any[]) => void
Funkcja wywołania zwrotnego
Zwraca
Dziedziczone z InternalClient.prependListener
prependOnceListener<K>(string | symbol, (args: any[]) => void)
Dodaje jednorazowąlistener
funkcję zdarzenia o nazwie eventName
na początku tablicy odbiorników. Następnym razem eventName
zostanie wyzwolony, ten odbiornik zostanie usunięty, a następnie wywołany.
server.prependOnceListener('connection', (stream) => {
console.log('Ah, we have our first user!');
});
Zwraca odwołanie do elementu EventEmitter
, aby można było połączyć wywołania w łańcuch.
function prependOnceListener<K>(eventName: string | symbol, listener: (args: any[]) => void): Client
Parametry
- eventName
-
string | symbol
Nazwa zdarzenia.
- listener
-
(args: any[]) => void
Funkcja wywołania zwrotnego
Zwraca
Dziedziczone z InternalClient.prependOnceListener
rawListeners<K>(string | symbol)
Zwraca kopię tablicy odbiorników dla zdarzenia o nazwie eventName
, w tym wszelkie otoki (takie jak utworzone przez .once()
program ).
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[]
Parametry
- eventName
-
string | symbol
Zwraca
Function[]
Dziedziczone z InternalClient.rawListeners
reject(Message)
function reject(message: Message): Promise<MessageRejected>
Parametry
- message
- Message
Zwraca
Promise<MessageRejected>
Dziedziczone z InternalClient.reject
reject(Message, Callback<MessageRejected>)
function reject(message: Message, rejectCallback: Callback<MessageRejected>)
Parametry
- message
- Message
- rejectCallback
-
Callback<MessageRejected>
Dziedziczone z InternalClient.reject
removeAllListeners(string | symbol)
Usuwa wszystkie odbiorniki lub te z określonej wartości eventName
.
Źle jest usunąć odbiorniki dodane w innym miejscu w kodzie, szczególnie w przypadku utworzenia EventEmitter
wystąpienia przez inny składnik lub moduł (np. gniazda lub strumienie plików).
Zwraca odwołanie do elementu EventEmitter
, aby wywołania mogły być łańcuchowe.
function removeAllListeners(eventName?: string | symbol): Client
Parametry
- eventName
-
string | symbol
Zwraca
Dziedziczone z InternalClient.removeAllListeners
removeListener<K>(string | symbol, (args: any[]) => void)
Usuwa określony listener
element z tablicy odbiorników dla zdarzenia o nazwie eventName
.
const callback = (stream) => {
console.log('someone connected!');
};
server.on('connection', callback);
// ...
server.removeListener('connection', callback);
removeListener()
spowoduje usunięcie co najwyżej jednego wystąpienia odbiornika z tablicy odbiornika. Jeśli którykolwiek odbiornik został dodany wiele razy do tablicy odbiornika dla określonego eventName
elementu , removeListener()
należy wywołać go wiele razy, aby usunąć każde wystąpienie.
Po emisji zdarzenia wszystkie odbiorniki dołączone do niego w momencie emitowania są wywoływane w kolejności. Oznacza to, że wszystkie removeListener()
wywołania lub removeAllListeners()
po emitowaniu i zanim ostatni odbiornik zakończy wykonywanie, nie usunie ich zemit()
postępu. Kolejne zdarzenia zachowują się zgodnie z oczekiwaniami.
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
Ponieważ odbiorniki są zarządzane przy użyciu tablicy wewnętrznej, wywołanie spowoduje zmianę indeksów pozycji każdego odbiornika zarejestrowanego po usunięciu odbiornika. Nie wpłynie to na kolejność wywoływanych odbiorników, ale oznacza to, że wszystkie kopie tablicy odbiorników zwrócone przez emitter.listeners()
metodę będą musiały zostać ponownie utworzony.
Po dodaniu pojedynczej funkcji jako procedury obsługi wiele razy dla pojedynczego zdarzenia (jak w poniższym przykładzie), removeListener()
usunie ostatnio dodane wystąpienie. W przykładzie once('ping')
odbiornik zostanie usunięty:
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');
Zwraca odwołanie do elementu EventEmitter
, aby wywołania mogły być łańcuchowe.
function removeListener<K>(eventName: string | symbol, listener: (args: any[]) => void): Client
Parametry
- eventName
-
string | symbol
- listener
-
(args: any[]) => void
Zwraca
Dziedziczone z InternalClient.removeListener
sendEvent(Message)
function sendEvent(message: Message): Promise<MessageEnqueued>
Parametry
- message
- Message
Zwraca
Promise<MessageEnqueued>
Dziedziczone z InternalClient.sendEvent
sendEvent(Message, Callback<MessageEnqueued>)
function sendEvent(message: Message, sendEventCallback: Callback<MessageEnqueued>)
Parametry
- message
- Message
- sendEventCallback
-
Callback<MessageEnqueued>
Dziedziczone z InternalClient.sendEvent
sendEventBatch(Message[])
function sendEventBatch(messages: Message[]): Promise<MessageEnqueued>
Parametry
- messages
-
Message[]
Zwraca
Promise<MessageEnqueued>
Dziedziczone z InternalClient.sendEventBatch
sendEventBatch(Message[], Callback<MessageEnqueued>)
function sendEventBatch(messages: Message[], sendEventBatchCallback: Callback<MessageEnqueued>)
Parametry
- messages
-
Message[]
- sendEventBatchCallback
-
Callback<MessageEnqueued>
Dziedziczone z InternalClient.sendEventBatch
setMaxListeners(number)
Domyślnie EventEmitter
funkcja s wyświetli ostrzeżenie, jeśli dla określonego zdarzenia zostanie dodanych więcej niż 10
odbiorniki. Jest to przydatna wartość domyślna, która pomaga znaleźć przecieki pamięci. Metoda emitter.setMaxListeners()
umożliwia zmodyfikowanie limitu dla tego konkretnego EventEmitter
wystąpienia. Wartość można ustawić na Infinity
(lub 0
), aby wskazać nieograniczoną liczbę odbiorników.
Zwraca odwołanie do elementu EventEmitter
, aby wywołania mogły być łańcuchowe.
function setMaxListeners(n: number): Client
Parametry
- n
-
number
Zwraca
Dziedziczone z InternalClient.setMaxListeners
setMaxListeners(number, (EventEmitter<DefaultEventMap> | EventTarget)[])
import { setMaxListeners, EventEmitter } from 'node:events';
const target = new EventTarget();
const emitter = new EventEmitter();
setMaxListeners(5, target, emitter);
static function setMaxListeners(n?: number, eventTargets: (EventEmitter<DefaultEventMap> | EventTarget)[])
Parametry
- n
-
number
Liczba nie ujemna. Maksymalna liczba odbiorników na EventTarget
zdarzenie.
- eventTargets
-
(EventEmitter<DefaultEventMap> | EventTarget)[]
Dziedziczone z InternalClient.setMaxListeners
setRetryPolicy(RetryPolicy)
Ustawia zasady ponawiania prób używane przez klienta we wszystkich operacjach. Wartość domyślna to ExponentialBackoffWithJitter.
function setRetryPolicy(policy: RetryPolicy)
Parametry
- policy
-
RetryPolicy
{RetryPolicy} Zasady ponawiania, które powinny być używane dla wszystkich przyszłych operacji.
Dziedziczone z InternalClient.setRetryPolicy
setTransportOptions(any)
function setTransportOptions(options: any): Promise<TransportConfigured>
Parametry
- options
-
any
Zwraca
Promise<TransportConfigured>
Dziedziczone z InternalClient.setTransportOptions
setTransportOptions(any, Callback<TransportConfigured>)
function setTransportOptions(options: any, done: Callback<TransportConfigured>)
Parametry
- options
-
any
- done
-
Callback<TransportConfigured>
Dziedziczone z InternalClient.setTransportOptions
updateSharedAccessSignature(string, Callback<SharedAccessSignatureUpdated>)
function updateSharedAccessSignature(sharedAccessSignature: string, updateSasCallback?: Callback<SharedAccessSignatureUpdated>)
Parametry
- sharedAccessSignature
-
string
- updateSasCallback
-
Callback<SharedAccessSignatureUpdated>
Dziedziczone z InternalClient.updateSharedAccessSignature
[captureRejectionSymbol]<K>(Error, string | symbol, AnyRest)
function [captureRejectionSymbol]<K>(error: Error, event: string | symbol, args: AnyRest)
Parametry
- error
-
Error
- event
-
string | symbol
- args
-
AnyRest
Dziedziczone z InternalClient.__@captureRejectionSymbol@138