nl::Weave::Profiles::DeviceDescription::IdentifyResponseMessage

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

Parsed form of an IdentifyResponse Message.

Summary

Public attributes
DeviceDesc
A device descriptor describing the responding device.

Public functions
Encode(PacketBuffer *msgBuf)
Encodes this IdentifyResponseMessage object into the provided message buffer.

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

Public attributes

DeviceDesc

WeaveDeviceDescriptor DeviceDesc

A device descriptor describing the responding device.

Public functions

Encode

WEAVE_ERROR Encode(
  PacketBuffer *msgBuf
)

Encodes this IdentifyResponseMessage object into the provided message buffer.

Details
Parameters
[in,out] msgBuf
A pointer to the Inet buffer to write the Identify Response message to.
Return Values
WEAVE_NO_ERROR
On success.
other
Other Weave or platform-specific error codes indicating that an error occurred preventing the encoding of the IdentifyResponseMessage.

Public static functions

Decode

WEAVE_ERROR Decode(
  PacketBuffer *msgBuf,
  IdentifyResponseMessage & msg
)

Decodes an Identify Response message from an Inet buffer into the provided IdentifyResponseMessage object.

Details
Parameters
[in] msgBuf
A pointer to the Inet buffer to decode the Identify Request message from.
[out] msg
A reference to the IdentifyRequestMessage to populate.
Return Values
WEAVE_ERROR_WRONG_TLV_TYPE
If this is not Device Description TLV.
WEAVE_ERROR_UNEXPECTED_TLV_ELEMENT
If more TLV data is encountered after the Device Description.
WEAVE_NO_ERROR
On success.
other
Other Weave or platform-specific error codes indicating that an error occurred preventing the decoding of the IdentifyResponseMessage.