Client class

Csomag:: azure-iot-device

IoT Hub-eszközügyfél, amellyel egy eszközt csatlakoztathat egy Azure IoT Hubhoz.

Az SDK felhasználóinak meg kell hívniuk az egyik gyári metódust, aConnectionString vagy a fromSharedAccessSignature egy IoT Hub-eszközügyfél létrehozásához.

Extends: InternalClient

Konstruktorok

Client(DeviceTransport, string, BlobUploadClient, FileUploadInterface)

Metódusok

close()
close(Callback<Disconnected>)	Bezárja az átviteli kapcsolatot, és megsemmisíti az ügyfélerőforrásokat. Megjegyzés: A metódus meghívása után az ügyfélobjektum nem használható újra.
fromAuthenticationProvider(AuthenticationProvider, any)	Létrehoz egy IoT Hub-eszközügyfélt a megadott hitelesítési módszerből és a megadott átviteli típus használatával.
fromConnectionString(string, any)	Létrehoz egy IoT Hub-eszközügyfélt az adott kapcsolati sztringből a megadott átviteli típus használatával.
fromSharedAccessSignature(string, any)	Létrehoz egy IoT Hub-eszközügyfélt a megadott közös hozzáférésű jogosultságkódból az adott átviteli típus használatával.
getBlobSharedAccessSignature(string)
getBlobSharedAccessSignature(string, Callback<UploadParams>)	A `getBlobSharedAccessSignature` lekéri a társított tárfiók SAS-jogkivonatát az IoT Hubról
notifyBlobUploadStatus(string, boolean, number, string)
notifyBlobUploadStatus(string, boolean, number, string, ErrorCallback)	A `notifyBlobUploadStatus` metódus egy blobfeltöltés eredményét küldi el az IoT Hubnak.
onDeviceMethod(string, (request: DeviceMethodRequest, response: DeviceMethodResponse) => void)	Egy `methodName`nevű metódus visszahívását regisztrálja.
setOptions(DeviceClientOptions)
setOptions(DeviceClientOptions, Callback<TransportConfigured>)
uploadToBlob(string, Stream, number)
uploadToBlob(string, Stream, number, ErrorCallback)	A `uploadToBlob` metódus feltölt egy streamet egy blobba.

Örökölt metódusok

