Client class

Paket:: azure-iot-device

Bir cihazı Azure IoT hub'ına bağlamak için kullanılan IoT Hub cihaz istemcisi.

SDK kullanıcıları, IoT Hub cihaz istemcisi oluşturmak içinConnectionString veyaSharedAccessSignature'dan fabrika yöntemlerinden birini çağırmalıdır.

Extends: InternalClient

Oluşturucular

Client(DeviceTransport, string, BlobUploadClient, FileUploadInterface)

Yöntemler

close()
close(Callback<Disconnected>)	Aktarım bağlantısını kapatır ve istemci kaynaklarını yok eder. Not: Bu yöntem çağrıldıktan sonra İstemci nesnesi yeniden kullanılamaz.
fromAuthenticationProvider(AuthenticationProvider, any)	Verilen kimlik doğrulama yönteminden ve verilen aktarım türünü kullanarak bir IoT Hub cihaz istemcisi oluşturur.
fromConnectionString(string, any)	Verilen aktarım türünü kullanarak verilen bağlantı dizesinden bir IoT Hub cihaz istemcisi oluşturur.
fromSharedAccessSignature(string, any)	Verilen aktarım türünü kullanarak verilen paylaşılan erişim imzasından bir IoT Hub cihaz istemcisi oluşturur.
getBlobSharedAccessSignature(string)
getBlobSharedAccessSignature(string, Callback<UploadParams>)	`getBlobSharedAccessSignature` Bağlı depolama hesabı SAS Belirtecini IoT Hub'dan alır
notifyBlobUploadStatus(string, boolean, number, string)
notifyBlobUploadStatus(string, boolean, number, string, ErrorCallback)	`notifyBlobUploadStatus` yöntemi IoT Hub'a blob karşıya yükleme işleminin sonucunu gönderir.
onDeviceMethod(string, (request: DeviceMethodRequest, response: DeviceMethodResponse) => void)	`methodName`adlı bir yöntem için geri çağırma kaydeder.
setOptions(DeviceClientOptions)
setOptions(DeviceClientOptions, Callback<TransportConfigured>)
uploadToBlob(string, Stream, number)
uploadToBlob(string, Stream, number, ErrorCallback)	`uploadToBlob` yöntemi bir akışı bloba yükler.

Devralınan Yöntemler

