Class MDNS

Hierarchy

StartStop
- MDNS

Constructors

constructor

new MDNS(__namedParameters?): MDNS
Parameters
- __namedParameters: {
  getNetworkInterfaces?: (() => NetworkInterfaces | PromiseLike<NetworkInterfaces>);
  logger?: Logger;
  } = {}
  - Optional getNetworkInterfaces?: (() => NetworkInterfaces | PromiseLike<NetworkInterfaces>)
    - (): NetworkInterfaces | PromiseLike<NetworkInterfaces>
      
      Returns NetworkInterfaces | PromiseLike<NetworkInterfaces>
  - Optional logger?: Logger
Returns MDNS
Inherited from startStop.StartStop.constructor
- Defined in src/MDNS.ts:85

Properties

`Readonly` [initLock]

[initLock]: RWLockWriter

`Protected` _groups

_groups: Host[]

`Protected` _hostname

_hostname: Hostname

`Protected` _id

_id: number = 0

`Protected` _localServices

_localServices: Map<FQDN, Service> = ...

`Protected` _networkServices

_networkServices: Map<FQDN, Service> = ...

`Protected` _port

_port: Port

`Protected` _unicast

_unicast: boolean = false

`Protected` advertisements

advertisements: Map<string, PromiseCancellable<void>> = ...

`Protected` getNetworkInterfaces

getNetworkInterfaces: (() => NetworkInterfaces | PromiseLike<NetworkInterfaces>)

Type declaration

- (): NetworkInterfaces | PromiseLike<NetworkInterfaces>
- Returns NetworkInterfaces | PromiseLike<NetworkInterfaces>

`Protected` localRecordCache

localRecordCache: ResourceRecordCache

`Protected` localRecordCacheDirty

localRecordCacheDirty: boolean = true

`Protected` logger

logger: Logger

`Protected` networkRecordCache

networkRecordCache: ResourceRecordCache

`Protected` queries

queries: Map<string, PromiseCancellable<void>> = ...

`Protected` runningTasks

runningTasks: Set<PromiseCancellable<void>> = ...

Represents the advertisements and queries that have been cancelled and are in the process of stopping

`Protected` socketHostTable

socketHostTable: Table<SocketHostRow> = ...

`Protected` socketMap

socketMap: WeakMap<Socket, SocketInfo> = ...

`Protected` sockets

sockets: Socket[] = []

Accessors

[eventHandled]

get [eventHandled](): ReadonlyWeakSet<Event>
Returns ReadonlyWeakSet<Event>
Inherited from startStop.StartStop.[eventHandled]
- Defined in node_modules/@matrixai/events/dist/Evented.d.ts:7

[eventHandlers]

get [eventHandlers](): ReadonlyMap<string, Set<EventHandlerInfo>>
Returns ReadonlyMap<string, Set<EventHandlerInfo>>
Inherited from startStop.StartStop.[eventHandlers]
- Defined in node_modules/@matrixai/events/dist/Evented.d.ts:6

[eventTarget]

get [eventTarget](): EventTarget
Returns EventTarget
Inherited from startStop.StartStop.[eventTarget]
- Defined in node_modules/@matrixai/events/dist/Evented.d.ts:5

[handleEventError]

get [handleEventError](): ((evt) => void)
Returns ((evt) => void)
- - (evt): void
  - Parameters
    - evt: EventError
    Returns void
Inherited from startStop.StartStop.[handleEventError]
- Defined in node_modules/@matrixai/events/dist/Evented.d.ts:8

[running]

get [running](): boolean
Returns boolean
Inherited from startStop.StartStop.[running]
- Defined in node_modules/@matrixai/async-init/dist/StartStop.d.ts:6

[statusP]

get [statusP](): Promise<Status>
Returns Promise<Status>
Inherited from startStop.StartStop.[statusP]
- Defined in node_modules/@matrixai/async-init/dist/StartStop.d.ts:8

[status]

get [status](): Status
Returns Status
Inherited from startStop.StartStop.[status]
- Defined in node_modules/@matrixai/async-init/dist/StartStop.d.ts:7

groups

get groups(): readonly Host[]
Gets the multicast groups MDNS is bound to. There will always be at least 1 value.

Returns readonly Host[]
- Defined in src/MDNS.ts:112

hostname