abandon(Message)
abandon(Message, Callback<MessageAbandoned>)
addListener<E>(string \| symbol, (args: any[]) => void)	Alias a következőhöz `emitter.on(eventName, listener)`: .
complete(Message)
complete(Message, Callback<MessageCompleted>)
emit<E>(string \| symbol, any[])	Szinkron módon meghívja a `eventName`nevű eseményre regisztrált összes figyelőt, a regisztráció sorrendjében, és átadja a megadott argumentumokat mindegyiknek. `true` ad vissza, ha az esemény figyelői voltak, `false` ellenkező esetben. 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()	Egy tömböt ad vissza, amely felsorolja azokat az eseményeket, amelyekhez az emitter regisztrált figyelőket. `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()	A `EventEmitter` aktuális maximális figyelőértékét adja vissza, amelyet `emitter.setMaxListeners(n)` vagy alapértelmezés szerint `events.defaultMaxListeners`értékre állít be.
getTwin()
getTwin(Callback<Twin>)
listenerCount<E>(string \| symbol, (args: any[]) => void)	A `eventName`nevű eseményt figyelő figyelők számát adja vissza. Ha `listener` van megadva, az visszaadja, hogy hányszor található a figyelő az esemény figyelőinek listájában.
listeners<E>(string \| symbol)	A `eventName`nevű esemény figyelőinek tömbjének másolatát adja vissza. `server.on('connection', (stream) => { console.log('someone connected!'); }); console.log(util.inspect(server.listeners('connection'))); // Prints: [ [Function] ]`
off<E>(string \| symbol, (args: any[]) => void)	Alias a következőhöz `emitter.removeListener()`: .
on<E>(string \| symbol, (args: any[]) => void)	Hozzáadja a `listener` függvényt a `eventName`nevű esemény figyelőtömbjének végéhez. Nem történik ellenőrzés annak ellenőrzésére, hogy a `listener` már hozzáadták-e. A `eventName` és a `listener` azonos kombinációját átadó hívások több alkalommal is hozzáadják és meghívják a `listener`. `server.on('connection', (stream) => { console.log('someone connected!'); });` A `EventEmitter`mutató hivatkozást ad vissza, hogy a hívások láncoltak legyenek. Alapértelmezés szerint az eseményfigyelők a hozzáadásuk sorrendjében lesznek meghívva. A `emitter.prependListener()` metódus alternatívaként használható az eseményfigyelő hozzáadásához a figyelőtömb elejéhez. `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`
once<E>(string \| symbol, (args: any[]) => void)	Hozzáad egy egyszeri`listener` függvényt a `eventName`nevű eseményhez. A következő `eventName` aktiválásakor a figyelő el lesz távolítva, majd meghívódik. `server.once('connection', (stream) => { console.log('Ah, we have our first user!'); });` A `EventEmitter`mutató hivatkozást ad vissza, hogy a hívások láncoltak legyenek. Alapértelmezés szerint az eseményfigyelők a hozzáadásuk sorrendjében lesznek meghívva. A `emitter.prependOnceListener()` metódus alternatívaként használható az eseményfigyelő hozzáadásához a figyelőtömb elejéhez. `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`
open()
open(Callback<Connected>)
prependListener<E>(string \| symbol, (args: any[]) => void)	Hozzáadja a függvényt a nevű esemény figyelőtömbjének . Nem történik ellenőrzés annak ellenőrzésére, hogy a `listener` már hozzáadták-e. A `eventName` és a `listener` azonos kombinációját átadó hívások több alkalommal is hozzáadják és meghívják a `listener`. `server.prependListener('connection', (stream) => { console.log('someone connected!'); });` A `EventEmitter`mutató hivatkozást ad vissza, hogy a hívások láncoltak legyenek.
prependOnceListener<E>(string \| symbol, (args: any[]) => void)	Hozzáad egy egyszeri függvényt a figyelőtömb nevű eseményhez. A következő `eventName` aktiválásakor a figyelő el lesz távolítva, majd meghívódik. `server.prependOnceListener('connection', (stream) => { console.log('Ah, we have our first user!'); });` A `EventEmitter`mutató hivatkozást ad vissza, hogy a hívások láncoltak legyenek.
rawListeners<E>(string \| symbol)	Visszaadja a `eventName`nevű esemény figyelőinek tömbjének másolatát, beleértve a burkolókat is (például az `.once()`által létrehozottakat). 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');
reject(Message)
reject(Message, Callback<MessageRejected>)
removeAllListeners<E>(string \| symbol)	Eltávolítja az összes figyelőt vagy a megadott `eventName`. Helytelen gyakorlat eltávolítani a kód más részeiben hozzáadott figyelőket, különösen akkor, ha a `EventEmitter`-példányt más összetevő vagy modul hozta létre (például szoftvercsatornák vagy fájlstreamek). A `EventEmitter`mutató hivatkozást ad vissza, hogy a hívások láncoltak legyenek.
removeListener<E>(string \| symbol, (args: any[]) => void)	Eltávolítja a megadott `listener` a `eventName`nevű esemény figyelőtömbéből. `const callback = (stream) => { console.log('someone connected!'); }; server.on('connection', callback); // ... server.removeListener('connection', callback);` `removeListener()` legfeljebb egy figyelőpéldányt távolít el a figyelőtömbből. Ha a megadott `eventName`egyetlen figyelőt többször is hozzáadtak a figyelőtömbhöz, akkor az egyes példányok eltávolításához `removeListener()` többször kell meghívni. Ha egy eseményt bocsát ki, a rendszer sorrendben meghívja a kibocsátáskor az ahhoz csatolt összes figyelőt. Ez azt jelenti, hogy `removeListener()removeAllListeners()` a hívások a kibocsátás után, mielőtt az utolsó hallgató befejezi a végrehajtást, nem távolítják el a `emit()` folyamatból. A későbbi események a várt módon viselkednek. 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 Mivel a hallgatókat belső tömbben kezelik, ennek meghívása megváltoztatja bármely hallgató pozícióindexét , amelyet a hallgató eltávolítása után regisztrálnak. Ez nem befolyásolja a figyelők meghívásának sorrendjét, de ez azt jelenti, hogy a figyelőtömbnek az `emitter.listeners()` metódus által visszaadott másolatait újra létre kell hozni. Ha egyetlen függvényt többször adtak hozzá kezelőként egyetlen eseményhez (az alábbi példához hasonlóan), `removeListener()` eltávolítja a legutóbb hozzáadott példányt. A példában a `once('ping')` figyelő el lesz távolítva: `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');` A `EventEmitter`mutató hivatkozást ad vissza, hogy a hívások láncoltak legyenek.
sendEvent(Message)
sendEvent(Message, Callback<MessageEnqueued>)
sendEventBatch(Message[])
sendEventBatch(Message[], Callback<MessageEnqueued>)
setMaxListeners(number)	Alapértelmezés szerint `EventEmitter`s figyelmeztetést jelenít meg, ha egy adott eseményhez több mint `10` figyelő van hozzáadva. Ez egy hasznos alapértelmezett beállítás, amely segít megtalálni a memóriavesztést. A `emitter.setMaxListeners()` metódus lehetővé teszi a korlát módosítását ehhez az adott `EventEmitter` példányhoz. Az érték beállítható `Infinity` (vagy `0`) értékre, hogy korlátlan számú figyelőt jelöljön. A `EventEmitter`mutató hivatkozást ad vissza, hogy a hívások láncoltak legyenek.
setRetryPolicy(RetryPolicy)	Beállítja az ügyfél által az összes művelethez használt újrapróbálkozási szabályzatot. Az alapértelmezett érték ExponentialBackoffWithJitter.
setTransportOptions(any)
setTransportOptions(any, Callback<TransportConfigured>)
updateSharedAccessSignature(string, Callback<SharedAccessSignatureUpdated>)
[captureRejectionSymbol](Error, string \| symbol, any[])	A `Symbol.for('nodejs.rejection')` módszert akkor hívják el, ha ígéretelutasítás történik esemény kibocsátásakor, és `captureRejections` az emitterben engedélyezett. Lehetséges a `events.captureRejectionSymbolSymbol.for('nodejs.rejection')`helyett használni. `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. } }`