abandon(Message)
abandon(Message, Callback<MessageAbandoned>)
addListener<E>(string \| symbol, (args: any[]) => void)	`emitter.on(eventName, listener)`için diğer ad.
complete(Message)
complete(Message, Callback<MessageCompleted>)
emit<E>(string \| symbol, any[])	`eventName`adlı olay için kaydedilen dinleyicilerin her birini, kaydedildikleri sırayla zaman uyumlu olarak çağırır ve sağlanan bağımsız değişkenleri her birine geçirir. Olayın dinleyicileri varsa `true` döndürür, aksi takdirde `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()	Vericinin dinleyicileri kaydettiği olayları listeleyen bir dizi döndürür. `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` veya varsayılan olarak `emitter.setMaxListeners(n)`olarak ayarlanan `events.defaultMaxListeners` için geçerli en yüksek dinleyici değerini döndürür.
getTwin()
getTwin(Callback<Twin>)
listenerCount<E>(string \| symbol, (args: any[]) => void)	`eventName`adlı olayı dinleyen dinleyici sayısını döndürür. `listener` sağlanırsa, dinleyicinin olay dinleyicileri listesinde kaç kez bulunduğunu döndürür.
listeners<E>(string \| symbol)	`eventName`adlı olay için dinleyici dizisinin bir kopyasını döndürür. `server.on('connection', (stream) => { console.log('someone connected!'); }); console.log(util.inspect(server.listeners('connection'))); // Prints: [ [Function] ]`
off<E>(string \| symbol, (args: any[]) => void)	`emitter.removeListener()`için diğer ad.
on<E>(string \| symbol, (args: any[]) => void)	`listener` işlevini `eventName`adlı olay için dinleyiciler dizisinin sonuna ekler. `listener` eklenip eklenmediğini görmek için denetim yapılmaz. aynı `eventName` ve `listener` birleşimini geçen birden çok çağrı, `listener` birden çok kez eklenmesine ve çağrılmasını sağlar. `server.on('connection', (stream) => { console.log('someone connected!'); });` Çağrıların zincirlenebilmesi için `EventEmitter`bir başvuru döndürür. Varsayılan olarak, olay dinleyicileri eklendikleri sırayla çağrılır. `emitter.prependListener()` yöntemi, olay dinleyicisini dinleyici dizisinin başına eklemek için alternatif olarak kullanılabilir. `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)	adlı olay için tek seferlik bir `listenereventName` işlevi ekler. `eventName` bir sonraki tetiklendiğinde, bu dinleyici kaldırılır ve çağrılır. `server.once('connection', (stream) => { console.log('Ah, we have our first user!'); });` Çağrıların zincirlenebilmesi için `EventEmitter`bir başvuru döndürür. Varsayılan olarak, olay dinleyicileri eklendikleri sırayla çağrılır. `emitter.prependOnceListener()` yöntemi, olay dinleyicisini dinleyici dizisinin başına eklemek için alternatif olarak kullanılabilir. `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)	işlevini, adlı olay için dinleyiciler dizisinin başlayan ekler. `listener` eklenip eklenmediğini görmek için denetim yapılmaz. aynı `eventName` ve `listener` birleşimini geçen birden çok çağrı, `listener` birden çok kez eklenmesine ve çağrılmasını sağlar. `server.prependListener('connection', (stream) => { console.log('someone connected!'); });` Çağrıların zincirlenebilmesi için `EventEmitter`bir başvuru döndürür.
prependOnceListener<E>(string \| symbol, (args: any[]) => void)	dinleyiciler dizisinin başlayan adlı olay için tek seferlik bir işlevi ekler. `eventName` bir sonraki tetiklendiğinde, bu dinleyici kaldırılır ve sonra çağrılır. `server.prependOnceListener('connection', (stream) => { console.log('Ah, we have our first user!'); });` Çağrıların zincirlenebilmesi için `EventEmitter`bir başvuru döndürür.
rawListeners<E>(string \| symbol)	tüm sarmalayıcılar (`eventName`tarafından oluşturulanlar gibi) dahil olmak üzere `.once()`adlı olay için dinleyici dizisinin bir kopyasını döndürür. 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)	Tüm dinleyicileri veya belirtilen `eventName`olanları kaldırır. Özellikle `EventEmitter` örneği başka bir bileşen veya modül (örneğin yuvalar veya dosya akışları) tarafından oluşturulduğunda kodun başka bir yerine eklenen dinleyicileri kaldırmak kötü bir uygulamadır. Çağrıların zincirlenebilmesi için `EventEmitter`bir başvuru döndürür.
removeListener<E>(string \| symbol, (args: any[]) => void)	`listener`adlı olay için dinleyici dizisinden belirtilen `eventName` kaldırır. `const callback = (stream) => { console.log('someone connected!'); }; server.on('connection', callback); // ... server.removeListener('connection', callback);` `removeListener()` dinleyici dizisinden en fazla bir dinleyici örneğini kaldırır. Belirtilen `eventName`için dinleyici dizisine birden çok kez tek bir dinleyici eklendiyse, her örneği kaldırmak için `removeListener()` birden çok kez çağrılmalıdır. Bir olay yayımlandıktan sonra, yayma sırasında ona eklenen tüm dinleyiciler sırayla çağrılır. Bu, `removeListener()` herhangi bir `removeAllListeners()` yayınlandıktan sonra ve son dinleyici uygulamayı bitirmeden önce devam eden döngüden kaldırılmayacağı `emit()` anlamına gelir. Sonraki olaylar beklendiği gibi davranır. 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 Dinleyiciler dahili bir diziyle yönetildiği için, bunu çağırmak, dinleyici çıkarıldıktan sonra kayıtlı herhangi bir dinleyicinin konum indekslerini değiştirir. Bu, dinleyicilerin çağrılma sırasını etkilemez, ancak `emitter.listeners()` yöntemi tarafından döndürülen dinleyici dizisi kopyalarının yeniden oluşturulması gerektiği anlamına gelir. Tek bir işlev tek bir olay için birden çok kez işleyici olarak eklendiğinde (aşağıdaki örnekte olduğu gibi), `removeListener()` en son eklenen örneği kaldırır. Örnekte `once('ping')` dinleyicisi kaldırılır: `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ğrıların zincirlenebilmesi için `EventEmitter`bir başvuru döndürür.
sendEvent(Message)
sendEvent(Message, Callback<MessageEnqueued>)
sendEventBatch(Message[])
sendEventBatch(Message[], Callback<MessageEnqueued>)
setMaxListeners(number)	Varsayılan olarak, belirli bir olay için `EventEmitter`'den fazla dinleyici eklenirse `10`bir uyarı yazdırır. Bu, bellek sızıntılarını bulmaya yardımcı olan kullanışlı bir varsayılan değerdir. `emitter.setMaxListeners()` yöntemi, sınırın bu belirli `EventEmitter` örneği için değiştirilmesini sağlar. Değer, sınırsız sayıda dinleyiciyi göstermek için `Infinity` (veya `0`) olarak ayarlanabilir. Çağrıların zincirlenebilmesi için `EventEmitter`bir başvuru döndürür.
setRetryPolicy(RetryPolicy)	İstemci tarafından tüm işlemlerde kullanılan yeniden deneme ilkesini ayarlar. Varsayılan değer ExponentialBackoffWithJitter'dir.
setTransportOptions(any)
setTransportOptions(any, Callback<TransportConfigured>)
updateSharedAccessSignature(string, Callback<SharedAccessSignatureUpdated>)
[captureRejectionSymbol](Error, string \| symbol, any[])	Yöntem, `Symbol.for('nodejs.rejection')` bir olay yayıldığında söz reddedilmesi durumunda çağrılır ve `captureRejections` yayıcıda etkinleştirilir. `events.captureRejectionSymbol` `Symbol.for('nodejs.rejection')`Yerine kullanılmak mümkündür. `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. } }`

Oluşturucu Ayrıntıları

Client(DeviceTransport, string, BlobUploadClient, FileUploadInterface)

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

Parametreler

transport: DeviceTransport

Httpgibi bir aktarım nesnesi beklenen arabirimini uygulayan nesne.

connStr: string

Bir bağlantı dizesi (isteğe bağlı: sağlanmadığında, SharedAccessSignature belirtecini doğrudan ayarlamak için updateSharedAccessSignature çağrılmalıdır).

blobUploadClient: BlobUploadClient

Bloba akış yükleyebilen bir nesne.

fileUploadApi: FileUploadInterface

Blob Depolama ile ilgili eylemler için IoT Hub ile iletişim kurmak için kullanılan nesne.

Yöntem Ayrıntıları

close()

function close(): Promise<Disconnected>

Döndürülenler

Promise<Disconnected>

close(Callback<Disconnected>)

Aktarım bağlantısını kapatır ve istemci kaynaklarını yok eder.

Not: Bu yöntem çağrıldıktan sonra İstemci nesnesi yeniden kullanılamaz.

function close(closeCallback?: Callback<Disconnected>)

Parametreler

closeCallback: Callback<Disconnected>

Aktarım bağlantısı kesildiğinde ve istemci kapatıldıktan sonra çağrılacak isteğe bağlı işlev.

fromAuthenticationProvider(AuthenticationProvider, any)

Verilen kimlik doğrulama yönteminden ve verilen aktarım türünü kullanarak bir IoT Hub cihaz istemcisi oluşturur.

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

Parametreler

authenticationProvider: AuthenticationProvider

IoT hub'ına yönelik kimlik doğrulama parametrelerini almak için kullanılan nesne.

transportCtor: any

IoT hub'ına bağlanmak için kullanılan aktarım protokolü.

Döndürülenler

Client

fromConnectionString(string, any)

Verilen aktarım türünü kullanarak verilen bağlantı dizesinden bir IoT Hub cihaz istemcisi oluşturur.

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

Parametreler

connStr: string

IoT hub'ındaki "cihaz bağlantısı" izinlerini kapsülleyen bağlantı dizesi.

transportCtor: any

Bir taşıma oluşturucu.

Döndürülenler

Client

fromSharedAccessSignature(string, any)

Verilen aktarım türünü kullanarak verilen paylaşılan erişim imzasından bir IoT Hub cihaz istemcisi oluşturur.

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

Parametreler

sharedAccessSignature: string

IoT hub'ındaki "cihaz bağlantısı" izinlerini kapsülleyen paylaşılan erişim imzası.

transportCtor: any

Döndürülenler

Client

getBlobSharedAccessSignature(string)

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

Parametreler

blobName: string

Döndürülenler

Promise<UploadParams>

getBlobSharedAccessSignature(string, Callback<UploadParams>)

getBlobSharedAccessSignature Bağlı depolama hesabı SAS Belirtecini IoT Hub'dan alır

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

Parametreler

blobName: string

Akışın içeriğiyle oluşturulacak blob için kullanılacak ad.

callback: Callback<UploadParams>

Karşıya yükleme tamamlandığında çağrı yapmak için isteğe bağlı geri arama.

notifyBlobUploadStatus(string, boolean, number, string)

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

Parametreler

correlationId: string

isSuccess: boolean

statusCode: number

statusDescription: string

Döndürülenler

Promise<void>

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

notifyBlobUploadStatus yöntemi IoT Hub'a blob karşıya yükleme işleminin sonucunu gönderir.

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

Parametreler

correlationId: string

Karşıya yükleme durumunu belirli bir blobla ilişkilendirmek için bir kimlik. getBlobSharedAccessSignatureçağrısı sırasında oluşturulur.

isSuccess: boolean

Depolama blobu işlem sonucundaki başarı veya başarısızlık durumu.

statusCode: number

Depolama blobu sonucuyla ilişkili HTTP durum kodu.

statusDescription: string

HTTP durum kodunun açıklaması.

callback: ErrorCallback

Karşıya yükleme tamamlandığında çağrı yapmak için isteğe bağlı geri arama.

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

methodNameadlı bir yöntem için geri çağırma kaydeder.

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

Parametreler

methodName: string

Geri çağırma tarafından işlenecek yöntemin adı

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

methodName adlı yöntem için bir yöntem isteği alındığında çağrılacak işlev.

setOptions(DeviceClientOptions)

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

Parametreler

options: DeviceClientOptions

Döndürülenler

Promise<TransportConfigured>

setOptions(DeviceClientOptions, Callback<TransportConfigured>)

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

Parametreler

options: DeviceClientOptions

done: Callback<TransportConfigured>

uploadToBlob(string, Stream, number)

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

Parametreler

blobName: string

stream: Stream

streamLength: number

Döndürülenler

Promise<void>

uploadToBlob(string, Stream, number, ErrorCallback)

uploadToBlob yöntemi bir akışı bloba yükler.

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

Parametreler

blobName: string

Akışın içeriğiyle oluşturulacak blob için kullanılacak ad.

stream: Stream

Buna ilişkin veriler bloba yüklenmelidir.

streamLength: number

Bloba yüklenecek verilerin boyutu.

callback: ErrorCallback

Devralınan Yöntemin Ayrıntıları

abandon(Message)

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

Parametreler

message: Message

Döndürülenler

Promise<MessageAbandoned>

InternalClient.abandon Devralındı

abandon(Message, Callback<MessageAbandoned>)

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

Parametreler

message: Message

abandonCallback: Callback<MessageAbandoned>

InternalClient.abandon Devralındı

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

emitter.on(eventName, listener)için diğer ad.

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

Parametreler

eventName: string | symbol

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

Döndürülenler

Client

InternalClient.addListener'dan Devralınan

complete(Message)

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

Parametreler

message: Message

Döndürülenler

Promise<MessageCompleted>

InternalClient.complete Devralındı

complete(Message, Callback<MessageCompleted>)

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

Parametreler

message: Message

completeCallback: Callback<MessageCompleted>

InternalClient.complete Devralındı

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

eventNameadlı olay için kaydedilen dinleyicilerin her birini, kaydedildikleri sırayla zaman uyumlu olarak çağırır ve sağlanan bağımsız değişkenleri her birine geçirir.

Olayın dinleyicileri varsa true döndürür, aksi takdirde 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<E>(eventName: string | symbol, args: any[]): boolean

Parametreler

eventName: string | symbol

args: any[]

Döndürülenler

boolean

InternalClient.emit'den Devralınmış

eventNames()

Vericinin dinleyicileri kaydettiği olayları listeleyen bir dizi döndürür.

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

Döndürülenler

(string | symbol)[]

InternalClient.eventNames'ten Devralınan

getMaxListeners()

EventEmitter veya varsayılan olarak emitter.setMaxListeners(n)olarak ayarlanan events.defaultMaxListeners için geçerli en yüksek dinleyici değerini döndürür.

function getMaxListeners(): number

Döndürülenler

number

InternalClient.getMaxListeners'dan Devralınan

getTwin()

function getTwin(): Promise<Twin>

Döndürülenler

Promise<Twin>

InternalClient.getTwin'den Devralınan

getTwin(Callback<Twin>)

function getTwin(done: Callback<Twin>)

Parametreler

done: Callback<Twin>

InternalClient.getTwin'den Devralınan

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

eventNameadlı olayı dinleyen dinleyici sayısını döndürür. listener sağlanırsa, dinleyicinin olay dinleyicileri listesinde kaç kez bulunduğunu döndürür.

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

Parametreler

eventName: string | symbol

Dinlenen olayın adı

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

Olay işleyici işlevi

Döndürülenler

number

InternalClient.listenerCount'dan Devralınan

listeners<E>(string | symbol)

eventNameadlı olay için dinleyici dizisinin bir kopyasını döndürür.

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

Parametreler

eventName: string | symbol

Döndürülenler

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

InternalClient.listeners'dan Devralınan

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

emitter.removeListener()için diğer ad.

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

Parametreler

eventName: string | symbol

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

Döndürülenler

Client

InternalClient.off'tan Devralınmış

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

listener işlevini eventNameadlı olay için dinleyiciler dizisinin sonuna ekler. listener eklenip eklenmediğini görmek için denetim yapılmaz. aynı eventName ve listener birleşimini geçen birden çok çağrı, listener birden çok kez eklenmesine ve çağrılmasını sağlar.

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

Çağrıların zincirlenebilmesi için EventEmitterbir başvuru döndürür.

Varsayılan olarak, olay dinleyicileri eklendikleri sırayla çağrılır. emitter.prependListener() yöntemi, olay dinleyicisini dinleyici dizisinin başına eklemek için alternatif olarak kullanılabilir.

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

Parametreler

eventName: string | symbol

Olayın adı.

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

Geri çağırma işlevi

Döndürülenler

Client

InternalClient.on'dan Devralındı

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

adlı olay için tek seferlik bir listenereventName işlevi ekler. eventName bir sonraki tetiklendiğinde, bu dinleyici kaldırılır ve çağrılır.

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

Çağrıların zincirlenebilmesi için EventEmitterbir başvuru döndürür.

Varsayılan olarak, olay dinleyicileri eklendikleri sırayla çağrılır. emitter.prependOnceListener() yöntemi, olay dinleyicisini dinleyici dizisinin başına eklemek için alternatif olarak kullanılabilir.

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

Parametreler

eventName: string | symbol

Olayın adı.

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

Geri çağırma işlevi

Döndürülenler

Client

InternalClient.once Devralındı

open()

function open(): Promise<Connected>

Döndürülenler

Promise<Connected>

InternalClient.open Devralındı

open(Callback<Connected>)

function open(openCallback: Callback<Connected>)

Parametreler

openCallback: Callback<Connected>

InternalClient.open Devralındı

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

işlevini, adlı olay için dinleyiciler dizisinin başlayan ekler. listener eklenip eklenmediğini görmek için denetim yapılmaz. aynı eventName ve listener birleşimini geçen birden çok çağrı, listener birden çok kez eklenmesine ve çağrılmasını sağlar.

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

Çağrıların zincirlenebilmesi için EventEmitterbir başvuru döndürür.

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

Parametreler

eventName: string | symbol

Olayın adı.

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

Geri çağırma işlevi

Döndürülenler

Client

InternalClient.prependListener'dan Devralınan

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

dinleyiciler dizisinin başlayan adlı olay için tek seferlik bir işlevi ekler. eventName bir sonraki tetiklendiğinde, bu dinleyici kaldırılır ve sonra çağrılır.

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

Çağrıların zincirlenebilmesi için EventEmitterbir başvuru döndürür.

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

Parametreler

eventName: string | symbol

Olayın adı.

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

Geri çağırma işlevi

Döndürülenler

Client

InternalClient.prependOnceListener'dan Devralınan

rawListeners<E>(string | symbol)

tüm sarmalayıcılar (eventNametarafından oluşturulanlar gibi) dahil olmak üzere .once()adlı olay için dinleyici dizisinin bir kopyasını döndürür.

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

Parametreler

eventName: string | symbol

Döndürülenler

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

InternalClient.rawListeners'dan Devralınan

reject(Message)

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

Parametreler

message: Message

Döndürülenler

Promise<MessageRejected>

InternalClient.reject Devralındı

reject(Message, Callback<MessageRejected>)

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

Parametreler

message: Message

rejectCallback: Callback<MessageRejected>

InternalClient.reject Devralındı

removeAllListeners<E>(string | symbol)

Tüm dinleyicileri veya belirtilen eventNameolanları kaldırır.

Özellikle EventEmitter örneği başka bir bileşen veya modül (örneğin yuvalar veya dosya akışları) tarafından oluşturulduğunda kodun başka bir yerine eklenen dinleyicileri kaldırmak kötü bir uygulamadır.

Çağrıların zincirlenebilmesi için EventEmitterbir başvuru döndürür.

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

Parametreler

eventName: string | symbol

Döndürülenler

Client

InternalClient.removeAllListeners Devralındı

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

listeneradlı olay için dinleyici dizisinden belirtilen eventName kaldırır.

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

removeListener() dinleyici dizisinden en fazla bir dinleyici örneğini kaldırır. Belirtilen eventNameiçin dinleyici dizisine birden çok kez tek bir dinleyici eklendiyse, her örneği kaldırmak için removeListener() birden çok kez çağrılmalıdır.

Bir olay yayımlandıktan sonra, yayma sırasında ona eklenen tüm dinleyiciler sırayla çağrılır. Bu, removeListener() herhangi bir removeAllListeners() yayınlandıktan sonra ve son dinleyici uygulamayı bitirmeden önce devam eden döngüden kaldırılmayacağı emit() anlamına gelir. Sonraki olaylar beklendiği gibi davranır.

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

Dinleyiciler dahili bir diziyle yönetildiği için, bunu çağırmak, dinleyici çıkarıldıktan sonra kayıtlı herhangi bir dinleyicinin konum indekslerini değiştirir. Bu, dinleyicilerin çağrılma sırasını etkilemez, ancak emitter.listeners() yöntemi tarafından döndürülen dinleyici dizisi kopyalarının yeniden oluşturulması gerektiği anlamına gelir.

Tek bir işlev tek bir olay için birden çok kez işleyici olarak eklendiğinde (aşağıdaki örnekte olduğu gibi), removeListener() en son eklenen örneği kaldırır. Örnekte once('ping') dinleyicisi kaldırılır:

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ğrıların zincirlenebilmesi için EventEmitterbir başvuru döndürür.

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

Parametreler

eventName: string | symbol

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

Döndürülenler

Client

InternalClient.removeListener Devralındı

sendEvent(Message)

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

Parametreler

message: Message

Döndürülenler

Promise<MessageEnqueued>

InternalClient.sendEvent'ten Devralınan

sendEvent(Message, Callback<MessageEnqueued>)

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

Parametreler

message: Message

sendEventCallback: Callback<MessageEnqueued>

InternalClient.sendEvent'ten Devralınan

sendEventBatch(Message[])

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

Parametreler

messages: Message[]

Döndürülenler

Promise<MessageEnqueued>

InternalClient.sendEventBatch Devralındı

sendEventBatch(Message[], Callback<MessageEnqueued>)

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

Parametreler

messages: Message[]

sendEventBatchCallback: Callback<MessageEnqueued>

InternalClient.sendEventBatch Devralındı

setMaxListeners(number)

Varsayılan olarak, belirli bir olay için EventEmitter'den fazla dinleyici eklenirse 10bir uyarı yazdırır. Bu, bellek sızıntılarını bulmaya yardımcı olan kullanışlı bir varsayılan değerdir. emitter.setMaxListeners() yöntemi, sınırın bu belirli EventEmitter örneği için değiştirilmesini sağlar. Değer, sınırsız sayıda dinleyiciyi göstermek için Infinity (veya 0) olarak ayarlanabilir.

Çağrıların zincirlenebilmesi için EventEmitterbir başvuru döndürür.

function setMaxListeners(n: number): Client

Parametreler

n: number

Döndürülenler

Client

InternalClient.setMaxListeners Devralındı

setRetryPolicy(RetryPolicy)

İstemci tarafından tüm işlemlerde kullanılan yeniden deneme ilkesini ayarlar. Varsayılan değer ExponentialBackoffWithJitter'dir.

function setRetryPolicy(policy: RetryPolicy)

Parametreler

policy: RetryPolicy

{RetryPolicy} Gelecekteki tüm işlemler için kullanılması gereken yeniden deneme ilkesi.

InternalClient.setRetryPolicy'den Devralınan

setTransportOptions(any)

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

Parametreler

options: any

Döndürülenler

Promise<TransportConfigured>

InternalClient.setTransportOptions Devralındı

setTransportOptions(any, Callback<TransportConfigured>)

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

Parametreler

options: any

done: Callback<TransportConfigured>

InternalClient.setTransportOptions Devralındı

updateSharedAccessSignature(string, Callback<SharedAccessSignatureUpdated>)

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

Parametreler

sharedAccessSignature: string

updateSasCallback: Callback<SharedAccessSignatureUpdated>

InternalClient.updateSharedAccessSignature'dan Devralınan

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

Yöntem, Symbol.for('nodejs.rejection') bir olay yayıldığında söz reddedilmesi durumunda çağrılır ve captureRejections yayıcıda etkinleştirilir. events.captureRejectionSymbol Symbol.for('nodejs.rejection')Yerine kullanılmak mümkündür.

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

Parametreler

error: Error

event: string | symbol

args: any[]

Miras Olarak InternalClient.__@captureRejectionSymbol@129

Aracılığıyla paylaş

Client class

Oluşturucular

Yöntemler

Devralınan Yöntemler

Oluşturucu Ayrıntıları

Client(DeviceTransport, string, BlobUploadClient, FileUploadInterface)

Parametreler

Yöntem Ayrıntıları

close()

Döndürülenler

close(Callback<Disconnected>)

Parametreler

fromAuthenticationProvider(AuthenticationProvider, any)

Parametreler

Döndürülenler

fromConnectionString(string, any)

Parametreler

Döndürülenler

fromSharedAccessSignature(string, any)

Parametreler

Döndürülenler

getBlobSharedAccessSignature(string)

Parametreler

Döndürülenler

getBlobSharedAccessSignature(string, Callback<UploadParams>)

Parametreler

notifyBlobUploadStatus(string, boolean, number, string)

Parametreler

Döndürülenler

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

Parametreler

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

Parametreler

setOptions(DeviceClientOptions)

Parametreler

Döndürülenler

setOptions(DeviceClientOptions, Callback<TransportConfigured>)

Parametreler

uploadToBlob(string, Stream, number)

Parametreler

Döndürülenler

uploadToBlob(string, Stream, number, ErrorCallback)

Parametreler

Devralınan Yöntemin Ayrıntıları

abandon(Message)

Parametreler

Döndürülenler

abandon(Message, Callback<MessageAbandoned>)

Parametreler

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

Parametreler

Döndürülenler

complete(Message)

Parametreler

Döndürülenler

complete(Message, Callback<MessageCompleted>)

Parametreler

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

Parametreler

Döndürülenler

eventNames()

Döndürülenler

getMaxListeners()

Döndürülenler

getTwin()

Döndürülenler

getTwin(Callback<Twin>)

Parametreler

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

Parametreler

Döndürülenler

listeners<E>(string | symbol)

Parametreler

Döndürülenler

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

Parametreler

Döndürülenler

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

Parametreler