get hostname(): string
Gets the multicast hostname this socket is bound to. This will always end in .local.

Returns string
- Defined in src/MDNS.ts:130

id

get id(): number
Gets the id used for DNS packets. This is 16 bit.

Returns number
- Defined in src/MDNS.ts:139

localServices

get localServices(): ReadonlyMap<string, ServicePOJO>
Returns a Map of services that you have registered. The Key is a FQDN.

Returns ReadonlyMap<string, ServicePOJO>
- Defined in src/MDNS.ts:148

networkServices

get networkServices(): ReadonlyMap<string, ServicePOJO>
Returns a Map of services on the network. The Key is a FQDN.

Returns ReadonlyMap<string, ServicePOJO>
- Defined in src/MDNS.ts:157

port

get port(): Port
Gets the bound resolved port. This cannot be 0. Because 0 is always resolved to a specific port.

Returns Port
- Defined in src/MDNS.ts:103

unicast

get unicast(): boolean
Gets the unicast flag. This will be true if a socket is deemed able to receive unicast responses.

Returns boolean
- Defined in src/MDNS.ts:121

Methods

addEventListener

addEventListener(type, callback, options?): void
Parameters
- type: string
- callback: null | EventListenerOrEventListenerObject
- Optional options: boolean | AddEventListenerOptions
Returns void
Inherited from startStop.StartStop.addEventListener
- Defined in node_modules/@matrixai/events/dist/Evented.d.ts:9

`Protected` advertise

advertise(packet, advertisementKey, socket?): void
Parameters
- packet: Packet
- advertisementKey: string
- Optional socket: MulticastSocketInfo | MulticastSocketInfo[]
Returns void
- Defined in src/MDNS.ts:471

dispatchEvent

dispatchEvent(event): boolean
Parameters
- event: Event
Returns boolean
Inherited from startStop.StartStop.dispatchEvent
- Defined in node_modules/@matrixai/events/dist/Evented.d.ts:11

`Protected` extractRelatedFqdns

extractRelatedFqdns(resourceRecords): FQDN[]
Parameters
- resourceRecords: ResourceRecord | ResourceRecord[]
Returns FQDN[]
- Defined in src/MDNS.ts:1035

`Protected` findSocketHost

findSocketHost(addressHost): undefined | SocketHostRow
Parameters
- addressHost: Host
Returns undefined | SocketHostRow
- Defined in src/MDNS.ts:595

`Protected` handleEventResourceRecordCacheExpired

handleEventResourceRecordCacheExpired(evt): void
Parameters
- evt: EventResourceRecordCacheExpired
Returns void
- Defined in src/MDNS.ts:1019

`Protected` handleSocketError

handleSocketError(e, socket): Promise<void>
Parameters
- e: any
- socket: Socket
Returns Promise<void>
- Defined in src/MDNS.ts:1071

`Protected` handleSocketMessage

handleSocketMessage(msg, rinfo, socket): Promise<undefined | boolean>
Parameters
- msg: Buffer
- rinfo: RemoteInfo
- socket: Socket
Returns Promise<undefined | boolean>
- Defined in src/MDNS.ts:630

`Protected` handleSocketMessageQuery

handleSocketMessageQuery(packet, rinfo, socket): Promise<void>
Parameters
- packet: Packet
- rinfo: RemoteInfo
- socket: Socket
Returns Promise<void>
- Defined in src/MDNS.ts:707

`Protected` handleSocketMessageResponse

handleSocketMessageResponse(packet, rinfo, socket): Promise<void>
Parameters
- packet: Packet
- rinfo: RemoteInfo
- socket: Socket
Returns Promise<void>
- Defined in src/MDNS.ts:858

`Protected` processIncomingResourceRecords

processIncomingResourceRecords(resourceRecords, rinfo, socket): Promise<void>
Parameters
- resourceRecords: ResourceRecord[]
- rinfo: RemoteInfo
- socket: Socket
Returns Promise<void>
- Defined in src/MDNS.ts:870

registerService

