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

nl::Weave::Profiles::DeviceDescription::IdentifyRequestMessage

#include <src/lib/profiles/device-description/DeviceDescription.h>

Parsed form of an IdentifyRequest Message.

Summary

Inheritance

Inherits from: nl::Weave::Profiles::DeviceDescription::IdentifyDeviceCriteria

Public functions
Encode(PacketBuffer *msgBuf) const
Encodes this IdentifyRequestMessage object into the provided Inet buffer.

Public static functions
Decode(PacketBuffer *msgBuf, uint64_t msgDestNodeId, IdentifyRequestMessage & msg)
Decodes an Identify Request message from an Inet buffer into the provided IdentifyRequestMessage object.

Public functions

Encode

WEAVE_ERROR Encode(
  PacketBuffer *msgBuf
) const

Encodes this IdentifyRequestMessage object into the provided Inet buffer.

Details
Parameters
[in,out] msgBuf
A pointer to the Inet buffer to write the Identify Request message to.
Return Values
WEAVE_NO_ERROR
unconditionally.

Public static functions

Decode

WEAVE_ERROR Decode(
  PacketBuffer *msgBuf,
  uint64_t msgDestNodeId,
  IdentifyRequestMessage & msg
)

Decodes an Identify Request message from an Inet buffer into the provided IdentifyRequestMessage object.

Details
Parameters
[in] msgBuf
A pointer to the Inet buffer to decode the Identify Request message from.
[in] msgDestNodeId
The destination node ID of the message being decoded.
[in,out] msg
A reference to the IdentifyRequestMessage to populate.
Return Values
WEAVE_ERROR_INVALID_MESSAGE_LENGTH
If the provided buffer is an invalid length.
WEAVE_NO_ERROR
On success.