nl::Weave::Profiles::FabricProvisioning::FabricProvisioningServer

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

Server class for implementing the Fabric Provisioning profile.

Summary

Inheritance

Inherits from: nl::Weave::WeaveServerBase
Direct Known Subclasses: nl::Weave::DeviceLayer::Internal::FabricProvisioningServer

Constructors and Destructors
FabricProvisioningServer(void)

Protected attributes
mCurClientOp
mDelegate

Public functions
Init(WeaveExchangeManager *exchangeMgr)
Initialize the Fabric Provisioning Server state and register to receive Fabric Provisioning messages.
SendStatusReport(uint32_t statusProfileId, uint16_t statusCode, WEAVE_ERROR sysError)
virtual WEAVE_ERROR
Send a status report response to a request.
SendSuccessResponse(void)
virtual WEAVE_ERROR
Send a success response to a Fabric Provisioning request.
SessionHasFabricConfigAccessPrivilege(uint16_t keyId, uint64_t peerNodeId) const
bool
Indicates if the session with the given node id and the session key id is authorized to retrieve fabric config information.
SetDelegate(FabricProvisioningDelegate *delegate)
void
Set the delegate to process Fabric Provisioning events.
Shutdown(void)
Shutdown the Fabric Provisioning Server.

Protected attributes

mCurClientOp

ExchangeContext * mCurClientOp

mDelegate

FabricProvisioningDelegate * mDelegate

Public functions

FabricProvisioningServer

 FabricProvisioningServer(
  void
)

Init

WEAVE_ERROR Init(
  WeaveExchangeManager *exchangeMgr
)

Initialize the Fabric Provisioning Server state and register to receive Fabric Provisioning messages.

Details
Parameters
[in] exchangeMgr
A pointer to the system Weave Exchange Manager.
Return Values
WEAVE_ERROR_TOO_MANY_UNSOLICITED_MESSAGE_HANDLERS
If too many message handlers have already been registered.
WEAVE_NO_ERROR
On success.

SendStatusReport

virtual WEAVE_ERROR SendStatusReport(
  uint32_t statusProfileId,
  uint16_t statusCode,
  WEAVE_ERROR sysError
)

Send a status report response to a request.

Details
Parameters
[in] statusProfileId
The Weave profile ID this status report pertains to.
[in] statusCode
The status code to be included in this response.
[in] sysError
The system error code to be included in this response.
Return Values
WEAVE_ERROR_INCORRECT_STATE
If there is no request being processed.
WEAVE_NO_ERROR
On success.
other
Other Weave or platform-specific error codes indicating that an error occurred preventing the sending of the status report.

SendSuccessResponse

virtual WEAVE_ERROR SendSuccessResponse(
  void
)

Send a success response to a Fabric Provisioning request.

Details
Return Values
WEAVE_ERROR_INCORRECT_STATE
If there is no request being processed.
WEAVE_NO_ERROR
On success.
other
Other Weave or platform-specific error codes indicating that an error occurred preventing the sending of the success response.

SessionHasFabricConfigAccessPrivilege

bool SessionHasFabricConfigAccessPrivilege(
  uint16_t keyId,
  uint64_t peerNodeId
) const

Indicates if the session with the given node id and the session key id is authorized to retrieve fabric config information.

Details
Returns
Returns 'true' if the given peer is privileged, else 'false'.

SetDelegate

void SetDelegate(
  FabricProvisioningDelegate *delegate
)

Set the delegate to process Fabric Provisioning events.

Details
Parameters
[in] delegate
A pointer to the Fabric Provisioning Delegate.

Shutdown

WEAVE_ERROR Shutdown(
  void
)

Shutdown the Fabric Provisioning Server.

Details
Return Values
WEAVE_NO_ERROR
unconditionally.