Listener | spread-the-word

Hierarchy

EventEmitter
- Listener

Constructors

constructor

new Listener(server: Server, options?: ListenerOptions): Listener

- Defined in src/Listener.ts:40
Parameters
- server: Server
- options: ListenerOptions = {}
Returns Listener

Properties

remoteServices

remoteServices: RemoteService[] = []

requeryDelay

requeryDelay: Timer

server

server: Server

typeName

typeName: string

wildcard

wildcard: boolean

Static Readonly captureRejectionSymbol

captureRejectionSymbol: typeof captureRejectionSymbol

Static captureRejections

captureRejections: boolean

Sets or gets the default captureRejection value for all emitters.

Static defaultMaxListeners

defaultMaxListeners: number

Static Readonly errorMonitor

errorMonitor: typeof errorMonitor

This symbol shall be used to install a listener for only monitoring 'error' events. Listeners installed using this symbol are called before the regular 'error' listeners are called.

Installing a listener using this symbol does not change the behavior once an 'error' event is emitted, therefore the process will still crash if no regular 'error' listener is installed.

Methods

addListener

addListener(event: string | symbol, listener: (...args: any[]) => void): Listener

- Defined in node_modules/@types/node/events.d.ts:57
Parameters
- event: string | symbol
- listener: (...args: any[]) => void
  - - (...args: any[]): void
    - Parameters
      - Rest ...args: any[]
      Returns void
Returns Listener

addRemoteService

addRemoteService(record: SRV, txtRecord: TXT, addressRecords: AddressRecord[], res: Response, referrer: Referrer): void

- Defined in src/Listener.ts:116
Parameters
- record: SRV
- txtRecord: TXT
- addressRecords: AddressRecord[]
- res: Response
- referrer: Referrer
Returns void

destroy

destroy(): void

- Defined in src/Listener.ts:110
Returns void

emit

emit(event: string | symbol, ...args: any[]): boolean

- Defined in node_modules/@types/node/events.d.ts:67
Parameters
- event: string | symbol
- Rest ...args: any[]
Returns boolean

eventNames

eventNames(): (string | symbol)[]

- Defined in node_modules/@types/node/events.d.ts:72
Returns (string | symbol)[]

getMaxListeners

getMaxListeners(): number

- Defined in node_modules/@types/node/events.d.ts:64
Returns number

listen

listen(): Promise<void>

- Defined in src/Listener.ts:57
Returns Promise<void>

listenerCount

listenerCount(event: string | symbol): number

- Defined in node_modules/@types/node/events.d.ts:68
Parameters
- event: string | symbol
Returns number

listeners

listeners(event: string | symbol): Function[]

- Defined in node_modules/@types/node/events.d.ts:65
Parameters
- event: string | symbol
Returns Function[]

off

off(event: string | symbol, listener: (...args: any[]) => void): Listener

- Defined in node_modules/@types/node/events.d.ts:61
Parameters
- event: string | symbol
- listener: (...args: any[]) => void
  - - (...args: any[]): void
    - Parameters
      - Rest ...args: any[]
      Returns void
Returns Listener

on

on(event: "up", callback: (remoteService: RemoteService, response: Response, referrer: Referrer) => void): Listener
on(event: "down", callback: (remoteService: RemoteService, response: Response, referrer: Referrer) => void): Listener
on(event: "destroy", callback: () => void): Listener

- Defined in src/Listener.ts:25
Parameters
- event: "up"
- callback: (remoteService: RemoteService, response: Response, referrer: Referrer) => void
  - - (remoteService: RemoteService, response: Response, referrer: Referrer): void
    - Parameters
      - remoteService: RemoteService
      - response: Response
      - referrer: Referrer
      Returns void
Returns Listener
- Defined in src/Listener.ts:26
Parameters
- event: "down"
- callback: (remoteService: RemoteService, response: Response, referrer: Referrer) => void
  - - (remoteService: RemoteService, response: Response, referrer: Referrer): void
    - Parameters
      - remoteService: RemoteService
      - response: Response
      - referrer: Referrer
      Returns void
Returns Listener
- Defined in src/Listener.ts:27
Parameters
- event: "destroy"
- callback: () => void
  - - (): void
    - Returns void
Returns Listener

onResponse

onResponse(res: Response, referrer: Referrer): Promise<void>

- Defined in src/Listener.ts:81
Parameters
- res: Response
- referrer: Referrer
Returns Promise<void>

once

once(event: "up", callback: (remoteService: RemoteService, response: Response, referrer: Referrer) => void): Listener
once(event: "down", callback: (remoteService: RemoteService, response: Response, referrer: Referrer) => void): Listener
once(event: "destroy", callback: () => void): Listener

- Defined in src/Listener.ts:28
Parameters
- event: "up"
- callback: (remoteService: RemoteService, response: Response, referrer: Referrer) => void
  - - (remoteService: RemoteService, response: Response, referrer: Referrer): void
    - Parameters
      - remoteService: RemoteService
      - response: Response
      - referrer: Referrer
      Returns void
