Class MdnsInstanceBroadcaster

This class is handing MDNS Announcements for one instance of a device aka "port".

Obtain an instance via MdnsBroadcaster.createInstanceBroadcaster.

Implements

InstanceBroadcaster

Index

Constructors

Methods

announce close expireAllAnnouncements expireCommissioningAnnouncement expireFabricAnnouncement setCommissionerInfo setCommissionMode setFabrics

Constructors

constructor

new MdnsInstanceBroadcaster(instancePort, mdnsBroadcaster, onclose): MdnsInstanceBroadcaster
Parameters
- instancePort: number
- mdnsBroadcaster: MdnsBroadcaster
- onclose: (() => void)
  - - (): void
    - Returns void
Returns MdnsInstanceBroadcaster
- Defined in packages/protocol/src/mdns/MdnsInstanceBroadcaster.ts:27

Methods

announce

announce(): Promise<void>
Send out announcements for this instance.

Returns Promise<void>
Implementation of InstanceBroadcaster.announce
- Defined in packages/protocol/src/mdns/MdnsInstanceBroadcaster.ts:63

close

close(): Promise<void>
Destroy the instance

Returns Promise<void>
Implementation of InstanceBroadcaster.close
- Defined in packages/protocol/src/mdns/MdnsInstanceBroadcaster.ts:33

expireAllAnnouncements

expireAllAnnouncements(): Promise<void>
Expire all announcements.

Returns Promise<void>
Implementation of InstanceBroadcaster.expireAllAnnouncements
- Defined in packages/protocol/src/mdns/MdnsInstanceBroadcaster.ts:78

expireCommissioningAnnouncement

expireCommissioningAnnouncement(): Promise<void>
Expire the announcement for this commissioning instance.

Returns Promise<void>
Implementation of InstanceBroadcaster.expireCommissioningAnnouncement
- Defined in packages/protocol/src/mdns/MdnsInstanceBroadcaster.ts:73

expireFabricAnnouncement

expireFabricAnnouncement(): Promise<void>
Expire the announcement for this operative instance.

Returns Promise<void>
Implementation of InstanceBroadcaster.expireFabricAnnouncement
- Defined in packages/protocol/src/mdns/MdnsInstanceBroadcaster.ts:68

setCommissionerInfo

setCommissionerInfo(commissionerData): Promise<void>
Set the Broadcaster data to announce a Commissioner (aka Commissioner discovery)
Parameters
- commissionerData: CommissionerInstanceData
Returns Promise<void>
Implementation of InstanceBroadcaster.setCommissionerInfo
- Defined in packages/protocol/src/mdns/MdnsInstanceBroadcaster.ts:58

setCommissionMode

setCommissionMode(mode, deviceData): Promise<void>
Set a commissionable mode and details to announce a commissionable device.
Parameters
- mode: number
- deviceData: CommissioningModeInstanceData
Returns Promise<void>
Implementation of InstanceBroadcaster.setCommissionMode
- Defined in packages/protocol/src/mdns/MdnsInstanceBroadcaster.ts:43

setFabrics

setFabrics(fabrics, expireCommissioningAnnouncements?): Promise<void>
Set the Broadcaster Data to announce a device for operative discovery (aka "already paired")
Parameters
- fabrics: Fabric[]
- expireCommissioningAnnouncements: boolean = false
Returns Promise<void>
Implementation of InstanceBroadcaster.setFabrics
- Defined in packages/protocol/src/mdns/MdnsInstanceBroadcaster.ts:49