Class: CallHomeListener<E>
Defined in: netconf/src/call-home.ts:197
Listening for call home. Read the clients with for await (leaving the loop closes the listener), or next(). close() and await using stop listening, abort calls being set up, close clients not yet taken and end iteration; clients already taken are yours to close.
Extends
TypedEmitter<CallHomeEvents>
Type Parameters
E
E extends readonly Extension[] = readonly Extension[]
Implements
AsyncIterableIterator<CallHomeCall<E>>AsyncDisposable
Accessors
addresses
Get Signature
get addresses(): object;Defined in: netconf/src/call-home.ts:222
Where the listener is bound, per transport.
Returns
ssh?
readonly ssh?: CallHomeRemote;The SSH listening address, when listening for SSH.
tls?
readonly tls?: CallHomeRemote;The TLS listening address, when listening for TLS.
closed
Get Signature
get closed(): boolean;Defined in: netconf/src/call-home.ts:237
True once close() has been called.
Returns
boolean
pendingCalls
Get Signature
get pendingCalls(): number;Defined in: netconf/src/call-home.ts:242
Calls being set up right now.
Returns
number
Methods
[asyncDispose]()
[asyncDispose](): Promise<void>;Defined in: netconf/src/call-home.ts:292
Close the listener, for await using.
Returns
Promise<void>
Implementation of
AsyncDisposable.[asyncDispose]
[asyncIterator]()
[asyncIterator](): this;Defined in: netconf/src/call-home.ts:287
Iterate over the calls with for await; leaving the loop closes the listener.
Returns
this
Implementation of
AsyncIterableIterator.[asyncIterator]
close()
close(): Promise<void>;Defined in: netconf/src/call-home.ts:297
Stop listening, abort calls being set up, close clients not yet taken, end iteration. Idempotent.
Returns
Promise<void>
dispatch()
protected dispatch<K>(event, payload): void;Defined in: netconf/src/messages/emitter.ts:51
Call every listener for event with payload, in the order they were added. For subclasses; a listener that throws is logged and skipped.
Type Parameters
K
K extends keyof CallHomeEvents
Parameters
event
K
payload
Returns
void
Inherited from
TypedEmitter.dispatch
listenerCount()
listenerCount<K>(event): number;Defined in: netconf/src/messages/emitter.ts:43
How many listeners event has.
Type Parameters
K
K extends keyof CallHomeEvents
Parameters
event
K
Returns
number
Inherited from
TypedEmitter.listenerCount
next()
next(): Promise<IteratorResult<CallHomeCall<E>, any>>;Defined in: netconf/src/call-home.ts:273
The next ready call, waiting for one if none is queued; done once the listener is closed.
Returns
Promise<IteratorResult<CallHomeCall<E>, any>>
Implementation of
AsyncIterableIterator.next
off()
off<K>(event, listener): void;Defined in: netconf/src/messages/emitter.ts:38
Remove a listener added with on(). Removing one that isn't there does nothing.
Type Parameters
K
K extends keyof CallHomeEvents
Parameters
event
K
listener
Listener<CallHomeEvents[K]>
Returns
void
Inherited from
TypedEmitter.off
on()
on<K>(event, listener): () => void;Defined in: netconf/src/messages/emitter.ts:18
Add a listener. Returns a function that removes it.
Type Parameters
K
K extends keyof CallHomeEvents
Parameters
event
K
listener
Listener<CallHomeEvents[K]>
Returns
() => void
Inherited from
TypedEmitter.on
once()
once<K>(event, listener): () => void;Defined in: netconf/src/messages/emitter.ts:29
Add a listener that runs at most once. Returns a function that removes it.
Type Parameters
K
K extends keyof CallHomeEvents
Parameters
event
K
listener
Listener<CallHomeEvents[K]>
Returns
() => void
Inherited from
TypedEmitter.once
return()
return(): Promise<IteratorResult<CallHomeCall<E>, any>>;Defined in: netconf/src/call-home.ts:281
Stop reading: closes the listener.
Returns
Promise<IteratorResult<CallHomeCall<E>, any>>
Implementation of
AsyncIterableIterator.return