Konstruktor adatai

Client(DeviceTransport, string, BlobUploadClient, FileUploadInterface)

new Client(transport: DeviceTransport, connStr?: string, blobUploadClient?: BlobUploadClient, fileUploadApi?: FileUploadInterface)

Paraméterek

transport: DeviceTransport

Olyan objektum, amely egy átviteli objektumtól elvárt interfészt implementálja, például Http.

connStr: string

Kapcsolati sztring (nem kötelező: ha nincs megadva, a SharedAccessSignature jogkivonat közvetlen beállításához meg kell hívni az updateSharedAccessSignature parancsot).

blobUploadClient: BlobUploadClient

Olyan objektum, amely képes streamet feltölteni egy blobba.

fileUploadApi: FileUploadInterface

A Blob Storage-hoz kapcsolódó IoT Hubtal való kommunikációhoz használt objektum.

Metódus adatai

close()

function close(): Promise<Disconnected>

Válaszok

Promise<Disconnected>

close(Callback<Disconnected>)

Bezárja az átviteli kapcsolatot, és megsemmisíti az ügyfélerőforrásokat.

Megjegyzés: A metódus meghívása után az ügyfélobjektum nem használható újra.

function close(closeCallback?: Callback<Disconnected>)

Paraméterek

closeCallback: Callback<Disconnected>

