Google is committed to advancing racial equity for Black communities. See how.

nl::Weave::Profiles::DataManagement_Legacy::PublisherDataManager

This is an abstract class.

#include <src/lib/profiles/data-management/Legacy/PublisherDataManager.h>

An abstract class containing confirm and notification method definitions required by the WDM publisher.

Summary

Class PublisherDataManager is an abstract class that spells out the methods an application implementer must provide in order to handle the data and status delivered by the publisher in WDM protocol exchanges. It is one of the two primary components of the DMPublisher abstract base class.

Note that all of the indication methods below take an exchange context argument and that it is the responsibility of implementers of these methods to manage this context. In particular, to dispose of it when it is no longer needed.

Inheritance

Direct Known Subclasses: nl::Weave::Profiles::DataManagement_Legacy::DMPublisher

Public functions

UpdateIndication(ExchangeContext *aResponseCtx, ReferencedTLVData & aDataList)=0
virtual WEAVE_ERROR
Indicate the receipt of an update request.
ViewIndication(ExchangeContext *aResponseCtx, ReferencedTLVData & aPathList)=0
virtual WEAVE_ERROR
Indicate receipt of a view request.

Public functions

UpdateIndication

virtual WEAVE_ERROR UpdateIndication(
  ExchangeContext *aResponseCtx,
  ReferencedTLVData & aDataList
)=0

Indicate the receipt of an update request.

Indicate that an update request frame has been received and the sender awaits processing and response.

Details
Parameters
[in] aResponseCtx
A pointer to the Weave exchange context in which the message was delivered. See above note about exchange contexts.
[in] aDataList
A reference to a ReferencedTLVData object containing a TLV-encoded data list detailing new data values and including the identifier of the version against which the update was made.
Returns
WEAVE_NO_ERROR to communicate success. Otherwise the value is at the discretion of the implementer.

ViewIndication

virtual WEAVE_ERROR ViewIndication(
  ExchangeContext *aResponseCtx,
  ReferencedTLVData & aPathList
)=0

Indicate receipt of a view request.

Indicate that a view request frame has been received and the sender awaits processing and response.

Details
Parameters
[in] aResponseCtx
A pointer to the Weave exchange context in which the message was delivered. See above note about exchange contexts.
[in] aPathList
A reference to a ReferencedTLVData object containing a TLV-encoded path list detailing requested data.
Returns
WEAVE_NO_ERROR to communicate success. Otherwise the value is at the discretion of the implementer.