registerService(opts): void
Registers a service
Parameters
- opts: {
      advertise?: boolean;
      name: string;
      port: number;
      protocol: "udp" | "tcp";
      txt?: Record<string, string>;
      type: string;
  }
  - Optional advertise?: boolean
    
    Allows MDNS to advertise the service on registration. Defaults to true.
  - name: string
    
    The name of the service you want to register.
  - port: number
    
    The port of the service you want to register.
  - protocol: "udp" | "tcp"
    
    The protocol of service you want to register. This is either 'udp' or 'tcp'.
  - Optional txt?: Record<string, string>
    
    The TXT data of the service you want to register. This is represented as a key-value POJO.
  - type: string
    
    The type of service you want to register.
Returns void
- Defined in src/MDNS.ts:1179

removeEventListener

removeEventListener(type, callback, options?): void
Parameters
- type: string
- callback: null | EventListenerOrEventListenerObject
- Optional options: boolean | EventListenerOptions
Returns void
Inherited from startStop.StartStop.removeEventListener
- Defined in node_modules/@matrixai/events/dist/Evented.d.ts:10

`Protected` sendMulticastPacket

sendMulticastPacket(packet, sockets?): Promise<void>
Sends a packet to the multicast groups
Parameters
- packet: Packet
  
  the packet to send
- Optional sockets: MulticastSocketInfo | MulticastSocketInfo[]
  
  If sockets is not provided, the message will be sent to all multicast sockets
Returns Promise<void>

Throws
ErrorMDNSSocketInvalidSendAddress

Throws
ErrorMDNSSocketSendFailed
- Defined in src/MDNS.ts:531

`Protected` sendPacket

sendPacket(packet, sockets, address): any
Sends a packet
Parameters
- packet: Packet
  
  the packet to send
- sockets: SocketInfo | SocketInfo[]
  
  the sockets to send on
- address: Host
  
  the address to send to
Returns any

Throws
ErrorMDNSSocketInvalidSendAddress

Throws
ErrorMDNSSocketSendFailed
- Defined in src/MDNS.ts:559

start

start(opts): Promise<void>
Starts MDNS
Parameters
- opts: {
      advertise?: boolean;
      disableLinuxMulticastAllOption?: boolean;
      groups?: string[];
      hostname?: string;
      id?: number;
      ipv6Only?: boolean;
      port?: number;
  }
  - Optional advertise?: boolean
    
    Allows MDNS to advertise it's hostnames. Defaults to true.
  - Optional disableLinuxMulticastAllOption?: boolean
  - Optional groups?: string[]
    
    The multicast group IP addresses to multi-cast on. This must as least have one element. This can have both IPv4 and IPv6 and must. Defaults to ['224.0.0.251', 'ff02::fb'].
  - Optional hostname?: string
    
    The hostname to use for the MDNS stack. Defaults to the OS hostname.
  - Optional id?: number
    
    The unique unsigned 16 bit integer ID used for all outgoing MDNS packets. Defaults to a random number.
  - Optional ipv6Only?: boolean
    
    Makes MDNS to bind exclusively IPv6 sockets. Defaults to false.
  - Optional port?: number
    
    The port to bind to. Defaults to 5353 the default MDNS port. Defaults to 5353.
Returns Promise<void>
Throws
- If opts.groups is empty.
Throws
- If a socket cannot bind.
Throws
- If no valid interfaces have been found.
Inherited from startStop.StartStop.start
- Defined in src/MDNS.ts:177

startQuery

startQuery(opts): void
Start a query for services of a specific type and protocol. If there already is a query running for the type and protocol combination, it will be cancelled and restarted.
Parameters
- opts: {
      maxDelay?: number;
      minDelay?: number;
      protocol: "udp" | "tcp";
      type: string;
  }
  - Optional maxDelay?: number
    
    The maximum delay between queries in seconds. Defaults to 3600 (1 hour).
  - Optional minDelay?: number
    
    The minimum delay between queries in seconds. Defaults to 1.
  - protocol: "udp" | "tcp"
    
    The protocol of service you want to query for. This is either 'udp' or 'tcp'.
  - type: string
    
    The type of service you want to query for.
Returns void
- Defined in src/MDNS.ts:1285

stop

stop(): Promise<void>
Stops MDNS This will unregister all services and hosts, sending a goodbye packet. This will flush all records from the cache. This will close all sockets.

Returns Promise<void>
Inherited from startStop.StartStop.stop
- Defined in src/MDNS.ts:1092

stopQuery