Returns Listener
- Defined in src/Listener.ts:29
Parameters
- event: "down"
- callback: (remoteService: RemoteService, response: Response, referrer: Referrer) => void
  - - (remoteService: RemoteService, response: Response, referrer: Referrer): void
    - Parameters
      - remoteService: RemoteService
      - response: Response
      - referrer: Referrer
      Returns void
Returns Listener
- Defined in src/Listener.ts:30
Parameters
- event: "destroy"
- callback: () => void
  - - (): void
    - Returns void
Returns Listener

prependListener

prependListener(event: string | symbol, listener: (...args: any[]) => void): Listener

- Defined in node_modules/@types/node/events.d.ts:70
Parameters
- event: string | symbol
- listener: (...args: any[]) => void
  - - (...args: any[]): void
    - Parameters
      - Rest ...args: any[]
      Returns void
Returns Listener

prependOnceListener

prependOnceListener(event: string | symbol, listener: (...args: any[]) => void): Listener

- Defined in node_modules/@types/node/events.d.ts:71
Parameters
- event: string | symbol
- listener: (...args: any[]) => void
  - - (...args: any[]): void
    - Parameters
      - Rest ...args: any[]
      Returns void
Returns Listener

query

query(): Promise<void>

- Defined in src/Listener.ts:63
Returns Promise<void>

queryUnresolvedRecords

queryUnresolvedRecords(): Promise<void>

- Defined in src/Listener.ts:134
Returns Promise<void>

rawListeners

rawListeners(event: string | symbol): Function[]

- Defined in node_modules/@types/node/events.d.ts:66
Parameters
- event: string | symbol
Returns Function[]

removeAllListeners

removeAllListeners(event?: string | symbol): Listener

- Defined in node_modules/@types/node/events.d.ts:62
Parameters
- Optional event: string | symbol
Returns Listener

removeListener

removeListener(event: string | symbol, listener: (...args: any[]) => void): Listener

- Defined in node_modules/@types/node/events.d.ts:60
Parameters
- event: string | symbol
- listener: (...args: any[]) => void
  - - (...args: any[]): void
    - Parameters
      - Rest ...args: any[]
      Returns void
Returns Listener

removeRemoteService

removeRemoteService(name: string, res: Response, referrer: Referrer): void

- Defined in src/Listener.ts:124
Parameters
- name: string
- res: Response
- referrer: Referrer
Returns void

requery

requery(delay?: number): Promise<void>

- Defined in src/Listener.ts:74
Parameters
- delay: number = 1000
Returns Promise<void>

setMaxListeners

setMaxListeners(n: number): Listener

- Defined in node_modules/@types/node/events.d.ts:63
Parameters
- n: number
Returns Listener

Static listenerCount

listenerCount(emitter: EventEmitter, event: string | symbol): number

- Defined in node_modules/@types/node/events.d.ts:26
deprecated
since v4.0.0

Parameters
- emitter: EventEmitter
- event: string | symbol
Returns number

Static on

on(emitter: EventEmitter, event: string): AsyncIterableIterator<any>

- Defined in node_modules/@types/node/events.d.ts:23
Parameters
- emitter: EventEmitter
- event: string
Returns AsyncIterableIterator<any>

Static once

once(emitter: NodeEventTarget, event: string | symbol): Promise<any[]>
once(emitter: DOMEventTarget, event: string): Promise<any[]>

- Defined in node_modules/@types/node/events.d.ts:21
Parameters
- emitter: NodeEventTarget
- event: string | symbol
Returns Promise<any[]>
- Defined in node_modules/@types/node/events.d.ts:22
Parameters
- emitter: DOMEventTarget
- event: string
Returns Promise<any[]>

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

server: Server

options: ListenerOptions = {}

Returns Listener

Properties

remoteServices

requeryDelay

server

typeName

wildcard

Static Readonly captureRejectionSymbol

Static captureRejections

Static defaultMaxListeners

Static Readonly errorMonitor

Methods

addListener

Parameters

event: string | symbol

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

Parameters

Rest ...args: any[]

Returns void

Returns Listener

addRemoteService

Parameters

record: SRV

txtRecord: TXT

addressRecords: AddressRecord[]

res: Response

referrer: Referrer

Returns void

destroy

Returns void

emit

Parameters

event: string | symbol

Rest ...args: any[]

Returns boolean

eventNames

Returns (string | symbol)[]

getMaxListeners

Returns number

listen

Returns Promise<void>

listenerCount

Parameters

event: string | symbol

Returns number

listeners

Parameters

event: string | symbol

Returns Function[]

off

Parameters

event: string | symbol

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

Parameters

Rest ...args: any[]

Returns void

Returns Listener

on

Parameters

event: "up"

callback: (remoteService: RemoteService, response: Response, referrer: Referrer) => void

Parameters

remoteService: RemoteService

response: Response

referrer: Referrer

Returns void

Returns Listener

Parameters

event: "down"

callback: (remoteService: RemoteService, response: Response, referrer: Referrer) => void