nl::Weave::Profiles::Time::Contact

#include <src/lib/profiles/time/WeaveTime.h>

This is in the public because the TimeSyncNode::FilterTimeCorrectionContributor callback gives a global view to higher layer.

Summary

It's put in the open instead of being a nested class to make class declaration of TimeSyncNode shorter, and also the export declaration more explicit.

Public attributes

mCommState
uint8_t
contains CommState.
mCountCommError
uint8_t
count the number of communication errors have happened for this contact.
mFlightTime_usec
int32_t
used to store one way flight time.
mIsTimeChangeNotification
bool
true if this contact is learned from time change notification only valid when mCommState is not kCommState_Invalid
mNodeAddr
node address of this contact only valid when mCommState is not kCommState_Invalid
mNodeId
uint64_t
node ID of this contact only valid when mCommState is not kCommState_Invalid
mNumberOfContactUsedInLastLocalSync
uint8_t
only valid if response is not kResponseStatus_Invalid
mRemoteTimestamp_usec
timesync_t
used to store the system time of remote node, when the response message was prepared for transmission.
mResponseStatus
uint8_t
contains ResponseStatus.
mRole
uint8_t
contains TimeSyncRole.
mTimeSinceLastSuccessfulSync_min
uint16_t
only valid if response is not kResponseStatus_Invalid
mUnadjTimestampLastContact_usec
timesync_t
this is the timestamp when the response was received.

Public attributes

mCommState

uint8_t nl::Weave::Profiles::Time::Contact::mCommState

contains CommState.

casted to uint8_t to save space. always valid

mCountCommError

uint8_t nl::Weave::Profiles::Time::Contact::mCountCommError

count the number of communication errors have happened for this contact.

only valid when mCommState is not kCommState_Invalid

mFlightTime_usec

int32_t nl::Weave::Profiles::Time::Contact::mFlightTime_usec

used to store one way flight time.

only valid if response is not kResponseStatus_Invalid

mIsTimeChangeNotification

bool nl::Weave::Profiles::Time::Contact::mIsTimeChangeNotification

true if this contact is learned from time change notification only valid when mCommState is not kCommState_Invalid

mNodeAddr

IPAddress nl::Weave::Profiles::Time::Contact::mNodeAddr

node address of this contact only valid when mCommState is not kCommState_Invalid

mNodeId

uint64_t nl::Weave::Profiles::Time::Contact::mNodeId

node ID of this contact only valid when mCommState is not kCommState_Invalid

mNumberOfContactUsedInLastLocalSync

uint8_t nl::Weave::Profiles::Time::Contact::mNumberOfContactUsedInLastLocalSync

only valid if response is not kResponseStatus_Invalid

mRemoteTimestamp_usec

timesync_t nl::Weave::Profiles::Time::Contact::mRemoteTimestamp_usec

used to store the system time of remote node, when the response message was prepared for transmission.

only valid if response is not kResponseStatus_Invalid

mResponseStatus

uint8_t nl::Weave::Profiles::Time::Contact::mResponseStatus

contains ResponseStatus.

casted to uint8_t to save space. only valid when mCommState is not kCommState_Invalid

mRole

uint8_t nl::Weave::Profiles::Time::Contact::mRole

contains TimeSyncRole.

casted to uint8_t to save space only valid if response is not kResponseStatus_Invalid

mTimeSinceLastSuccessfulSync_min

uint16_t nl::Weave::Profiles::Time::Contact::mTimeSinceLastSuccessfulSync_min

only valid if response is not kResponseStatus_Invalid

mUnadjTimestampLastContact_usec

timesync_t nl::Weave::Profiles::Time::Contact::mUnadjTimestampLastContact_usec

this is the timestamp when the response was received.

only valid if response is not kResponseStatus_Invalid