Nem kötelező függvény, amely az átvitel leválasztása és az ügyfél bezárása után hívható meg.

fromAuthenticationProvider(AuthenticationProvider, any)

Létrehoz egy IoT Hub-eszközügyfélt a megadott hitelesítési módszerből és a megadott átviteli típus használatával.

static function fromAuthenticationProvider(authenticationProvider: AuthenticationProvider, transportCtor: any): Client

Paraméterek

authenticationProvider: AuthenticationProvider

Az IoT Hub hitelesítési paramétereinek lekéréséhez használt objektum.

transportCtor: any

Az IoT Hubhoz való csatlakozáshoz használt átviteli protokoll.

Válaszok

Client

fromConnectionString(string, any)

Létrehoz egy IoT Hub-eszközügyfélt az adott kapcsolati sztringből a megadott átviteli típus használatával.

static function fromConnectionString(connStr: string, transportCtor: any): Client

Paraméterek

connStr: string

Egy kapcsolati sztring, amely az "eszközcsatlakozás" engedélyeket foglalja magában egy IoT Hubon.

transportCtor: any

Egy szállítókonstruktor.

Válaszok

Client

fromSharedAccessSignature(string, any)

Létrehoz egy IoT Hub-eszközügyfélt a megadott közös hozzáférésű jogosultságkódból az adott átviteli típus használatával.

static function fromSharedAccessSignature(sharedAccessSignature: string, transportCtor: any): Client

Paraméterek

sharedAccessSignature: string

Egy közös hozzáférésű jogosultságkód, amely az "eszközcsatlakozás" engedélyeket foglalja magában egy IoT Hubon.

transportCtor: any

Válaszok

Client

getBlobSharedAccessSignature(string)

function getBlobSharedAccessSignature(blobName: string): Promise<UploadParams>

Paraméterek

blobName: string

Válaszok

Promise<UploadParams>

getBlobSharedAccessSignature(string, Callback<UploadParams>)

A getBlobSharedAccessSignature lekéri a társított tárfiók SAS-jogkivonatát az IoT Hubról

function getBlobSharedAccessSignature(blobName: string, callback?: Callback<UploadParams>)

Paraméterek

blobName: string

A stream tartalmával létrejövő blobhoz használandó név.

callback: Callback<UploadParams>

Nem kötelező visszahívás, ha a feltöltés befejeződött.

notifyBlobUploadStatus(string, boolean, number, string)

function notifyBlobUploadStatus(correlationId: string, isSuccess: boolean, statusCode: number, statusDescription: string): Promise<void>

Paraméterek

correlationId: string

isSuccess: boolean

statusCode: number

statusDescription: string

Válaszok

Promise<void>

notifyBlobUploadStatus(string, boolean, number, string, ErrorCallback)

A notifyBlobUploadStatus metódus egy blobfeltöltés eredményét küldi el az IoT Hubnak.

function notifyBlobUploadStatus(correlationId: string, isSuccess: boolean, statusCode: number, statusDescription: string, callback?: ErrorCallback)

Paraméterek

correlationId: string

Egy feltöltési állapot adott blobhoz való korrelációjának azonosítója. A getBlobSharedAccessSignaturehívása során jön létre.

isSuccess: boolean

A storage blobművelet eredményének sikeres vagy sikertelen állapota.

statusCode: number

A tárolóblob eredményéhez társított HTTP-állapotkód.

statusDescription: string

A HTTP-állapotkód leírása.

callback: ErrorCallback

Nem kötelező visszahívás, ha a feltöltés befejeződött.

onDeviceMethod(string, (request: DeviceMethodRequest, response: DeviceMethodResponse) => void)

Egy methodNamenevű metódus visszahívását regisztrálja.

function onDeviceMethod(methodName: string, callback: (request: DeviceMethodRequest, response: DeviceMethodResponse) => void)

Paraméterek

methodName: string

A visszahívás által kezelni kívánt metódus neve