stopQuery(opts): void
Stops a service query that you have started with startQuery
Parameters
- opts: {
  protocol: "udp" | "tcp";
  type: string;
  }
  - protocol: "udp" | "tcp"
    
    The protocol of service you want to stop querying for. This is either 'udp' or 'tcp'.
  - type: string
    
    The type of service you want to stop querying for.
Returns void
- Defined in src/MDNS.ts:1384

unregisterService

unregisterService(opts): void
Un-registers a service that you have registered with registerService
Parameters
- opts: {
      name: string;
      protocol: "udp" | "tcp";
      type: string;
  }
  - name: string
    
    The name of the service you want to unregister.
  - protocol: "udp" | "tcp"
    
    The protocol of service you want to unregister. This is either 'udp' or 'tcp'.
  - type: string
    
    The type of service you want to unregister.
Returns void
- Defined in src/MDNS.ts:1235

Class MDNS

Hierarchy

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

__namedParameters: { getNetworkInterfaces?: (() => NetworkInterfaces | PromiseLike<NetworkInterfaces>); logger?: Logger; } = {}

Optional getNetworkInterfaces?: (() => NetworkInterfaces | PromiseLike<NetworkInterfaces>)

Returns NetworkInterfaces | PromiseLike<NetworkInterfaces>

Optional logger?: Logger

Returns MDNS

Properties

Readonly [initLock]

Protected _groups

Protected _hostname

Protected _id

Protected _localServices

Protected _networkServices

Protected _port

Protected _unicast

Protected advertisements

Protected getNetworkInterfaces

Type declaration

Returns NetworkInterfaces | PromiseLike<NetworkInterfaces>

Protected localRecordCache

Protected localRecordCacheDirty

Protected logger

Protected networkRecordCache

Protected queries

Protected runningTasks

Protected socketHostTable

Protected socketMap

Protected sockets

Accessors

[eventHandled]

Returns ReadonlyWeakSet<Event>

[eventHandlers]

Returns ReadonlyMap<string, Set<EventHandlerInfo>>

[eventTarget]

Returns EventTarget

[handleEventError]

Returns ((evt) => void)

Parameters

evt: EventError

Returns void

[running]

Returns boolean

[statusP]

Returns Promise<Status>

[status]

Returns Status

groups

Returns readonly Host[]

hostname

Returns string

id

Returns number

localServices

Returns ReadonlyMap<string, ServicePOJO>

networkServices

Returns ReadonlyMap<string, ServicePOJO>

port

Returns Port

unicast

Returns boolean

Methods

addEventListener

Parameters

type: string

callback: null | EventListenerOrEventListenerObject

Optional options: boolean | AddEventListenerOptions

Returns void

Protected advertise

Parameters

packet: Packet

advertisementKey: string

__namedParameters: {
getNetworkInterfaces?: (() => NetworkInterfaces | PromiseLike<NetworkInterfaces>);
logger?: Logger;
} = {}

`Optional` getNetworkInterfaces?: (() => NetworkInterfaces | PromiseLike<NetworkInterfaces>)

`Optional` logger?: Logger

`Readonly` [initLock]

`Protected` _groups

`Protected` _hostname

`Protected` _id

`Protected` _localServices

`Protected` _networkServices

`Protected` _port

`Protected` _unicast

`Protected` advertisements

`Protected` getNetworkInterfaces

`Protected` localRecordCache

`Protected` localRecordCacheDirty

`Protected` logger

`Protected` networkRecordCache

`Protected` queries

`Protected` runningTasks

`Protected` socketHostTable

`Protected` socketMap

`Protected` sockets

`Optional` options: boolean | AddEventListenerOptions

`Protected` advertise

`Optional` socket: MulticastSocketInfo | MulticastSocketInfo[]

`Protected` extractRelatedFqdns

`Protected` findSocketHost

`Protected` handleEventResourceRecordCacheExpired

`Protected` handleSocketError

`Protected` handleSocketMessage

`Protected` handleSocketMessageQuery

`Protected` handleSocketMessageResponse

`Protected` processIncomingResourceRecords

opts: {
advertise?: boolean;
name: string;
port: number;
protocol: "udp" | "tcp";
txt?: Record<string, string>;
type: string;
}

`Optional` advertise?: boolean

`Optional` txt?: Record<string, string>

`Optional` options: boolean | EventListenerOptions

`Protected` sendMulticastPacket

`Optional` sockets: MulticastSocketInfo | MulticastSocketInfo[]