Interface InstanceBroadcaster

Interface for classes that allow to announce one Matter instance.

interface InstanceBroadcaster {
    announce(): Promise<void>;
    close(): Promise<void>;
    expireAllAnnouncements(): Promise<void>;
    expireCommissioningAnnouncement(): Promise<void>;
    expireFabricAnnouncement(): Promise<void>;
    setCommissionerInfo(commissionerData: CommissionerInstanceData): Promise<void>;
    setCommissionMode(mode: CommissioningMode, deviceData: CommissioningModeInstanceData): Promise<void>;
    setFabrics(fabrics: Fabric[], expireCommissioningAnnouncements?: boolean): Promise<void>;
}

Implemented by

MdnsInstanceBroadcaster

Index

Methods

announce close expireAllAnnouncements expireCommissioningAnnouncement expireFabricAnnouncement setCommissionerInfo setCommissionMode setFabrics

Methods

announce

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

Returns Promise<void>
- Defined in packages/protocol/src/common/InstanceBroadcaster.ts:207

close

close(): Promise<void>
Destroy the instance

Returns Promise<void>
- Defined in packages/protocol/src/common/InstanceBroadcaster.ts:219

expireAllAnnouncements

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

Returns Promise<void>
- Defined in packages/protocol/src/common/InstanceBroadcaster.ts:216

expireCommissioningAnnouncement

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

Returns Promise<void>
- Defined in packages/protocol/src/common/InstanceBroadcaster.ts:213

expireFabricAnnouncement

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

Returns Promise<void>
- Defined in packages/protocol/src/common/InstanceBroadcaster.ts:210

setCommissionerInfo

setCommissionerInfo(commissionerData): Promise<void>
Set commissioner details to announce a commissioner service for User directed commissioning (UDC).
Parameters
- commissionerData: CommissionerInstanceData
Returns Promise<void>
- Defined in packages/protocol/src/common/InstanceBroadcaster.ts:204

setCommissionMode

setCommissionMode(mode, deviceData): Promise<void>
Set a commissionable mode and details to announce a commissionable device.
Parameters
- mode: CommissioningMode
- deviceData: CommissioningModeInstanceData
Returns Promise<void>
- Defined in packages/protocol/src/common/InstanceBroadcaster.ts:195

setFabrics

setFabrics(fabrics, expireCommissioningAnnouncements?): Promise<void>
Set operational details to Announce an operational device which is already commissioned. Use expireCommissioningAnnouncements = true when Fabrics are changed after a n commissioning process.
Parameters
- fabrics: Fabric[]
- OptionalexpireCommissioningAnnouncements: boolean
Returns Promise<void>
- Defined in packages/protocol/src/common/InstanceBroadcaster.ts:201