nl::Weave::Profiles::FabricProvisioning::FabricProvisioningDelegate

This is an abstract class.

#include <src/lib/profiles/fabric-provisioning/FabricProvisioning.h>

Delegate class for implementing additional actions corresponding to Fabric Provisioning operations.

Summary

Inheritance

Inherits from: nl::Weave::WeaveServerDelegateBase

Public functions

EnforceAccessControl(ExchangeContext *ec, uint32_t msgProfileId, uint8_t msgType, const WeaveMessageInfo *msgInfo, AccessControlResult & result)
virtual void
Enforce message-level access control for an incoming Fabric Provisioning request message.
HandleCreateFabric(void)=0
virtual WEAVE_ERROR
Indicates that the device has created a new Fabric.
HandleGetFabricConfig(void)=0
virtual WEAVE_ERROR
Indicates that the configuration of the current Weave Fabric has been requested.
HandleJoinExistingFabric(void)=0
virtual WEAVE_ERROR
Indicates that the device has joined an existing Fabric.
HandleLeaveFabric(void)=0
virtual WEAVE_ERROR
Indicates that the device has left a Fabric.
IsPairedToAccount() const
virtual bool
Called to determine if the device is currently paired to an account.

Public functions

EnforceAccessControl

virtual void EnforceAccessControl(
  ExchangeContext *ec,
  uint32_t msgProfileId,
  uint8_t msgType,
  const WeaveMessageInfo *msgInfo,
  AccessControlResult & result
)

Enforce message-level access control for an incoming Fabric Provisioning request message.

Details
Parameters
[in] ec
The ExchangeContext over which the message was received.
[in] msgProfileId
The profile id of the received message.
[in] msgType
The message type of the received message.
[in] msgInfo
A WeaveMessageInfo structure containing information about the received message.
[in,out] result
An enumerated value describing the result of access control policy evaluation for the received message. Upon entry to the method, the value represents the tentative result at the current point in the evaluation process. Upon return, the result is expected to represent the final assessment of access control policy for the message.

HandleCreateFabric

virtual WEAVE_ERROR HandleCreateFabric(
  void
)=0

Indicates that the device has created a new Fabric.

Details
Return Values
WEAVE_NO_ERROR
On success.
other
Other Weave or platform-specific error codes indicating that an error occurred preventing the device from creating a fabric.

HandleGetFabricConfig

virtual WEAVE_ERROR HandleGetFabricConfig(
  void
)=0

Indicates that the configuration of the current Weave Fabric has been requested.

Details
Return Values
WEAVE_NO_ERROR
On success.
other
Other Weave or platform-specific error codes indicating that an error occurred preventing the device from returning the fabric config.

HandleJoinExistingFabric

virtual WEAVE_ERROR HandleJoinExistingFabric(
  void
)=0

Indicates that the device has joined an existing Fabric.

Details
Return Values
WEAVE_NO_ERROR
On success.
other
Other Weave or platform-specific error codes indicating that an error occurred preventing the device from joining the fabric.

HandleLeaveFabric

virtual WEAVE_ERROR HandleLeaveFabric(
  void
)=0

Indicates that the device has left a Fabric.

Details
Return Values
WEAVE_NO_ERROR
On success.
other
Other Weave or platform-specific error codes indicating that an error occurred preventing the device from leaving the fabric.

IsPairedToAccount

virtual bool IsPairedToAccount() const 

Called to determine if the device is currently paired to an account.