callback: (request: DeviceMethodRequest, response: DeviceMethodResponse) => void

A methodName nevű metódusra vonatkozó metóduskérések fogadásakor meghívandó függvény.

setOptions(DeviceClientOptions)

function setOptions(options: DeviceClientOptions): Promise<TransportConfigured>

Paraméterek

options: DeviceClientOptions

Válaszok

Promise<TransportConfigured>

setOptions(DeviceClientOptions, Callback<TransportConfigured>)

function setOptions(options: DeviceClientOptions, done: Callback<TransportConfigured>)

Paraméterek

options: DeviceClientOptions

done: Callback<TransportConfigured>

uploadToBlob(string, Stream, number)

function uploadToBlob(blobName: string, stream: Stream, streamLength: number): Promise<void>

Paraméterek

blobName: string

stream: Stream

streamLength: number

Válaszok

Promise<void>

uploadToBlob(string, Stream, number, ErrorCallback)

A uploadToBlob metódus feltölt egy streamet egy blobba.

function uploadToBlob(blobName: string, stream: Stream, streamLength: number, callback: ErrorCallback)

Paraméterek

blobName: string

A stream tartalmával létrejövő blobhoz használandó név.

stream: Stream

Az ehhez kapcsolódó adatokat fel kell tölteni a blobba.

streamLength: number

A blobba feltöltendő adatok mérete.

callback: ErrorCallback

Örökölt metódus részletei

abandon(Message)

function abandon(message: Message): Promise<MessageAbandoned>

Paraméterek

message: Message

Válaszok

Promise<MessageAbandoned>

InternalClient.abandon örökölte

abandon(Message, Callback<MessageAbandoned>)

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

Paraméterek

message: Message

abandonCallback: Callback<MessageAbandoned>

InternalClient.abandon örökölte

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

Alias a következőhöz emitter.on(eventName, listener): .

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

Paraméterek

eventName: string | symbol

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

Válaszok

Client

InternalClient.addListener örökölte

complete(Message)

function complete(message: Message): Promise<MessageCompleted>

Paraméterek

message: Message

Válaszok

Promise<MessageCompleted>

InternalClient.complete örökölte

complete(Message, Callback<MessageCompleted>)

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

Paraméterek

message: Message

completeCallback: Callback<MessageCompleted>

InternalClient.complete örökölte

emit<E>(string | symbol, any[])

Szinkron módon meghívja a eventNamenevű eseményre regisztrált összes figyelőt, a regisztráció sorrendjében, és átadja a megadott argumentumokat mindegyiknek.

true ad vissza, ha az esemény figyelői voltak, false ellenkező esetben.

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

Paraméterek

eventName: string | symbol

args: any[]

Válaszok

boolean

InternalClient.emit örökölte

eventNames()

Egy tömböt ad vissza, amely felsorolja azokat az eseményeket, amelyekhez az emitter regisztrált figyelőket.

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

Válaszok

(string | symbol)[]

InternalClient.eventNames örökölte

getMaxListeners()

A EventEmitter aktuális maximális figyelőértékét adja vissza, amelyet emitter.setMaxListeners(n) vagy alapértelmezés szerint events.defaultMaxListenersértékre állít be.

function getMaxListeners(): number

Válaszok

number

InternalClient.getMaxListeners örökölte

getTwin()

function getTwin(): Promise<Twin>

Válaszok

Promise<Twin>

InternalClient.getTwin örökölte

getTwin(Callback<Twin>)

function getTwin(done: Callback<Twin>)

Paraméterek

done: Callback<Twin>

InternalClient.getTwin örökölte

listenerCount<E>(string | symbol, (args: any[]) => void)

A eventNamenevű eseményt figyelő figyelők számát adja vissza. Ha listener van megadva, az visszaadja, hogy hányszor található a figyelő az esemény figyelőinek listájában.

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

Paraméterek

eventName: string | symbol

A figyelt esemény neve

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

Az eseménykezelő függvény

