IotEdgeAuthenticationProvider class
Belirteç oluşturmayı iotedged olarak devreden bir AuthenticationProvider
uygulama sağlar. Bu uygulama, azure IoT Edge ile modül istemcisi kullanılırken kullanılacaktır.
Bu tür, SharedAccessKeyAuthenticationProvider
öğesini devralır ve yöntemini uygulayarak geçersiz kıldığı belirteç oluşturma bölümü dışında işlevsel olarak bu türle _sign
aynıdır.
- Extends
Devralınan Özellikler
capture |
Değer: boole değeri Tüm yeni |
capture |
Değer: Özel |
default |
Varsayılan olarak, herhangi bir olay için en fazla ayarını yaparken Bu zor bir sınır değildir. Örnek
Komut Gösterilen uyarı ile |
error |
Bu simge yalnızca olayları izlemek Bu simgeyi kullanarak dinleyicinin yüklenmesi, bir |
type |
Yöntemler
get |
Devralınan Yöntemler
add |
Sağlanan İptal sinyallerinde olayı dinlemek Bu API, dinleyicinin çalışmasını engellemeyen olayı Aboneliğinin daha kolay kaldırılabilmesi için tek kullanımlık bir değer döndürür.
|
add |
için |
emit<K>(string | symbol, Any |
adlı olay Olayın dinleyicileri varsa,
|
event |
Vericinin dinleyicileri kaydettiği olayları listeleyen bir dizi döndürür. Dizideki değerler dize veya
|
from |
bir bağlantı dizesi yeni |
get |
|
get |
Bu yöntem aktarımlar tarafından bir nesne biçiminde |
get |
adlı s için için
|
get |
defaultMaxListeners tarafından |
get |
Şu anda ayarlanmış en fazla dinleyici miktarını döndürür. s için için
|
listener |
Verilen
|
listener |
adlı |
listeners<K>(string | symbol) | adlı
|
off<K>(string | symbol, (args: any[]) => void) | için |
on(Event |
Olayları yineleyen ,
|
on<K>(string | symbol, (args: any[]) => void) |
Çağrıların Varsayılan olarak, olay dinleyicileri eklendikleri sırayla çağrılır. yöntemi,
|
once(Event |
Belirtilen olayı yaydığında Bu yöntem kasıtlı olarak geneldir ve özel
Olayın özel işlemesi
,
|
once(_DOMEvent |
|
once<K>(string | symbol, (args: any[]) => void) | adlı
Çağrıların Varsayılan olarak, olay dinleyicileri eklendikleri sırayla çağrılır. yöntemi,
|
prepend |
Çağrıların |
prepend |
adlı olay
Çağrıların |
raw |
adlı
|
remove |
Tüm dinleyicileri veya belirtilen Özellikle örnek başka bir bileşen veya modül (örneğin yuvalar veya dosya akışları) tarafından oluşturulduğunda kodun Çağrıların |
remove |
adlı
Bir olay yayımlandıktan sonra, yayma sırasında ona eklenen tüm dinleyiciler sırayla çağrılır. Bu, yadıktan sonra ve son dinleyici yürütmeyi bitirmeden önce yapılan veya
Dinleyiciler bir iç dizi kullanılarak yönetildiğinden, bunu çağırmak dinleyici kaldırıldıktan sonra kaydedilen dinleyicilerin konum dizinlerini değiştirir. Bu, dinleyicilerin çağrılma sırasını etkilemez, ancak yöntem tarafından Tek bir işlev tek bir olay için birden çok kez işleyici olarak eklendiğinde (aşağıdaki örnekte olduğu gibi),
Çağrıların |
set |
Varsayılan olarak Çağrıların |
set |
|
set |
Bu yöntem, çağıranın kimlik doğrulama yenilemesi için yeni değerler ayarlamasına olanak tanır. Bu işlev zaman uyumlu olarak tamamlanır, ANCAK, eylemlerin zaman uyumsuz olarak gerçekleşmesine neden olur. Sağlayıcı belirteç yenilemeleri yapıyorsa( örneğin, bir ağ bağlantısı yapıldıysa, bu işlevin çağrılmış olması neredeyse anında yeni bir yenilemenin gerçekleşmesine neden olur. Protokole bağlı olarak, bu bağlantının kesilmesine ve yeniden bağlanmasına neden olabilir. Ancak yenilemeler şu anda GERÇEKLEŞMİP gerçekleşmiyorsa, yeni değerleri daha sonra kullanmak üzere kaydetmemiz yeterlidir. |
stop() | SAS belirtecini yenilemek için kullanılan zamanlayıcıyı durdurur. |
[capture |
Devralınan Özellik Detayları
captureRejections
Değer: boole değeri
Tüm yeni EventEmitter
nesnelerde varsayılan captureRejections
seçeneği değiştirin.
static captureRejections: boolean
Özellik Değeri
boolean
SharedAccessKeyAuthenticationProvider.captureRejections'tanDevralındı
captureRejectionSymbol
Değer: Symbol.for('nodejs.rejection')
Özel rejection handler
yazma bölümüne bakın.
static captureRejectionSymbol: typeof captureRejectionSymbol
Özellik Değeri
typeof captureRejectionSymbol
SharedAccessKeyAuthenticationProvider.captureRejectionSymbol'danDevralındı
defaultMaxListeners
Varsayılan olarak, herhangi bir olay için en fazla 10
dinleyici kaydedilebilir. Bu sınır, yöntemi kullanılarak emitter.setMaxListeners(n)
tek tek EventEmitter
örnekler için değiştirilebilir. TümEventEmitter
örneklerin varsayılan değerini events.defaultMaxListeners
değiştirmek için özelliği kullanılabilir. Bu değer pozitif bir sayı değilse, bir RangeError
oluşturulur.
ayarını yaparken events.defaultMaxListeners
dikkatli olun çünkü değişiklik, değişiklik yapılmadan önce oluşturulanlar da dahil olmak üzere tümEventEmitter
örnekleri etkiler. Ancak, çağrısının emitter.setMaxListeners(n)
üzerinde hala önceliği events.defaultMaxListeners
vardır.
Bu zor bir sınır değildir. Örnek EventEmitter
daha fazla dinleyici eklenmesine izin verir ancak stderr'a "olası EventEmitter bellek sızıntısı" algılandığını belirten bir izleme uyarısı verir. Herhangi bir tek EventEmitter
için emitter.getMaxListeners()
ve emitter.setMaxListeners()
yöntemleri, bu uyarıyı geçici olarak önlemek için kullanılabilir:
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));
});
Komut --trace-warnings
satırı bayrağı, bu tür uyarıların yığın izlemesini görüntülemek için kullanılabilir.
Gösterilen uyarı ile process.on('warning')
denetlenebilir ve sırasıyla olay verici örneğine, olayın adına ve count
ekli dinleyici sayısına başvuran ek emitter
, type
ve özelliklerine sahip olur.
Özelliği name
olarak 'MaxListenersExceededWarning'
ayarlanır.
static defaultMaxListeners: number
Özellik Değeri
number
SharedAccessKeyAuthenticationProvider.defaultMaxListeners'danDevralındı
errorMonitor
Bu simge yalnızca olayları izlemek 'error'
için bir dinleyici yüklemek için kullanılacaktır. Bu simge kullanılarak yüklenen dinleyiciler, normal 'error'
dinleyiciler çağrılmadan önce çağrılır.
Bu simgeyi kullanarak dinleyicinin yüklenmesi, bir 'error'
olay yayımlandıktan sonra davranışı değiştirmez. Bu nedenle, normal 'error'
dinleyici yüklü değilse işlem yine de kilitlenir.
static errorMonitor: typeof errorMonitor
Özellik Değeri
typeof errorMonitor
SharedAccessKeyAuthenticationProvider.errorMonitor'danDevralındı
type
type: AuthenticationType
Özellik Değeri
AuthenticationType
Yöntem Ayrıntıları
getTrustBundle((err?: Error, ca?: string) => void)
function getTrustBundle(callback: (err?: Error, ca?: string) => void)
Parametreler
- callback
-
(err?: Error, ca?: string) => void
Devralınan Yöntemin Ayrıntıları
addAbortListener(AbortSignal, (event: Event) => void)
Sağlanan signal
üzerindeki olayı bir kez abort
dinler.
İptal sinyallerinde olayı dinlemek abort
güvenli değildir ve sinyale sahip başka bir üçüncü taraf çağırabileceğinden e.stopImmediatePropagation()
kaynak sızıntılarına yol açabilir. Ne yazık ki Node.js web standardını ihlal edeceğinden bunu değiştiremez. Ayrıca, özgün API dinleyicileri kaldırmayı unutmayı kolaylaştırır.
Bu API, dinleyicinin çalışmasını engellemeyen olayı stopImmediatePropagation
dinleyerek bu iki sorunu çözerek Node.js API'lerinde s'lerin güvenli bir şekilde kullanılmasına AbortSignal
olanak tanır.
Aboneliğinin daha kolay kaldırılabilmesi için tek kullanımlık bir değer döndürür.
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
Parametreler
- signal
-
AbortSignal
- resource
-
(event: Event) => void
Döndürülenler
Disposable
Dinleyiciyi kaldıran atılabilir abort
.
SharedAccessKeyAuthenticationProvider.addAbortListener'danDevralındı
addListener<K>(string | symbol, (args: any[]) => void)
için emitter.on(eventName, listener)
diğer ad.
function addListener<K>(eventName: string | symbol, listener: (args: any[]) => void): IotEdgeAuthenticationProvider
Parametreler
- eventName
-
string | symbol
- listener
-
(args: any[]) => void
Döndürülenler
SharedAccessKeyAuthenticationProvider.addListener'danDevralındı
emit<K>(string | symbol, AnyRest)
adlı olay eventName
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, false
aksi takdirde döndürürtrue
.
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
Parametreler
- eventName
-
string | symbol
- args
-
AnyRest
Döndürülenler
boolean
eventNames()
Vericinin dinleyicileri kaydettiği olayları listeleyen bir dizi döndürür. Dizideki değerler dize veya Symbol
değerlerdir.
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)[]
SharedAccessKeyAuthenticationProvider.eventNames'tenDevralındı
fromConnectionString(string, number, number)
bir bağlantı dizesi yeni SharedAccessKeyAuthenticationProvider
bir oluşturur
static function fromConnectionString(connectionString: string, tokenValidTimeInSeconds?: number, tokenRenewalMarginInSeconds?: number): SharedAccessKeyAuthenticationProvider
Parametreler
- connectionString
-
string
Cihaz bağlantı dizesi IoT hub'ı ile kimlik doğrulaması için gerekli parametreleri içerir.
- tokenValidTimeInSeconds
-
number
[isteğe bağlı] Belirtecin geçerli olması gereken saniye sayısı.
- tokenRenewalMarginInSeconds
-
number
[isteğe bağlı] Belirteci yenilemesi gereken geçerlilik süresinin SharedAccessKeyAuthenticationProvider
bitiminde geçmesi gereken saniye sayısı.
Döndürülenler
SharedAccessKeyAuthenticationProvider.fromConnectionString'denDevralındı
getDeviceCredentials()
function getDeviceCredentials(): Promise<TransportConfig>
Döndürülenler
Promise<TransportConfig>
SharedAccessKeyAuthenticationProvider.getDeviceCredentials'danDevralındı
getDeviceCredentials(Callback<TransportConfig>)
Bu yöntem aktarımlar tarafından bir nesne biçiminde TransportConfig
en güncel cihaz kimlik bilgilerini almak için kullanılır.
function getDeviceCredentials(callback?: Callback<TransportConfig>)
Parametreler
- callback
-
Callback<TransportConfig>
ioT hub'ıyla kimlik doğrulaması yapmak için kullanılabilecek bir hata veya cihaz kimlik bilgileri kümesiyle çağrılacak isteğe bağlı işlev.
SharedAccessKeyAuthenticationProvider.getDeviceCredentials'danDevralındı
getEventListeners(EventEmitter<DefaultEventMap> | _DOMEventTarget, string | symbol)
adlı eventName
olay için dinleyici dizisinin bir kopyasını döndürür.
s için EventEmitter
bu, vericide çağırma .listeners
ile tam olarak aynı şekilde davranır.
için EventTarget
, olay hedefi için olay dinleyicilerini edinmenin tek yolu budur. Bu, hata ayıklama ve tanılama amacıyla kullanışlıdır.
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> | _DOMEventTarget, name: string | symbol): Function[]
Parametreler
- emitter
-
EventEmitter<DefaultEventMap> | _DOMEventTarget
- name
-
string | symbol
Döndürülenler
Function[]
SharedAccessKeyAuthenticationProvider.getEventListeners'danDevralındı
getMaxListeners()
defaultMaxListeners tarafından emitter.setMaxListeners(n)
ayarlanan veya varsayılan olarak ayarlanan geçerli en yüksek dinleyici değerini EventEmitter
döndürür.
function getMaxListeners(): number
Döndürülenler
number
SharedAccessKeyAuthenticationProvider.getMaxListeners'danDevralındı
getMaxListeners(EventEmitter<DefaultEventMap> | _DOMEventTarget)
Şu anda ayarlanmış en fazla dinleyici miktarını döndürür.
s için EventEmitter
bu, vericide çağırma .getMaxListeners
ile tam olarak aynı şekilde davranır.
için EventTarget
bu, olay hedefi için en fazla olay dinleyicilerini edinmenin tek yoludur. Tek bir EventTarget üzerindeki olay işleyicilerinin sayısı maksimum kümeyi aşarsa, EventTarget bir uyarı yazdırır.
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> | _DOMEventTarget): number
Parametreler
- emitter
-
EventEmitter<DefaultEventMap> | _DOMEventTarget
Döndürülenler
number
SharedAccessKeyAuthenticationProvider.getMaxListeners'danDevralındı
listenerCount(EventEmitter<DefaultEventMap>, string | symbol)
Uyarı
Bu API artık kullanım dışıdır.
Since v3.2.0 - Use listenerCount
instead.
Verilen emitter
üzerinde kayıtlı verilen eventName
için dinleyici sayısını döndüren bir sınıf yöntemi.
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
Parametreler
- emitter
-
EventEmitter<DefaultEventMap>
Sorguya yayımlayıcı
- eventName
-
string | symbol
Olay adı
Döndürülenler
number
SharedAccessKeyAuthenticationProvider.listenerCount'danDevralındı
listenerCount<K>(string | symbol, Function)
adlı eventName
olayı dinleyen dinleyici sayısını döndürür.
Sağlanırsa listener
, dinleyicinin olay dinleyicileri listesinde kaç kez bulunduğunu döndürür.
function listenerCount<K>(eventName: string | symbol, listener?: Function): number
Parametreler
- eventName
-
string | symbol
Dinlenen olayın adı
- listener
-
Function
Olay işleyici işlevi
Döndürülenler
number
SharedAccessKeyAuthenticationProvider.listenerCount'danDevralındı
listeners<K>(string | symbol)
adlı eventName
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<K>(eventName: string | symbol): Function[]
Parametreler
- eventName
-
string | symbol
Döndürülenler
Function[]
SharedAccessKeyAuthenticationProvider.listeners'danDevralındı
off<K>(string | symbol, (args: any[]) => void)
için emitter.removeListener()
diğer ad.
function off<K>(eventName: string | symbol, listener: (args: any[]) => void): IotEdgeAuthenticationProvider
Parametreler
- eventName
-
string | symbol
- listener
-
(args: any[]) => void
Döndürülenler
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
Olayları yineleyen eventName
bir AsyncIterator
döndürür. yayarsa EventEmitter
'error'
atar. Döngüden çıkarken tüm dinleyicileri kaldırır. value
Her yineleme tarafından döndürülen, yayılan olay bağımsız değişkenlerinden oluşan bir dizidir.
, AbortSignal
olayları beklemeyi iptal etmek için kullanılabilir:
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>
Parametreler
- emitter
-
EventEmitter<DefaultEventMap>
- eventName
-
string
Dinlenen olayın adı
- options
-
StaticEventEmitterOptions
Döndürülenler
AsyncIterableIterator<any>
AsyncIterator
tarafından yayılan olayları yineleyen eventName
emitter
on<K>(string | symbol, (args: any[]) => void)
listener
adlı eventName
olay için işlevi dinleyiciler dizisinin sonuna ekler. öğesinin zaten eklenip eklenmediğini listener
görmek için denetim yapılmaz. aynı ve birleşimini eventName
listener
geçen birden çok çağrı, birden çok kez eklenmesine ve çağrılmasını listener
sağlar.
server.on('connection', (stream) => {
console.log('someone connected!');
});
Çağrıların EventEmitter
zincirlenebilmesi için öğesine bir başvuru döndürür.
Varsayılan olarak, olay dinleyicileri eklendikleri sırayla çağrılır. yöntemi, emitter.prependListener()
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<K>(eventName: string | symbol, listener: (args: any[]) => void): IotEdgeAuthenticationProvider
Parametreler
- eventName
-
string | symbol
Olayın adı.
- listener
-
(args: any[]) => void
Geri çağırma işlevi
Döndürülenler
once(EventEmitter<DefaultEventMap>, string | symbol, StaticEventEmitterOptions)
Belirtilen olayı yaydığında EventEmitter
yerine getiren veya beklerken yaydığında 'error'
reddedilen EventEmitter
bir Promise
oluşturur.
, Promise
verilen olaya yayılan tüm bağımsız değişkenlerin bir dizisiyle çözülür.
Bu yöntem kasıtlı olarak geneldir ve özel'error'
olay semantiği olmayan ve olayı dinlemeyen 'error'
web platformu EventTarget arabirimiyle çalışır.
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);
}
Olayın özel işlemesi 'error'
yalnızca başka bir olayı beklemek için kullanıldığında kullanılır events.once()
. 'error'
olayının kendisini beklemek için kullanılırsaevents.once()
, özel işleme olmadan başka bir olay türü olarak değerlendirilir:
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
, AbortSignal
olayı beklemeyi iptal etmek için kullanılabilir:
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[]>
Parametreler
- emitter
-
EventEmitter<DefaultEventMap>
- eventName
-
string | symbol
- options
-
StaticEventEmitterOptions
Döndürülenler
Promise<any[]>
once(_DOMEventTarget, string, StaticEventEmitterOptions)
static function once(emitter: _DOMEventTarget, eventName: string, options?: StaticEventEmitterOptions): Promise<any[]>
Parametreler
- emitter
-
_DOMEventTarget
- eventName
-
string
- options
-
StaticEventEmitterOptions
Döndürülenler
Promise<any[]>
once<K>(string | symbol, (args: any[]) => void)
adlı eventName
olay için tek seferliklistener
bir işlev ekler. Bir sonraki tetiklendiğinde eventName
, bu dinleyici kaldırılır ve sonra çağrılır.
server.once('connection', (stream) => {
console.log('Ah, we have our first user!');
});
Çağrıların EventEmitter
zincirlenebilmesi için öğesine bir başvuru döndürür.
Varsayılan olarak, olay dinleyicileri eklendikleri sırayla çağrılır. yöntemi, emitter.prependOnceListener()
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<K>(eventName: string | symbol, listener: (args: any[]) => void): IotEdgeAuthenticationProvider
Parametreler
- eventName
-
string | symbol
Olayın adı.
- listener
-
(args: any[]) => void
Geri çağırma işlevi
Döndürülenler
prependListener<K>(string | symbol, (args: any[]) => void)
listener
adlı eventName
olay için işlevi dinleyiciler dizisinin başına ekler. öğesinin zaten eklenip eklenmediğini listener
görmek için denetim yapılmaz. aynı ve birleşimini eventName
listener
geçen birden çok çağrı, birden çok kez eklenmesine ve çağrılmasını listener
sağlar.
server.prependListener('connection', (stream) => {
console.log('someone connected!');
});
Çağrıların EventEmitter
zincirlenebilmesi için öğesine bir başvuru döndürür.
function prependListener<K>(eventName: string | symbol, listener: (args: any[]) => void): IotEdgeAuthenticationProvider
Parametreler
- eventName
-
string | symbol
Olayın adı.
- listener
-
(args: any[]) => void
Geri çağırma işlevi
Döndürülenler
SharedAccessKeyAuthenticationProvider.prependListener'danDevralındı
prependOnceListener<K>(string | symbol, (args: any[]) => void)
adlı olay eventName
için dinleyiciler dizisinin başınatek seferliklistener
bir işlev ekler. Bir sonraki tetiklendiğinde eventName
, bu dinleyici kaldırılır ve ardından çağrılır.
server.prependOnceListener('connection', (stream) => {
console.log('Ah, we have our first user!');
});
Çağrıların EventEmitter
zincirlenebilmesi için öğesine bir başvuru döndürür.
function prependOnceListener<K>(eventName: string | symbol, listener: (args: any[]) => void): IotEdgeAuthenticationProvider
Parametreler
- eventName
-
string | symbol
Olayın adı.
- listener
-
(args: any[]) => void
Geri çağırma işlevi
Döndürülenler
SharedAccessKeyAuthenticationProvider.prependOnceListener'danDevralındı
rawListeners<K>(string | symbol)
adlı eventName
olay için dinleyici dizisinin, sarmalayıcılar da dahil olmak üzere bir kopyasını döndürür (örneğin, tarafından .once()
oluşturulanlar).
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[]
Parametreler
- eventName
-
string | symbol
Döndürülenler
Function[]
SharedAccessKeyAuthenticationProvider.rawListeners'danDevralındı
removeAllListeners(string | symbol)
Tüm dinleyicileri veya belirtilen eventName
dinleyicileri kaldırır.
Özellikle örnek başka bir bileşen veya modül (örneğin yuvalar veya dosya akışları) tarafından oluşturulduğunda kodun EventEmitter
başka bir yerine eklenen dinleyicileri kaldırmak kötü bir uygulamadır.
Çağrıların EventEmitter
zincirlenebilmesi için öğesine bir başvuru döndürür.
function removeAllListeners(eventName?: string | symbol): IotEdgeAuthenticationProvider
Parametreler
- eventName
-
string | symbol
Döndürülenler
SharedAccessKeyAuthenticationProvider.removeAllListeners'danDevralındı
removeListener<K>(string | symbol, (args: any[]) => void)
adlı eventName
olay için dinleyici dizisinden belirtilen listener
öğesini kaldırır.
const callback = (stream) => {
console.log('someone connected!');
};
server.on('connection', callback);
// ...
server.removeListener('connection', callback);
removeListener()
en fazla bir dinleyici örneğini dinleyici dizisinden kaldırır. Belirtilen eventName
removeListener()
için dinleyici dizisine birden çok kez tek bir dinleyici eklendiyse, her örneği kaldırmak için 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, yadıktan sonra ve son dinleyici yürütmeyi bitirmeden önce yapılan veya removeListener()
removeAllListeners()
çağrılarının devam edendenemit()
kaldırılmayacağını gösterir. 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 bir iç dizi kullanılarak yönetildiğinden, bunu çağırmak dinleyici kaldırıldıktan sonra kaydedilen dinleyicilerin konum dizinlerini değiştirir. Bu, dinleyicilerin çağrılma sırasını etkilemez, ancak yöntem tarafından emitter.listeners()
döndürülen dinleyici dizisinin tüm 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')
dinleyici 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 EventEmitter
zincirlenebilmesi için öğesine bir başvuru döndürür.
function removeListener<K>(eventName: string | symbol, listener: (args: any[]) => void): IotEdgeAuthenticationProvider
Parametreler
- eventName
-
string | symbol
- listener
-
(args: any[]) => void
Döndürülenler
SharedAccessKeyAuthenticationProvider.removeListener'danDevralındı
setMaxListeners(number)
Varsayılan olarak EventEmitter
, belirli bir olay için birden fazla 10
dinleyici eklenirse s bir uyarı yazdırır. Bu, bellek sızıntılarını bulmaya yardımcı olan kullanışlı bir varsayılan değerdir. yöntemi, emitter.setMaxListeners()
sınırın bu belirli EventEmitter
örnek için değiştirilmesini sağlar. Sınırsız sayıda dinleyiciyi belirtmek için değer (veya 0
) olarak ayarlanabilir Infinity
.
Çağrıların EventEmitter
zincirlenebilmesi için öğesine bir başvuru döndürür.
function setMaxListeners(n: number): IotEdgeAuthenticationProvider
Parametreler
- n
-
number
Döndürülenler
SharedAccessKeyAuthenticationProvider.setMaxListeners'danDevralındı
setMaxListeners(number, (EventEmitter<DefaultEventMap> | _DOMEventTarget)[])
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> | _DOMEventTarget)[])
Parametreler
- n
-
number
Negatif olmayan bir sayı. Olay başına EventTarget
en fazla dinleyici sayısı.
- eventTargets
-
(EventEmitter<DefaultEventMap> | _DOMEventTarget)[]
SharedAccessKeyAuthenticationProvider.setMaxListeners'danDevralındı
setTokenRenewalValues(number, number)
Bu yöntem, çağıranın kimlik doğrulama yenilemesi için yeni değerler ayarlamasına olanak tanır.
Bu işlev zaman uyumlu olarak tamamlanır, ANCAK, eylemlerin zaman uyumsuz olarak gerçekleşmesine neden olur. Sağlayıcı belirteç yenilemeleri yapıyorsa( örneğin, bir ağ bağlantısı yapıldıysa, bu işlevin çağrılmış olması neredeyse anında yeni bir yenilemenin gerçekleşmesine neden olur. Protokole bağlı olarak, bu bağlantının kesilmesine ve yeniden bağlanmasına neden olabilir. Ancak yenilemeler şu anda GERÇEKLEŞMİP gerçekleşmiyorsa, yeni değerleri daha sonra kullanmak üzere kaydetmemiz yeterlidir.
function setTokenRenewalValues(tokenValidTimeInSeconds: number, tokenRenewalMarginInSeconds: number)
Parametreler
- tokenValidTimeInSeconds
-
number
Belirtecin geçerli olması gereken saniye sayısı.
- tokenRenewalMarginInSeconds
-
number
Belirteci yenilemesi gereken geçerlilik süresinin SharedAccessKeyAuthenticationProvider
bitiminde geçmesi gereken saniye sayısı.
SharedAccessKeyAuthenticationProvider.setTokenRenewalValuesÖğesinden Devralındı
stop()
SAS belirtecini yenilemek için kullanılan zamanlayıcıyı durdurur.
function stop()
[captureRejectionSymbol]<K>(Error, string | symbol, AnyRest)
function [captureRejectionSymbol]<K>(error: Error, event: string | symbol, args: AnyRest)
Parametreler
- error
-
Error
- event
-
string | symbol
- args
-
AnyRest
SharedAccessKeyAuthenticationProvider'dan Devralındı.[ captureRejectionSymbol]