Namespaces
-
namespace BaseMessageWithSubscribeId -
namespace CustomCommand -
namespace CustomCommandResponse -
namespace DataElement -
namespace DataList -
namespace Event -
namespace EventList -
namespace NotificationRequest -
namespace Path -
namespace PathList -
namespace Platform -
namespace RejectionRecord -
namespace RejectionRecordList -
namespace StatusElement -
namespace StatusList -
namespace SubscribeCancelRequest -
namespace SubscribeConfirmRequest -
namespace SubscribeRequest -
namespace SubscribeResponse -
namespace UpdateRequest -
namespace UpdateResponse -
namespace VersionList -
namespace ViewRequest -
namespace ViewResponse
Enumerations
enum CommandFlags
| Name | Value |
|---|---|
| kCommandFlag_MustBeVersionValid | 0x0001 |
| kCommandFlag_InitiationTimeValid | 0x0002 |
| kCommandFlag_ActionTimeValid | 0x0004 |
| kCommandFlag_ExpiryTimeValid | 0x0008 |
| kCommandFlag_IsOneWay | 0x0010 |
Defined at line 38 of file gen/third_party/openweave-core/src/include/Weave/Profiles/data-management/Current/Command.h
enum ImportanceType
| Name | Value |
|---|---|
| kImportanceType_Invalid | 0 |
| kImportanceType_First | 1 |
| ProductionCritical | 1 |
| Production | 2 |
| Info | 3 |
| Debug | 4 |
| kImportanceType_Last | Debug |
The importance of the log entry.
Defined at line 56 of file gen/third_party/openweave-core/src/include/Weave/Profiles/data-management/Current/EventLoggingTypes.h
enum LoggingManagementStates
| Name | Value |
|---|---|
| kLoggingManagementState_Idle | 1 |
| kLoggingManagementState_InProgress | 2 |
| kLoggingManagementState_Holdoff | 3 |
| kLoggingManagementState_Shutdown | 4 |
Defined at line 144 of file gen/third_party/openweave-core/src/include/Weave/Profiles/data-management/Current/LoggingManagement.h
enum TimestampType
| Name | Value |
|---|---|
| kTimestampType_Invalid | 0 |
| kTimestampType_System | 1 |
| kTimestampType_UTC | 2 |
The validity and type of timestamp included in EventOptions.
Defined at line 166 of file gen/third_party/openweave-core/src/include/Weave/Profiles/data-management/Current/EventLoggingTypes.h
Records
-
class BuilderBase -
class CircularEventBuffer -
class CircularEventReader -
class Command -
class CommandSender -
class ConstSchemaVersionRange -
class CopyAndAdjustDeltaTimeContext -
class DetailedRootSection -
class EventEnvelopeContext -
class EventLoadOutContext -
class EventOptions -
class EventProcessor -
class EventSchema -
class ExternalEvents -
class IDataElementAccessControlDelegate -
class IDirtyPathCut -
class IPathFilter -
class IUpdateRequestDataElementAccessControlDelegate -
class IWeavePublisherLock -
class IWeaveWDMMutex -
class ListBuilderBase -
class ListParserBase -
class LogBDXUpload -
class LogStorageResources -
class LoggingConfiguration -
class LoggingManagement -
class MockWdmSubscriptionInitiatorImpl -
class NotificationEngine -
class ParserBase -
class ResourceIdentifier -
class SchemaVersionRange -
class SingleResourceTraitCatalog -
class SubscriptionClient -
class SubscriptionEngine -
class SubscriptionHandler -
class TestSubscriptionHandler -
class TestTdm -
class TestWdm -
class Timestamp -
class TraitCatalogBase -
class TraitDataSink -
class TraitDataSource -
class TraitPath -
class TraitPathStore -
class TraitSchemaEngine -
class TraitUpdatableDataSource -
class UpdateClient -
class UpdateDictionaryDirtyPathCut -
class UpdateDirtyPathFilter -
class UpdateEncoder -
class VersionedTraitPath -
class ViewClient -
class WdmUpdateEncoderTest -
class WdmUpdateServerTest
Functions
-
WEAVE_ERROR BdxSendAcceptHandler (nl::Weave::Profiles::BulkDataTransfer::BDXTransfer * aXfer, nl::Weave::Profiles::BulkDataTransfer::SendAccept * aSendAcceptMsg) -
void BdxRejectHandler (nl::Weave::Profiles::BulkDataTransfer::BDXTransfer * aXfer, nl::Weave::Profiles::StatusReporting::StatusReport * aReport) -
void BdxGetBlockHandler (nl::Weave::Profiles::BulkDataTransfer::BDXTransfer * aXfer, uint64_t * aLength, uint8_t ** aDataBlock, bool * aIsLastBlock) -
void BdxXferErrorHandler (nl::Weave::Profiles::BulkDataTransfer::BDXTransfer * aXfer, nl::Weave::Profiles::StatusReporting::StatusReport * aXferError) -
void BdxXferDoneHandler (nl::Weave::Profiles::BulkDataTransfer::BDXTransfer * aXfer) -
void BdxErrorHandler (nl::Weave::Profiles::BulkDataTransfer::BDXTransfer * aXfer, WEAVE_ERROR aErrorCode) -
PropertyPathHandle CreatePropertyPathHandle (PropertySchemaHandle aPropertyPathSchemaId, PropertyDictionaryKey aPropertyPathDictionaryKey)Defined at line 86 of file gen/third_party/openweave-core/src/include/Weave/Profiles/data-management/Current/TraitData.h
-
PropertySchemaHandle GetPropertySchemaHandle (PropertyPathHandle aHandle)Defined at line 92 of file gen/third_party/openweave-core/src/include/Weave/Profiles/data-management/Current/TraitData.h
-
PropertyDictionaryKey GetPropertyDictionaryKey (PropertyPathHandle aHandle)Defined at line 97 of file gen/third_party/openweave-core/src/include/Weave/Profiles/data-management/Current/TraitData.h
-
bool IsRootPropertyPathHandle (PropertyPathHandle aHandle)Defined at line 102 of file gen/third_party/openweave-core/src/include/Weave/Profiles/data-management/Current/TraitData.h
-
bool IsNullPropertyPathHandle (PropertyPathHandle aHandle)Defined at line 107 of file gen/third_party/openweave-core/src/include/Weave/Profiles/data-management/Current/TraitData.h
-
event_id_t LogEvent (const EventSchema & inSchema, nl::Weave::TLV::TLVReader & inData)Log an event from a pre-serialized form.
The function logs an event represented as a nl::Weave::TLV::TLVReader. This
implies that the event data representation is already serialized in
the storage underlying the nl::Weave::TLV::TLVReader. The nl::Weave::TLV::TLVReader is expected to
contain at least a single data element, that element must be a
structure. The first element read out of the reader is treated as
event data and stored in the event log. The event data MUST
contain context tags to be interpreted within the schema identified
by inProfileID and inEventType. The tag of the first element will
be ignored; the event logging system will replace it with the
eventData tag.
The event is logged if its inImportance exceeds the logging
threshold specified in the LoggingConfiguration. If the event's
importance does not meet the current threshold, it is dropped and
the function returns a `0` as the resulting event ID.
This variant of the invocation implicitly specifies all the default
event options:
- the event is timestamped with the current time at the point of the call,
- the event is marked as relating to the device that is making the call,
- the event is standalone, not relating to any other events,
- the event is marked as non-urgent,
Parameters
inSchema [in] Schema defining importance, profile ID, and structure type of this event.inData [in] The TLV reader containing the event data as the first element.Returns
event_id_t The event ID if the event was written to the
log, 0 otherwise.
-
event_id_t LogEvent (const EventSchema & inSchema, nl::Weave::TLV::TLVReader & inData, const EventOptions * inOptions)Log an event from a pre-serialized form, with additional options.
The function logs an event represented as a nl::Weave::TLV::TLVReader. This
implies that the event data representation is already serialized in
the storage underlying the nl::Weave::TLV::TLVReader. The nl::Weave::TLV::TLVReader is expected to
contain at least a single data element, that element must be a
structure. The first element read out of the reader is treated as
event data and stored in the event log. The event data MUST
contain context tags to be interpreted within the schema identified
by inProfileID and inEventType. The tag of the first element will
be ignored; the event logging system will replace it with the
eventData tag.
The event is logged if its inImportance exceeds the logging
threshold specified in the LoggingConfiguration. If the event's
importance does not meet the current threshold, it is dropped and
the function returns a `0` as the resulting event ID.
This variant of the invocation permits the caller to set any
combination of `EventOptions`:
- timestamp, when 0 defaults to the current time at the point of
the call,
- "root" section of the event source (event source and trait ID);
if NULL, it defaults to the current device. the event is marked as
relating to the device that is making the call,
- a related event ID for grouping event IDs; when the related event
ID is 0, the event is marked as not relating to any other events,
- urgency; by default non-urgent.
Parameters
inSchema [in] Schema defining importance, profile ID, and structure type of this event.inData [in] The TLV reader containing the event data as the first element. Must not be NULLinOptions [in] The options for the event metadata. May be NULL.Returns
event_id_t The event ID if the event was written to the
log, 0 otherwise.
-
event_id_t LogEvent (const EventSchema & inSchema, EventWriterFunct inEventWriter, void * inAppData)Log an event via a callback.
The function logs an event represented as an ::EventWriterFunct and
an app-specific `appData` context. The function writes the event
metadata and calls the `inEventWriter` with an nl::Weave::TLV::TLVWriter
reference and `inAppData` context so that the user code can emit
the event data directly into the event log. This form of event
logging minimizes memory consumption, as event data is serialized
directly into the target buffer. The event data MUST contain
context tags to be interpreted within the schema identified by
`inProfileID` and `inEventType`. The tag of the first element will be
ignored; the event logging system will replace it with the
eventData tag.
The event is logged if its inImportance exceeds the logging
threshold specified in the LoggingConfiguration. If the event's
importance does not meet the current threshold, it is dropped and
the function returns a `0` as the resulting event ID.
This variant of the invocation implicitly specifies all the default
event options:
- the event is timestamped with the current time at the point of the call,
- the event is marked as relating to the device that is making the call,
- the event is standalone, not relating to any other events,
- the event is marked as non-urgent,
Parameters
inSchema [in] Schema defining importance, profile ID, and structure type of this event.inEventWriter [in] The callback to invoke to actually serialize the event datainAppData [in] Application context for the callback.Returns
event_id_t The event ID if the event was written to the
log, 0 otherwise.
-
event_id_t LogEvent (const EventSchema & inSchema, EventWriterFunct inEventWriter, void * inAppData, const EventOptions * inOptions)Log an event via a callback, with options.
The function logs an event represented as an ::EventWriterFunct and
an app-specific `appData` context. The function writes the event
metadata and calls the `inEventWriter` with an nl::Weave::TLV::TLVWriter
reference and `inAppData` context so that the user code can emit
the event data directly into the event log. This form of event
logging minimizes memory consumption, as event data is serialized
directly into the target buffer. The event data MUST contain
context tags to be interpreted within the schema identified by
`inProfileID` and `inEventType`. The tag of the first element will be
ignored; the event logging system will replace it with the
eventData tag.
The event is logged if its inImportance exceeds the logging
threshold specified in the LoggingConfiguration. If the event's
importance does not meet the current threshold, it is dropped and
the function returns a `0` as the resulting event ID.
This variant of the invocation permits the caller to set any
combination of `EventOptions`:
- timestamp, when 0 defaults to the current time at the point of
the call,
- "root" section of the event source (event source and trait ID);
if NULL, it defaults to the current device. the event is marked as
relating to the device that is making the call,
- a related event ID for grouping event IDs; when the related event
ID is 0, the event is marked as not relating to any other events,
- urgency; by default non-urgent.
Parameters
inSchema [in] Schema defining importance, profile ID, and structure type of this event.inEventWriter [in] The callback to invoke to actually serialize the event datainAppData [in] Application context for the callback.inOptions [in] The options for the event metadata. May be NULL.Returns
event_id_t The event ID if the event was written to the
log, 0 otherwise.
-
event_id_t LogFreeform (ImportanceType inImportance, const char * inFormat)LogFreeform emits a freeform string to the default event stream.
The string will be encapsulated in an debug event structure,
structurally identical to other logged strings. The event profile
ID will be that of a Nest Debug event, and the event type will be
`kNestDebug_StringLogEntryEvent`.
Parameters
inImportance [in] Importance of the log entry; if the importance falls below the current importance, the event is not actually loggedinFormat [in] `printf`-compliant format string, followed by arguments to be formattedReturns
event_id_t The event ID if the event was written to the
log, 0 otherwise.
-
WEAVE_ERROR PlainTextWriter (::nl::Weave::TLV::TLVWriter & ioWriter, uint8_t inDataTag, void * appData)A helper function for emitting a freeform text as a debug
event. The debug event is a structure with a logregion and a
freeform text.
Parameters
ioWriter [in] The writer to use for writing out the eventinDataTag [in] The tag to emitappData [in] A pointer to the DebugLogContext, a structure that holds a string format, arguments, and a log region -
bool operator== (const ResourceIdentifier & lhs, const ResourceIdentifier & rhs)Defined at line 272 of file gen/third_party/openweave-core/src/include/Weave/Profiles/data-management/Current/ResourceIdentifier.h
-
bool operator!= (const ResourceIdentifier & lhsconst ResourceIdentifier & rhs)Defined at line 277 of file gen/third_party/openweave-core/src/include/Weave/Profiles/data-management/Current/ResourceIdentifier.h