Válaszok

number

InternalClient.listenerCount örökölte

listeners<E>(string | symbol)

A eventNamenevű esemény figyelőinek tömbjének másolatát adja vissza.

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

Paraméterek

eventName: string | symbol

Válaszok

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

InternalClient.listeners örökölte

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

Alias a következőhöz emitter.removeListener(): .

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

Paraméterek

eventName: string | symbol

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

Válaszok

Client

InternalClient.off örökölte

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

Hozzáadja a listener függvényt a eventNamenevű esemény figyelőtömbjének végéhez. Nem történik ellenőrzés annak ellenőrzésére, hogy a listener már hozzáadták-e. A eventName és a listener azonos kombinációját átadó hívások több alkalommal is hozzáadják és meghívják a listener.

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

A EventEmittermutató hivatkozást ad vissza, hogy a hívások láncoltak legyenek.

Alapértelmezés szerint az eseményfigyelők a hozzáadásuk sorrendjében lesznek meghívva. A emitter.prependListener() metódus alternatívaként használható az eseményfigyelő hozzáadásához a figyelőtömb elejéhez.

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): Client

Paraméterek

eventName: string | symbol

Az esemény neve.

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

A visszahívási függvény

Válaszok

Client

InternalClient.on örökölte

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

Hozzáad egy egyszerilistener függvényt a eventNamenevű eseményhez. A következő eventName aktiválásakor a figyelő el lesz távolítva, majd meghívódik.

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

A EventEmittermutató hivatkozást ad vissza, hogy a hívások láncoltak legyenek.

Alapértelmezés szerint az eseményfigyelők a hozzáadásuk sorrendjében lesznek meghívva. A emitter.prependOnceListener() metódus alternatívaként használható az eseményfigyelő hozzáadásához a figyelőtömb elejéhez.

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): Client

Paraméterek

eventName: string | symbol

Az esemény neve.

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

A visszahívási függvény

Válaszok

Client

InternalClient.once örökölte

open()

function open(): Promise<Connected>

Válaszok

Promise<Connected>

InternalClient.open örökölte

open(Callback<Connected>)

function open(openCallback: Callback<Connected>)

Paraméterek

openCallback: Callback<Connected>

InternalClient.open örökölte

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

Hozzáadja a függvényt a nevű esemény figyelőtömbjének . Nem történik ellenőrzés annak ellenőrzésére, hogy a listener már hozzáadták-e. A eventName és a listener azonos kombinációját átadó hívások több alkalommal is hozzáadják és meghívják a listener.

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

A EventEmittermutató hivatkozást ad vissza, hogy a hívások láncoltak legyenek.

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

Paraméterek

eventName: string | symbol

Az esemény neve.

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

A visszahívási függvény

Válaszok

Client

InternalClient.prependListener örökölte

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

Hozzáad egy egyszeri függvényt a figyelőtömb nevű eseményhez. A következő eventName aktiválásakor a figyelő el lesz távolítva, majd meghívódik.

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

A EventEmittermutató hivatkozást ad vissza, hogy a hívások láncoltak legyenek.

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

Paraméterek

eventName: string | symbol

Az esemény neve.

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

A visszahívási függvény

Válaszok

Client

InternalClient.prependOnceListener örökölte

rawListeners<E>(string | symbol)

Visszaadja a eventNamenevű esemény figyelőinek tömbjének másolatát, beleértve a burkolókat is (például az .once()által létrehozottakat).

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

Paraméterek

eventName: string | symbol

Válaszok

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

InternalClient.rawListeners örökölte

reject(Message)

function reject(message: Message): Promise<MessageRejected>

Paraméterek

message: Message

Válaszok

Promise<MessageRejected>

InternalClient.reject örökölte

reject(Message, Callback<MessageRejected>)

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

Paraméterek

message: Message

rejectCallback: Callback<MessageRejected>

InternalClient.reject örökölte

removeAllListeners<E>(string | symbol)

