nl :: Tejido:: Perfiles: DataManagement_Current :: ResourceIdentifier
#include <src/lib/profiles/data-management/Current/ResourceIdentifier.h>
Una estructura que encapsula el ID de un recurso.
Resumen
El ResourceIdentifier puede ser bien un generalizada de 64 bits ID de objeto de un tipo particular o un UUID. Cuando se codifica externamente, se admiten las siguientes representaciones:
un entero de 64 bits sin signo correspondiente al objeto generalizado de tipo DEVICE con el ID especificado en la representación
una representación generalizada codificada como una cadena de bytes de 10 octetos. Los primeros dos octetos codifican el tipo de recurso como un entero little endian de 16 bits, y los 8 bytes restantes codifican un ID de recurso little endian de 64 bits.
ResourceIdentifiers también encarnan la convenciones presente en todo el código WDM: un vacío ResourceIdentifier corresponde a la ID de nodo del dispositivo, y constructores se proporcionan para los casos de uso más comunes.
Constructores y Destructores | |
---|---|
ResourceIdentifier () Construir un ResourceIdentifier correspondiente a un ResourceID no especificado. | |
ResourceIdentifier (const uint64_t & aNodeId) Construir un ResourceIdentifier del tipo de dispositivo basado en un hecho aNodeId. | |
ResourceIdentifier (uint16_t aResourceType, const uint64_t & aResourceId) Construir el ResourceIdentifier del tipo especificado con el ID dado. | |
ResourceIdentifier (uint16_t aResourceType, const uint8_t *aResourceId, size_t aResourceIdLen) Construir el ResourceIdentifier del tipo especificado con el ID dado. |
Tipos públicos | |
---|---|
@125 { | enumeración |
@126 | enumeración Define un valor especial para NodeId que se refiere a 'self'. |
@127 | enumeración |
Atributos públicos | |
---|---|
ResourceId | uint64_t |
ResourceIdBytes [8] | uint8_t |
Funciones publicas | |
---|---|
FromString (const char *inBuffer, size_t inBufferLen) | Analizar una representación de cadena canónica de un recurso en un objeto de recurso. |
FromString (const char *inBuffer, size_t inBufferLen, const uint64_t & aSelfNodeId) | Analizar una representación de cadena canónica de un recurso en un objeto de recurso. |
FromTLV (nl::Weave::TLV::TLVReader & aReader) | Deserializar un ResourceIdentifier de un TLV REPRESENTACIÓN a este objeto. |
FromTLV (nl::Weave::TLV::TLVReader & aReader, const uint64_t & aSelfNodeId) | Deserializar un ResourceIdentifier de un TLV REPRESENTACIÓN a este objeto. |
GetResourceId () const | uint64_t Una función de acceso para obtener el ResourceId. |
GetResourceType () const | uint16_t Una función de acceso para obtener ResourceType. |
ResourceTypeAsString (void) const | const char * Produce una representación de cadena del ResourceType. |
ToString (char *buffer, size_t bufferLen) | Convertir el ResourceIdentifier en una cadena imprimible. |
ToTLV (nl::Weave::TLV::TLVWriter & aWriter) const | Serializar el recurso a un TLV representación usando una etiqueta contexto Path :: ResourceID. |
ToTLV (nl::Weave::TLV::TLVWriter & aWriter, const uint64_t & aTag) const | Serializar el recurso a un TLV representación usando una etiqueta determinada. |
Funciones estáticas públicas | |
---|---|
ResourceTypeAsString (uint16_t aResourceType) | const char * Produce una representación de cadena de un tipo de recurso. |
Clases de amigos | |
---|---|
operator== | friend bool |
Tipos públicos
@ 125
@125
Propiedades | |
---|---|
RESOURCE_TYPE_RESERVED | Un tipo de recurso reservado. La enumeración se elige de manera que no entre en conflicto con los valores de enumeración de las enumeraciones Schema :: Weave ::: Common :: ResourceType. Por el momento, dos valores ResourceID son posibles para el tipo de recurso RESERVADO: a kNodeIdNotSpecified corresponde a un no inicializado ResourceIdentifier , y corresponde SELF_NODE_ID a un recurso que va a volver a asignar a uno mismo de cualquier otra representación. |
@ 126
@126
Define un valor especial para NodeId que se refiere a 'self'.
En ciertas interacciones WDM, tener un valor de recurso propio permite comprimir esa información, ya que es redundante para la identificación del nodo de origen del dispositivo expresada en el Weave. mensaje en sí
@ 127
@127
Atributos públicos
ResourceId
uint64_t ResourceId
ResourceIdBytes
uint8_t ResourceIdBytes[8]
Funciones publicas
FromString
WEAVE_ERROR FromString( const char *inBuffer, size_t inBufferLen )
Analizar una representación de cadena canónica de un recurso en un objeto de recurso.
Convierte la representación de cadena canónica de un recurso en un objeto de recurso. Tenga en cuenta que solo un subconjunto de recursos se puede representar como una cadena, en particular, la implementación de referencia en Weave solo analizará recursos de tipos canónicos como se expresa en ResourceTypeEnum.
Detalles | |||||
---|---|---|---|---|---|
Parámetros |
|
FromString
WEAVE_ERROR FromString( const char *inBuffer, size_t inBufferLen, const uint64_t & aSelfNodeId )
Analizar una representación de cadena canónica de un recurso en un objeto de recurso.
Convierte la representación de cadena canónica de un recurso en un objeto de recurso. Tenga en cuenta que solo un subconjunto de recursos se puede representar como una cadena, en particular, la implementación de referencia en Weave solo analizará recursos de tipos canónicos como se expresa en ResourceTypeEnum.
Detalles | |||||||
---|---|---|---|---|---|---|---|
Parámetros |
|
Desde TLV
WEAVE_ERROR FromTLV( nl::Weave::TLV::TLVReader & aReader )
Deserializar un ResourceIdentifier de un TLV REPRESENTACIÓN a este objeto.
Detalles | |||
---|---|---|---|
Parámetros |
| ||
Devoluciones | WEAVE_NO_ERROR en caso de éxito. Los errores de TLVReader si el ResourceIdentifier no puede ser leído correctamente. |
Desde TLV
WEAVE_ERROR FromTLV( nl::Weave::TLV::TLVReader & aReader, const uint64_t & aSelfNodeId )
Deserializar un ResourceIdentifier de un TLV REPRESENTACIÓN a este objeto.
Detalles | |||||
---|---|---|---|---|---|
Parámetros |
| ||||
Devoluciones | WEAVE_NO_ERROR en caso de éxito. Los errores de TLVReader si el ResourceIdentifier no puede ser leído correctamente. |
GetResourceId
uint64_t GetResourceId() const
Una función de acceso para obtener el ResourceId.
GetResourceType
uint16_t GetResourceType() const
Una función de acceso para obtener ResourceType.
ResourceIdentifier
ResourceIdentifier()
Construir un ResourceIdentifier correspondiente a un ResourceID no especificado.
El ID de recurso no especificado es una tupla que consta de un tipo de recurso RESERVADO con un recurso kNodeIdNotSpeficied.
ResourceIdentifier
ResourceIdentifier( const uint64_t & aNodeId )
Construir un ResourceIdentifier del tipo de dispositivo basado en un hecho aNodeId.
Detalles | |||
---|---|---|---|
Parámetros |
|
ResourceIdentifier
ResourceIdentifier( uint16_t aResourceType, const uint64_t & aResourceId )
Construir el ResourceIdentifier del tipo especificado con el ID dado.
Detalles | |||||
---|---|---|---|---|---|
Parámetros |
|
ResourceIdentifier
ResourceIdentifier( uint16_t aResourceType, const uint8_t *aResourceId, size_t aResourceIdLen )
Construir el ResourceIdentifier del tipo especificado con el ID dado.
Detalles | |||||||
---|---|---|---|---|---|---|---|
Parámetros |
|
ResourceTypeAsString
const char * ResourceTypeAsString( void ) const
Produce una representación de cadena del ResourceType.
Los tipos de recursos convertidos son los enumerados en ResourceTypeEnum.hy el 0 (correspondiente al RESOURCE_TYPE_RESERVED)
Encadenar
WEAVE_ERROR ToString( char *buffer, size_t bufferLen )
Convertir el ResourceIdentifier en una cadena imprimible.
Detalles | |||||
---|---|---|---|---|---|
Parámetros |
|
ToTLV
WEAVE_ERROR ToTLV( nl::Weave::TLV::TLVWriter & aWriter ) const
Serializar el recurso a un TLV representación usando una etiqueta contexto Path :: ResourceID.
Detalles | |||
---|---|---|---|
Parámetros |
|
ToTLV
WEAVE_ERROR ToTLV( nl::Weave::TLV::TLVWriter & aWriter, const uint64_t & aTag ) const
Serializar el recurso a un TLV representación usando una etiqueta determinada.
Detalles | |||||
---|---|---|---|---|---|
Parámetros |
|
Funciones estáticas públicas
ResourceTypeAsString
const char * ResourceTypeAsString( uint16_t aResourceType )
Produce una representación de cadena de un tipo de recurso.
Los tipos de recursos convertidos son los enumerados en ResourceTypeEnum.hy el 0 (correspondiente al RESOURCE_TYPE_RESERVED)
Detalles | |||
---|---|---|---|
Parámetros |
|
Clases de amigos
operador ==
friend bool operator==(const ResourceIdentifier &lhs, const ResourceIdentifier &rhs)