Eltávolítja az összes figyelőt vagy a megadott eventName.

Helytelen gyakorlat eltávolítani a kód más részeiben hozzáadott figyelőket, különösen akkor, ha a EventEmitter-példányt más összetevő vagy modul hozta létre (például szoftvercsatornák vagy fájlstreamek).

A EventEmittermutató hivatkozást ad vissza, hogy a hívások láncoltak legyenek.

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

Paraméterek

eventName: string | symbol

Válaszok

Client

InternalClient.removeAllListeners örökölte

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

Eltávolítja a megadott listener a eventNamenevű esemény figyelőtömbéből.

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

removeListener() legfeljebb egy figyelőpéldányt távolít el a figyelőtömbből. Ha a megadott eventNameegyetlen figyelőt többször is hozzáadtak a figyelőtömbhöz, akkor az egyes példányok eltávolításához removeListener() többször kell meghívni.

Ha egy eseményt bocsát ki, a rendszer sorrendben meghívja a kibocsátáskor az ahhoz csatolt összes figyelőt. Ez azt jelenti, hogy removeListener()removeAllListeners() a hívások a kibocsátás után, mielőtt az utolsó hallgató befejezi a végrehajtást, nem távolítják el a emit() folyamatból. A későbbi események a várt módon viselkednek.

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

Mivel a hallgatókat belső tömbben kezelik, ennek meghívása megváltoztatja bármely hallgató pozícióindexét , amelyet a hallgató eltávolítása után regisztrálnak. Ez nem befolyásolja a figyelők meghívásának sorrendjét, de ez azt jelenti, hogy a figyelőtömbnek az emitter.listeners() metódus által visszaadott másolatait újra létre kell hozni.

Ha egyetlen függvényt többször adtak hozzá kezelőként egyetlen eseményhez (az alábbi példához hasonlóan), removeListener() eltávolítja a legutóbb hozzáadott példányt. A példában a once('ping') figyelő el lesz távolítva:

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');

A EventEmittermutató hivatkozást ad vissza, hogy a hívások láncoltak legyenek.

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

Paraméterek

eventName: string | symbol

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

Válaszok

Client

InternalClient.removeListener örökölte

sendEvent(Message)

function sendEvent(message: Message): Promise<MessageEnqueued>

Paraméterek

message: Message

Válaszok

Promise<MessageEnqueued>

InternalClient.sendEvent örökölte

sendEvent(Message, Callback<MessageEnqueued>)

function sendEvent(message: Message, sendEventCallback: Callback<MessageEnqueued>)

Paraméterek

message: Message

sendEventCallback: Callback<MessageEnqueued>

InternalClient.sendEvent örökölte

sendEventBatch(Message[])

function sendEventBatch(messages: Message[]): Promise<MessageEnqueued>

Paraméterek

messages: Message[]

Válaszok

Promise<MessageEnqueued>

InternalClient.sendEventBatch örökölte

sendEventBatch(Message[], Callback<MessageEnqueued>)

function sendEventBatch(messages: Message[], sendEventBatchCallback: Callback<MessageEnqueued>)

Paraméterek

messages: Message[]

sendEventBatchCallback: Callback<MessageEnqueued>

InternalClient.sendEventBatch örökölte

setMaxListeners(number)

Alapértelmezés szerint EventEmitters figyelmeztetést jelenít meg, ha egy adott eseményhez több mint 10 figyelő van hozzáadva. Ez egy hasznos alapértelmezett beállítás, amely segít megtalálni a memóriavesztést. A emitter.setMaxListeners() metódus lehetővé teszi a korlát módosítását ehhez az adott EventEmitter példányhoz. Az érték beállítható Infinity (vagy 0) értékre, hogy korlátlan számú figyelőt jelöljön.

A EventEmittermutató hivatkozást ad vissza, hogy a hívások láncoltak legyenek.

function setMaxListeners(n: number): Client

Paraméterek

n: number

Válaszok

Client

InternalClient.setMaxListeners örökölte

setRetryPolicy(RetryPolicy)

Beállítja az ügyfél által az összes művelethez használt újrapróbálkozási szabályzatot. Az alapértelmezett érték ExponentialBackoffWithJitter.

function setRetryPolicy(policy: RetryPolicy)

Paraméterek

policy: RetryPolicy

{RetryPolicy} Az újrapróbálkozási szabályzat, amelyet minden jövőbeli művelethez használni kell.

InternalClient.setRetryPolicy örökölte

setTransportOptions(any)

function setTransportOptions(options: any): Promise<TransportConfigured>

Paraméterek

options: any

Válaszok

Promise<TransportConfigured>

InternalClient.setTransportOptions örökölte

setTransportOptions(any, Callback<TransportConfigured>)

function setTransportOptions(options: any, done: Callback<TransportConfigured>)

Paraméterek

options: any

done: Callback<TransportConfigured>

InternalClient.setTransportOptions örökölte

updateSharedAccessSignature(string, Callback<SharedAccessSignatureUpdated>)

function updateSharedAccessSignature(sharedAccessSignature: string, updateSasCallback?: Callback<SharedAccessSignatureUpdated>)

Paraméterek

sharedAccessSignature: string

updateSasCallback: Callback<SharedAccessSignatureUpdated>

InternalClient.updateSharedAccessSignature örökölte

[captureRejectionSymbol](Error, string | symbol, any[])

A Symbol.for('nodejs.rejection') módszert akkor hívják el, ha ígéretelutasítás történik esemény kibocsátásakor, és captureRejections az emitterben engedélyezett. Lehetséges a events.captureRejectionSymbolSymbol.for('nodejs.rejection')helyett használni.

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

Paraméterek

error: Error

event: string | symbol

args: any[]

Örökölt InternalClient.__@captureRejectionSymbol@127

Megosztás a következőn keresztül:

Client class

Konstruktorok

Metódusok

Örökölt metódusok

Konstruktor adatai

Client(DeviceTransport, string, BlobUploadClient, FileUploadInterface)

Paraméterek

Metódus adatai

close()

Válaszok

close(Callback<Disconnected>)

Paraméterek

fromAuthenticationProvider(AuthenticationProvider, any)

Paraméterek

Válaszok

fromConnectionString(string, any)

Paraméterek

Válaszok

fromSharedAccessSignature(string, any)

Paraméterek

Válaszok

getBlobSharedAccessSignature(string)

Paraméterek

Válaszok

getBlobSharedAccessSignature(string, Callback<UploadParams>)

Paraméterek

notifyBlobUploadStatus(string, boolean, number, string)

Paraméterek

Válaszok

notifyBlobUploadStatus(string, boolean, number, string, ErrorCallback)

Paraméterek

onDeviceMethod(string, (request: DeviceMethodRequest, response: DeviceMethodResponse) => void)

Paraméterek

setOptions(DeviceClientOptions)

Paraméterek

Válaszok

setOptions(DeviceClientOptions, Callback<TransportConfigured>)

Paraméterek

uploadToBlob(string, Stream, number)

Paraméterek

Válaszok

uploadToBlob(string, Stream, number, ErrorCallback)

Paraméterek

Örökölt metódus részletei

abandon(Message)

Paraméterek

Válaszok

abandon(Message, Callback<MessageAbandoned>)

Paraméterek

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

Paraméterek

Válaszok

complete(Message)

Paraméterek

Válaszok

complete(Message, Callback<MessageCompleted>)

Paraméterek

emit<E>(string | symbol, any[])

Paraméterek

Válaszok

eventNames()

Válaszok

getMaxListeners()

Válaszok

getTwin()

Válaszok

getTwin(Callback<Twin>)

Paraméterek

listenerCount<E>(string | symbol, (args: any[]) => void)

Paraméterek

Válaszok

listeners<E>(string | symbol)

Paraméterek

Válaszok

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

Paraméterek

Válaszok

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

Paraméterek