En Google, luchamos por la equidad racial de la comunidad negra. Más información

nl :: Tejido:: Perfiles: DataManagement_Legacy

Este espacio de nombres incluye todas las interfaces dentro de Weave para el perfil Weave Data Management (WDM) que están a punto de quedar obsoletas.

Resumen

Enumeraciones

@103 {
kStatus_CancelSuccess = 0x0001,
kStatus_InvalidPath = 0x0013,
kStatus_UnknownTopic = 0x0014,
kStatus_IllegalReadRequest = 0x0015,
kStatus_IllegalWriteRequest = 0x0016,
kStatus_InvalidVersion = 0x0017,
kStatus_UnsupportedSubscriptionMode = 0x0018
}
enumeración
@166 {
kViewPoolSize = WEAVE_CONFIG_WDM_VIEW_POOL_SIZE,
kSubscribePoolSize = WEAVE_CONFIG_WDM_SUBSCRIBE_POOL_SIZE,
kCancelSubscriptionPoolSize = WEAVE_CONFIG_WDM_CANCEL_SUBSCRIPTION_POOL_SIZE,
kUpdatePoolSize = WEAVE_CONFIG_WDM_UPDATE_POOL_SIZE,
kNotifyPoolSize = WEAVE_CONFIG_WDM_NOTIFY_POOL_SIZE,
kTransactionTableSize = WEAVE_CONFIG_WDM_TRANSACTION_TABLE_SIZE,
kBindingTableSize = WEAVE_CONFIG_WDM_BINDING_TABLE_SIZE,
kNotifierTableSize = WEAVE_CONFIG_WDM_NOTIFIER_TABLE_SIZE,
kSubscriptionMgrTableSize = WEAVE_CONFIG_WDM_SUBSCRIPTION_MGR_TABLE_SIZE
}
enumeración
Tamaños de mesa y billar WDM.
@167 {
kMsgType_ViewRequest = 0x10,
kMsgType_ViewResponse = 0x11,
kMsgType_SubscribeRequest = 0x12,
kMsgType_SubscribeResponse = 0x13,
kMsgType_CancelSubscriptionRequest = 0x14,
kMsgType_UpdateRequest = 0x15,
kMsgType_NotifyRequest = 0x16,
kMsgType_ViewRequest_Deprecated = 0x00,
kMsgType_ViewResponse_Deprecated = 0x01,
kMsgType_SubscribeRequest_Deprecated = 0x02,
kMsgType_SubscribeResponse_Deprecated = 0x03,
kMsgType_CancelSubscriptionRequest_Deprecated = 0x04,
kMsgType_UpdateRequest_Deprecated = 0x05,
kMsgType_NotifyRequest_Deprecated = 0x06
}
enumeración
Los tipos de mensajes del perfil WDM.
@168 {
kTransactionIdNotSpecified = 0,
kResponseTimeoutNotSpecified = 0,
kVersionNotSpecified = 0xFFFFFFFFFFFFFFFFULL,
kInstanceIdNotSpecified = 0,
kDefaultBindingTableIndex = 0,
kWeaveTLVTagLen = 8,
kWeaveTLVControlByteLen = 1
}
enumeración
Constantes diversas específicas de WDM.
@169 {
kStatus_CancelSuccess = 0x0001,
kStatus_InvalidPath = 0x0013,
kStatus_UnknownTopic = 0x0014,
kStatus_IllegalReadRequest = 0x0015,
kStatus_IllegalWriteRequest = 0x0016,
kStatus_InvalidVersion = 0x0017,
kStatus_UnsupportedSubscriptionMode = 0x0018
}
enumeración
Códigos de estado específicos de WDM.
@170 {
kTag_WDMPathList = 100,
kTag_WDMPathProfile = 101,
kTag_WDMPathProfileId = 1,
kTag_WDMPathProfileInstance = 2,
kTag_WDMPathProfileId_Deprecated = 102,
kTag_WDMPathProfileInstance_Deprecated = 103,
kTag_WDMPathArrayIndexSelector = 104,
kTag_WDMPathArrayValueSelector = 105,
kTag_WDMDataList = 200,
kTag_WDMDataListElementPath = 3,
kTag_WDMDataListElementVersion = 4,
kTag_WDMDataListElementData = 5,
kTag_WDMDataListElementPath_Deprecated = 201,
kTag_WDMDataListElementVersion_Deprecated = 202,
kTag_WDMDataListElementData_Deprecated = 203
}
enumeración
Etiquetas de protocolo de gestión de datos.
@171 {
kTopicIdPublisherSpecificMask = 0xFFFF000000000000ULL,
kTopicIdNotSpecified = 0x0000000000000000ULL,
kAnyTopicId = 0xFFFFFFFFFFFFFFFFULL
}
enumeración
ID de temas distinguidos.
WeaveTransportOption {
kTransport_TCP = 1,
kTransport_WRMP = 2,
kTransport_UDP = 3
}
enumeración
Opciones de transporte WDM.

Typedefs

TopicIdentifier typedef
uint64_t
El identificador de tema.

Funciones

CheckTLVType ( nl::Weave::TLV::TLVType aType,nl::Weave::TLV::TLVReader & aReader)
bool
Comprobar que un TLV elemento que se está leyendo tiene la esperada TLV tipo.
CheckWDMTag (uint32_t aTagNum,nl::Weave::TLV::TLVReader & aReader)
bool
Verifique una etiqueta específica de WDM.
CloseDataListElement (nl::Weave::TLV::TLVReader & aReader)
Deje de leer un elemento de la lista de datos de WDM.
CloseList (nl::Weave::TLV::TLVReader & aReader)
Deje de leer una ruta de WDM o una lista de datos.
EncodeDeprecatedPath (TLVWriter & aWriter, const uint64_t & aTag, uint32_t aProfileId, const uint64_t & aInstanceId, uint32_t aPathLen, ...)
Codifique una ruta WDM con etiquetas obsoletas y un ID de instancia entero.
EncodeDeprecatedPath (TLVWriter & aWriter, const uint64_t & aTag, uint32_t aProfileId, const char *aInstanceId, uint32_t aPathLen, ...)
Codifique una ruta WDM con etiquetas obsoletas y un ID de instancia de cadena.
EncodePath (TLVWriter & aWriter, const uint64_t & aTag, uint32_t aProfileId, const uint64_t & aInstanceId, uint32_t aPathLen, ...)
Codifique una ruta WDM con un ID de instancia de perfil entero.
EncodePath (TLVWriter & aWriter, const uint64_t & aTag, uint32_t aProfileId, const uint32_t aInstanceIdLen, const uint8_t *aInstanceId, uint32_t aPathLen, ...)
Codifique una ruta WDM con un ID de instancia de matriz de bytes.
EncodePath (TLVWriter & aWriter, const uint64_t & aTag, uint32_t aProfileId, const char *aInstanceId, uint32_t aPathLen, ...)
Codifique una ruta WDM con un ID de instancia de cadena.
EndDataListElement (nl::Weave::TLV::TLVWriter & aWriter)
Termine de escribir un elemento de lista de datos.
EndEncodePath (TLVWriter & aWriter, TLVType & mOuterContainer, WEAVE_ERROR mError)
EndList (nl::Weave::TLV::TLVWriter & aWriter)
Termine de escribir una lista de rutas o una lista de datos.
EndList ( ReferencedTLVData & aList,nl::Weave::TLV::TLVWriter & aWriter)
Termine de escribir una lista de rutas o una lista de datos.
IsPublisherSpecific (const TopicIdentifier & aTopicId)
bool
Compruebe si el ID de un tema es específico de un editor.
OpenDataList ( ReferencedTLVData & aDataList,nl::Weave::TLV::TLVReader & aReader)
Empiece a leer una lista de datos.
OpenDataListElement (nl::Weave::TLV::TLVReader & aReader,nl::Weave::TLV::TLVReader & aPathReader, uint64_t & aVersion)
Empiece a leer un elemento de la lista de datos.
OpenPathList ( ReferencedTLVData & aPathList,nl::Weave::TLV::TLVReader & aReader)
Empiece a leer una lista de rutas.
PublisherSpecificTopicId (void)
Genere un ID de tema específico del editor desde cero.
SendStatusReport ( ExchangeContext *aExchangeCtx, StatusReport & aStatus)
StartDataList (nl::Weave::TLV::TLVWriter & aWriter)
Empiece a escribir una lista de datos.
StartDataList ( ReferencedTLVData & aDataList,nl::Weave::TLV::TLVWriter & aWriter)
Comience a escribir una lista de datos a un determinado ReferencedTLVData objeto.
StartDataListElement (nl::Weave::TLV::TLVWriter & aWriter)
Empiece a escribir un elemento de la lista de datos.
StartEncodePath (TLVWriter & aWriter, const uint64_t & aTag, uint32_t aProfileId, TLVType & mOuterContainer, TLVType & mPath)
StartPathList (nl::Weave::TLV::TLVWriter & aWriter)
Empiece a escribir una lista de rutas.
TxnResponseHandler ( ExchangeContext *anExchangeCtx, const IPPacketInfo *anAddrInfo, const WeaveMessageInfo *aMsgInfo, uint32_t aProfileId, uint8_t aMsgType, PacketBuffer *aMsg)
void
TxnTimeoutHandler ( ExchangeContext *anExchangeCtx)
void
ValidateTLVType ( nl::Weave::TLV::TLVType aType,nl::Weave::TLV::TLVReader & aReader)
Validar que un TLV elemento que se tiene la lectura esperada TLV tipo.
ValidateWDMTag (uint32_t aTagNum,nl::Weave::TLV::TLVReader & aReader)
Validar que un TLV elemento de bienestar lectura tiene la etiqueta WDM esperado.

Clases

nl :: Armadura :: Perfiles :: :: DataManagement_Legacy Encuadernación

La encuadernación de clase administra el estado de las comunicaciones en nombre de una entidad de aplicación usando la armadura.

nl :: Armadura :: Perfiles :: :: DataManagement_Legacy ClientDataManager

Una clase abstracta que contiene las definiciones de métodos de confirmación e indicación requeridas por el cliente WDM.

nl :: Armadura :: Perfiles :: :: DataManagement_Legacy ClientNotifier

Una clase auxiliar empleada cuando se desea soporte de notificación y suscripción en un cliente WDM.

nl :: Armadura :: Perfiles :: :: DataManagement_Legacy DMClient

La clase base abstracta para clientes WDM específicos de la aplicación.

nl :: Armadura :: Perfiles :: :: DataManagement_Legacy DMPublisher

La clase base abstracta para editores de WDM específicos de la aplicación.

nl :: Armadura :: Perfiles :: :: DataManagement_Legacy ProfileDatabase

El resumen ProfileDatabase clase auxiliar.

nl :: Armadura :: Perfiles :: :: DataManagement_Legacy ProtocolEngine

La clase de motor de protocolo WDM.

nl :: Armadura :: Perfiles :: :: DataManagement_Legacy PublisherDataManager

Una clase abstracta que contiene las definiciones de métodos de confirmación y notificación requeridas por el editor de WDM.

Enumeraciones

@ 103

 @103
Propiedades
kStatus_CancelSuccess

Este código de estado heredado significa que una suscripción se canceló correctamente.

Este código de estado significa que una suscripción se canceló correctamente.

kStatus_IllegalReadRequest

Este código de estado heredado significa que el nodo que solicita leer un elemento de datos en particular no tiene permiso para hacerlo.

Este código de estado significa que el nodo que solicita leer un elemento de datos en particular no tiene permiso para hacerlo.

kStatus_IllegalWriteRequest

Este código de estado heredado significa que el nodo que solicita escribir un elemento de datos en particular no tiene permiso para hacerlo.

Este código de estado significa que el nodo que solicita escribir un elemento de datos en particular no tiene permiso para hacerlo.

kStatus_InvalidPath

Este código de estado heredado significa que una ruta de la lista de rutas de una vista o marco de solicitud de actualización no coincidía con el esquema residente en el nodo del respondedor.

Este código de estado significa que una ruta de la lista de rutas de una vista o marco de solicitud de actualización no coincidía con el esquema residente en el nodo del respondedor.

kStatus_InvalidVersion

Este código de estado heredado significa que la versión de los datos incluidos en una solicitud de actualización no coincidía con la versión más reciente del editor y, por lo tanto, no se pudo aplicar la actualización.

Este código de estado significa que la versión de los datos incluidos en una solicitud de actualización no coincidía con la versión más reciente del editor y, por lo tanto, no se pudo aplicar la actualización.

kStatus_UnknownTopic

Este código de estado heredado significa que el identificador de tema proporcionado en una solicitud de cancelación o notificación no coincide con ninguna suscripción existente en el nodo receptor.

Este código de estado significa que el identificador de tema proporcionado en una solicitud de cancelación o notificación no coincide con ninguna suscripción existente en el nodo receptor.

kStatus_UnsupportedSubscriptionMode

Este código de estado heredado significa que el dispositivo receptor no admite el modo de suscripción solicitado.

Este código de estado significa que el dispositivo receptor no admite el modo de suscripción solicitado.

@ 166

 @166

Tamaños de mesa y billar WDM.

WDM define varios grupos y tablas que se necesitan para su funcionamiento, de la siguiente manera.

Grupos de transacciones de clientes:

  • kViewPoolSize
  • kSubscribePoolSize
  • kCancelSubscriptionPoolSize
  • kUpdatePoolSize

Grupos de transacciones del editor:

  • kNotifyPoolSize

Tablas del motor de protocolo:

  • kTransactionTableSize
  • kBindingTableSize

Tablas relacionadas con la suscripción:

  • kNotifierTableSize (solo cliente)
  • kSubscriptionMgrTableSize (solo editor)

Tenga en cuenta que estos son cantidades configurables y que los valores por la plataforma aparecen en la asociada WeaveConfig.h .

Propiedades
kBindingTableSize

Este es el tamaño predeterminado de la tabla de enlace en el motor de protocolo WDM.

Este valor se puede configurar a través de WEAVE_CONFIG_WDM_BINDING_TABLE_SIZE .

kCancelSubscriptionPoolSize

Este es el tamaño predeterminado del grupo de transacciones de solicitud de cancelación de suscripción para un cliente WDM.

Este valor se puede configurar a través de WEAVE_CONFIG_WDM_CANCEL_SUBSCRIPTION_POOL_SIZE .

kNotifierTableSize

Este es el tamaño predeterminado de la tabla de notificaciones para clientes WDM.

Este valor se puede configurar a través de WEAVE_CONFIG_WDM_NOTIFIER_TABLE_SIZE .

kNotifyPoolSize

Este es el tamaño predeterminado del grupo de transacciones de solicitud de notificación para un editor de WDM.

Este valor se puede configurar a través de WEAVE_CONFIG_WDM_NOTIFY_POOL_SIZE .

kSubscribePoolSize

Este es el tamaño predeterminado del grupo de transacciones de solicitud de suscripción para un cliente WDM.

Este valor se puede configurar a través de WEAVE_CONFIG_WDM_SUBSCRIBE_POOL_SIZE .

kSubscriptionMgrTableSize

Este es el tamaño predeterminado de la tabla de suscripción para los editores de WDM.

Este valor se puede configurar a través de WEAVE_CONFIG_WDM_SUBSCRIPTION_MGR_TABLE_SIZE .

kTransactionTableSize

Este es el tamaño predeterminado de la tabla de transacciones en el motor de protocolo WDM.

Este valor se puede configurar a través de WEAVE_CONFIG_WDM_TRANSACTION_TABLE_SIZE .

kUpdatePoolSize

Este es el tamaño predeterminado del grupo de transacciones de solicitud de actualización para un cliente WDM.

Este valor se puede configurar a través de WEAVE_CONFIG_WDM_UPDATE_POOL_SIZE .

kViewPoolSize

Este es el tamaño predeterminado del grupo de transacciones de solicitud de vista para un cliente WDM.

Este valor se puede configurar a través de WEAVE_CONFIG_WDM_VIEW_POOL_SIZE .

@ 167

 @167

Los tipos de mensajes del perfil WDM.

Estos valores se indican en la especificación de gestión de datos.

¡¡NOTA!! A partir del primer trimestre de 2015, los tipos de mensajes utilizados en versiones anteriores de WDM han quedado obsoletos y se han definido nuevos tipos de mensajes, lo que refleja un cambio suficiente con los detalles de empaquetado y análisis anteriores para justificar una ruptura limpia.

Propiedades
kMsgType_CancelSubscriptionRequest

Cancelar mensaje de solicitud de suscripción.

kMsgType_CancelSubscriptionRequest_Deprecated

obsoleto

kMsgType_NotifyRequest

Notificar mensaje de solicitud.

kMsgType_NotifyRequest_Deprecated

obsoleto

kMsgType_SubscribeRequest

Suscribir mensaje de solicitud.

kMsgType_SubscribeRequest_Deprecated

obsoleto

kMsgType_SubscribeResponse

Suscribirse mensaje de respuesta.

kMsgType_SubscribeResponse_Deprecated

obsoleto

kMsgType_UpdateRequest

Mensaje de solicitud de actualización.

kMsgType_UpdateRequest_Deprecated

obsoleto

kMsgType_ViewRequest

Ver mensaje de solicitud.

kMsgType_ViewRequest_Deprecated

obsoleto

kMsgType_ViewResponse

Ver mensaje de respuesta.

kMsgType_ViewResponse_Deprecated

obsoleto

@ 168

 @168

Constantes diversas específicas de WDM.

Propiedades
kDefaultBindingTableIndex

El índice del enlace predeterminado en una tabla de enlace de motor de protocolo con más de una entrada.

kInstanceIdNotSpecified

En las llamadas que requieren una especificación de instancia de perfil, indica "ninguno".

La mayoría de las veces, esto significa que solo una instancia del perfil está presente en la entidad en cuestión.

kResponseTimeoutNotSpecified

En los métodos que solicitan una transacción, indica que la persona que llama se ha negado a especificar un tiempo de espera.

Generalmente, esto significa que se debe utilizar un valor predeterminado.

kTransactionIdNotSpecified

En métodos y estructuras de datos que toman un ID de transacción, indica "ninguno" o un valor comodín.

kVersionNotSpecified

En las llamadas que requieren la especificación de una versión de datos, indica "ninguna versión en particular".

kWeaveTLVControlByteLen

La longitud de un TLV byte de control, que se utiliza en métodos de apoyo que las estructuras de codificar WDM en TLV .

kWeaveTLVTagLen

La longitud estándar en bytes de un calificado completo TLV etiqueta, usado en los métodos de apoyo que las estructuras de codificar WDM en TLV .

@ 169

 @169

Códigos de estado específicos de WDM.

Propiedades
kStatus_CancelSuccess

Este código de estado heredado significa que una suscripción se canceló correctamente.

Este código de estado significa que una suscripción se canceló correctamente.

kStatus_IllegalReadRequest

Este código de estado heredado significa que el nodo que solicita leer un elemento de datos en particular no tiene permiso para hacerlo.

Este código de estado significa que el nodo que solicita leer un elemento de datos en particular no tiene permiso para hacerlo.

kStatus_IllegalWriteRequest

Este código de estado heredado significa que el nodo que solicita escribir un elemento de datos en particular no tiene permiso para hacerlo.

Este código de estado significa que el nodo que solicita escribir un elemento de datos en particular no tiene permiso para hacerlo.

kStatus_InvalidPath

Este código de estado heredado significa que una ruta de la lista de rutas de una vista o marco de solicitud de actualización no coincidía con el esquema residente en el nodo del respondedor.

Este código de estado significa que una ruta de la lista de rutas de una vista o marco de solicitud de actualización no coincidía con el esquema residente en el nodo del respondedor.

kStatus_InvalidVersion

Este código de estado heredado significa que la versión de los datos incluidos en una solicitud de actualización no coincidía con la versión más reciente del editor y, por lo tanto, no se pudo aplicar la actualización.

Este código de estado significa que la versión de los datos incluidos en una solicitud de actualización no coincidía con la versión más reciente del editor y, por lo tanto, no se pudo aplicar la actualización.

kStatus_UnknownTopic

Este código de estado heredado significa que el identificador de tema proporcionado en una solicitud de cancelación o notificación no coincide con ninguna suscripción existente en el nodo receptor.

Este código de estado significa que el identificador de tema proporcionado en una solicitud de cancelación o notificación no coincide con ninguna suscripción existente en el nodo receptor.

kStatus_UnsupportedSubscriptionMode

Este código de estado heredado significa que el dispositivo receptor no admite el modo de suscripción solicitado.

Este código de estado significa que el dispositivo receptor no admite el modo de suscripción solicitado.

@ 170

 @170

Etiquetas de protocolo de gestión de datos.

El protocolo de gestión de datos define un número de etiquetas para ser utilizado en el TLV representación de datos del perfil.

Como es habitual, existen problemas de compatibilidad entre el nuevo WDM y el antiguo. En los viejos tiempos, todas estas etiquetas se aplicaban como específicas del perfil, lo que era una pérdida de espacio. ahora estamos usando etiquetas de contexto siempre que sea posible, pero necesitamos mantener las antiguas (y tener un mecanismo para codificar rutas con ellas) donde sea apropiado.

La etiqueta kTag_WDMDataListElementData no se usó en versiones anteriores y el código la ignoró por completo, por lo que no tenemos que proporcionar una versión obsoleta.

Propiedades
kTag_WDMDataList

El elemento es una lista de estructuras que contienen la ruta, la versión opcional y los elementos de datos.

Tipo de etiqueta: Tipo de elemento específico del perfil: Disposición de matriz: Nivel superior

kTag_WDMDataListElementData

El elemento representa los datos apuntados por una ruta dada y que tienen la versión dada.

Tipo de etiqueta: Tipo de elemento específico del contexto: Cualquier disposición: Obligatorio

kTag_WDMDataListElementData_Deprecated

Obsoleto.

Tipo de etiqueta: Tipo de elemento específico del contexto: Cualquier disposición: Obligatorio

kTag_WDMDataListElementPath

El elemento es el componente de ruta de un elemento de lista de datos.

Tipo de etiqueta: Contexto específico Tipo de elemento: Ruta Disposición: Obligatorio

kTag_WDMDataListElementPath_Deprecated

Obsoleto.

Tipo de etiqueta: Tipo de elemento específico del perfil: Disposición de ruta: Obligatorio

kTag_WDMDataListElementVersion

El elemento es el componente de versión de un elemento de lista de datos.

Tipo de etiqueta: Contexto específico Tipo de elemento: Entero Disposición: Requerido

kTag_WDMDataListElementVersion_Deprecated

Obsoleto.

Tipo de etiqueta: Tipo de elemento específico del perfil: Entero Disposición: Requerido

kTag_WDMPathArrayIndexSelector

El elemento de ruta corresponde a una matriz en el esquema y el elemento entero contenido se utilizará como índice en esa matriz.

Tipo de etiqueta: Tipo de elemento específico del perfil: Entero Disposición: Opcional

kTag_WDMPathArrayValueSelector

El elemento de ruta corresponde a una matriz en el esquema y el elemento encapsulado se utilizará como selector de registros.

Tipo de etiqueta: Tipo de elemento específico del perfil: Disposición de la estructura: Opcional

kTag_WDMPathList

El elemento es una lista de TLV caminos.

Tipo de etiqueta: Tipo de elemento específico del perfil: Disposición de matriz: Nivel superior

kTag_WDMPathProfile

El elemento es una estructura que se utiliza para iniciar una ruta y contiene la información del perfil a la luz de la cual se interpretarán las etiquetas de la ruta.

Tipo de etiqueta: Tipo de elemento específico del perfil: Disposición de la estructura: Requerido

kTag_WDMPathProfileId

El elemento es un componente de ID de perfil del elemento de perfil del trayecto que comienza un TLV camino.

Tipo de etiqueta: Contexto específico Tipo de elemento: Entero Disposición: Requerido

kTag_WDMPathProfileId_Deprecated

Obsoleto.

Tipo de etiqueta: Tipo de elemento específico del perfil: Entero Disposición: Requerido

kTag_WDMPathProfileInstance

El elemento es un ejemplo de perfil, que puede seguir a la ID de perfil en un TLV camino.

Tenga en cuenta que un nodo puede tener o no múltiples instancias de un perfil particular y, en el caso de que solo haya uno, este elemento puede omitirse.

Tipo de etiqueta: Contexto específico Tipo de elemento: Cualquiera Disposición: Opcional

kTag_WDMPathProfileInstance_Deprecated

Obsoleto.

Tipo de etiqueta: Tipo de elemento específico del perfil: Cualquiera Disposición: Opcional

@ 171

 @171

ID de temas distinguidos.

Hay tres identificadores de temas de interés distinguidos, los tres tienen el formato "específico del editor".

Propiedades
kAnyTopicId

Esto está reservado como un ID de tema comodín.

kTopicIdNotSpecified

Este es un valor especial reservado para expresar un ID de tema inválido o comodín.

kTopicIdPublisherSpecificMask

Se utiliza como máscara para crear o descomponer un ID de topci.

Opción De Transporte De Tejido

 WeaveTransportOption

Opciones de transporte WDM.

Estas son opciones de transporte mutuamente excluyentes para WDM.

Propiedades
kTransport_TCP

El transporte subyacente es TCP.

La vinculación se puede completar utilizando el administrador de servicios o directamente utilizando la capa de mensajes.

kTransport_UDP

El transporte subyacente es exclusivamente UDP.

kTransport_WRMP

El transporte subyacente es exclusivamente UDP pero con mejoras de confiabilidad de la "capa de soporte de aplicaciones".

Typedefs

TopicIdentifier

uint64_t TopicIdentifier

El identificador de tema.

Los identificadores de tema son cantidades de 64 bits con dos usos / semánticos relacionados. En primer lugar, se pueden utilizar como una abreviatura convencional para un conjunto de caminos bien conocido, por ejemplo, "el detector de humo Nest". Los ID de tema que se utilizan de esta manera, al igual que los identificadores de perfil, deben contener un código de proveedor que evite que los ID de tema elegidos de forma autónoma por distintos proveedores entren en conflicto, como se indica a continuación:

bit 48 - 63 bit 0 - 47
ID de proveedor Número de tema
El segundo uso / semántica de los identificadores de temas surge en ese caso de una suscripción dinámica entre un cliente WDM y un editor. en este caso, el editor siempre proporcionará un ID de tema único que representa la suscripción específica y lo hará tanto si la suscripción se solicitó utilizando un ID de tema conocido como una lista de ruta arbitraria. Los identificadores de tema de este formulario se distinguen por tener un código de proveedor de 0xFFFF.

Ver también:
WeaveVendorIdentifiers.hpp

Funciones

CheckTLVType

bool CheckTLVType(
  nl::Weave::TLV::TLVType aType,
  nl::Weave::TLV::TLVReader & aReader
)

Comprobar que un TLV elemento que se está leyendo tiene la esperada TLV tipo.

Disponibilidad de una dada TLV tipo contra el tipo de elemento en la cabeza de un TLV lector.

Detalles
Parámetros
[in] aType
El TLVType que se va a comparar con un elemento específico
[in] aReader
Una referencia a un TLV lector colocado en el elemento de comprobación
Devoluciones
Es verdadero si el TLVType del elemento y unType coinciden.
Ver también:
WeaveTLVTypes.h

CheckWDMTag

bool CheckWDMTag(
  uint32_t aTagNum,
  nl::Weave::TLV::TLVReader & aReader
)

Verifique una etiqueta específica de WDM.

Compruebe el número de una etiqueta de WDM-específica, desde ... / datos de gestión / DMConstants.h, en contra de la etiqueta real en la cabeza de un TLV lector.

Detalles
Parámetros
[in] aTagNum
El número de la etiqueta de comprobación contra una específica TLV elemento.
[in] aReader
Una referencia a un TLV lector que apunta al elemento de comprobación.
Devoluciones
true iff aReader.GetTag () produce una etiqueta que coincide con una de las formas de etiqueta esperadas para el número de etiqueta dado.

CloseDataListElement

WEAVE_ERROR CloseDataListElement(
  nl::Weave::TLV::TLVReader & aReader
)

Deje de leer un elemento de la lista de datos de WDM.

Este método asume que el elemento en cuestión es parte de una lista de datos WDM y, por lo tanto, pasa kTLVType_Array a ExitContainer ().

Detalles
Parámetros
[in,out] aReader
A TLV lector colocado en un elemento de lista de datos WDM.
Devoluciones
WEAVE_NO_ERROR éxito On. De lo contrario, devolver un WEAVE_ERROR que refleja la incapacidad de salir de un contenedor.

CerrarLista

WEAVE_ERROR CloseList(
  nl::Weave::TLV::TLVReader & aReader
)

Deje de leer una ruta de WDM o una lista de datos.

Este método supone que la lista en cuestión es la más alta TLV elemento y así pasa a kTLVType_Sructure ExitContainer ().

Detalles
Parámetros
[in,out] aReader
A TLV lector colocado en una trayectoria de WDM o lista de datos.
Devoluciones
WEAVE_NO_ERROR éxito On. De lo contrario, devolver un WEAVE_ERROR que refleja la incapacidad de salir de un contenedor.

EncodeDeprecatedPath

WEAVE_ERROR EncodeDeprecatedPath(
  TLVWriter & aWriter,
  const uint64_t & aTag,
  uint32_t aProfileId,
  const uint64_t & aInstanceId,
  uint32_t aPathLen,
  ...
)

Codifique una ruta WDM con etiquetas obsoletas y un ID de instancia entero.

Nota: Codificar una ruta con el desuso conjunto de etiquetas aceptado por el servicio antes de la liberación de la armadura 2.0. Esta versión del método toma un identificador de instancia numérico. Este método inicia un contenedor con ProfileTag (kWeaveProfile_WDM, kTag_WDMPathProfile) y luego inserta el ID de perfil con ProfileTag (kWeaveProfile_WDM, kTag_WDMPathProfileId_Deprecated). Luego inserta el ID de la instancia con ProfileTag (kWeaveProfile_WDM, kTag_WDMPathProfileInstance_Deprecated). Esta es una de las versiones obsoletas para codificar una ruta, y los nuevos diseños deben evitar el uso de este formato.

Detalles
Parámetros
[in] aWriter
Una referencia a la TLV escritor utiliza para escribir la ruta de acceso.
[in] aTag
Una referencia a la totalmente calificado TLV etiqueta que se aplica a este camino.
[in] aProfileId
El ID de perfil bajo el cual se interpretarán los elementos de la ruta.
[in] aInstanceId
Una referencia al ID de instancia opcional del perfil que se utilizará.
[in] aPathLen
La longitud, posiblemente 0, de la lista de elementos de ruta más allá del especificador de perfil inicial.
[in] ...
La lista opcional de longitud variable de etiquetas de ruta adicionales.
Devoluciones
WEAVE_NO_ERROR éxito On. De lo contrario, devolver un WEAVE_ERROR que refleja la incapacidad para dar formato a la ruta dada.

EncodeDeprecatedPath

WEAVE_ERROR EncodeDeprecatedPath(
  TLVWriter & aWriter,
  const uint64_t & aTag,
  uint32_t aProfileId,
  const char *aInstanceId,
  uint32_t aPathLen,
  ...
)

Codifique una ruta WDM con etiquetas obsoletas y un ID de instancia de cadena.

Nota: Codificar una ruta con el conjunto de etiquetas en desuso (ver DMConstants.h). Esta versión del método toma una cadena de ID de instancia. Este método inicia un contenedor con ProfileTag (kWeaveProfile_WDM, kTag_WDMPathProfile) y luego inserta el ID de perfil con ProfileTag (kWeaveProfile_WDM, kTag_WDMPathProfileId_Deprecated). Luego inserta el ID de la instancia con ProfileTag (kWeaveProfile_WDM, kTag_WDMPathProfileInstance_Deprecated). Esta es una de las versiones obsoletas para codificar una ruta, y los nuevos diseños deben evitar el uso de este formato.

Detalles
Parámetros
[in] aWriter
Una referencia a la TLV escritor utiliza para escribir la ruta de acceso.
[in] aTag
Una referencia a la totalmente calificado TLV etiqueta que se aplica a este camino.
[in] aProfileId
El ID de perfil bajo el cual se interpretarán los elementos de la ruta.
[in] aInstanceId
La cadena opcional utilizada como identificador de instancia de perfil. Este argumento puede ser NULL si no se especifica ningún ID de instancia.
[in] aPathLen
La longitud, posiblemente 0, de la lista de elementos de ruta más allá del especificador de perfil inicial.
[in] ...
La lista opcional de longitud variable de etiquetas de ruta adicionales.
Devoluciones
WEAVE_NO_ERROR éxito On. De lo contrario, devolver un WEAVE_ERROR que refleja la incapacidad para dar formato a la ruta dada.

EncodePath

WEAVE_ERROR EncodePath(
  TLVWriter & aWriter,
  const uint64_t & aTag,
  uint32_t aProfileId,
  const uint64_t & aInstanceId,
  uint32_t aPathLen,
  ...
)

Codifique una ruta WDM con un ID de instancia de perfil entero.

Nota: Escribir un TLV ruta del tipo de los utilizados en la gestión de datos en el que, en particular, no es una designación perfil se coloca al comienzo con el fin de permitir la interpretación de los elementos de ruta posteriores. Esta versión del método toma un ID de instancia de perfil entero.

Este método inserta el ID de la instancia mediante ContextTag (kTag_WDMPathProfileInstance), que es la última versión para codificar una ruta.

Detalles
Parámetros
[in] aWriter
Una referencia a la TLV escritor utiliza para escribir la ruta de acceso.
[in] aTag
Una referencia a la totalmente calificado TLV etiqueta que se aplica a este camino.
[in] aProfileId
El ID de perfil bajo el cual se interpretarán los elementos de la ruta.
[in] aInstanceId
Una referencia al identificador de instancia opcional del perfil que se utilizará. Si no se va a utilizar ningún ID de instancia, este parámetro debe tener un valor de kInstanceIdNotSpecified.
[in] aPathLen
La longitud, posiblemente 0, de la lista de elementos de ruta más allá del especificador de perfil inicial.
[in] ...
La lista opcional de longitud variable de etiquetas de ruta adicionales.
Devoluciones
WEAVE_NO_ERROR éxito On. De lo contrario, devolver un WEAVE_ERROR que refleja la incapacidad para dar formato a la ruta dada.

EncodePath

WEAVE_ERROR EncodePath(
  TLVWriter & aWriter,
  const uint64_t & aTag,
  uint32_t aProfileId,
  const uint32_t aInstanceIdLen,
  const uint8_t *aInstanceId,
  uint32_t aPathLen,
  ...
)

Codifique una ruta WDM con un ID de instancia de matriz de bytes.

Nota: Escribir un TLV ruta del tipo de los utilizados en la gestión de datos en el que, en particular, no es una designación perfil se coloca al comienzo con el fin de permitir la interpretación de los elementos de ruta posteriores. Esta versión del método toma un ID de instancia de perfil de matriz de bytes junto con una longitud.

Este método inserta el ID de la instancia mediante ContextTag (kTag_WDMPathProfileInstance), que es la última versión para codificar una ruta.

Detalles
Parámetros
[in] aWriter
Una referencia a la TLV escritor utiliza para escribir la ruta de acceso.
[in] aTag
Una referencia a la totalmente calificado TLV etiqueta que se aplica a este camino.
[in] aProfileId
El ID de perfil bajo el cual se interpretarán los elementos de la ruta.
[in] aInstanceIdLen
La longitud de la matriz de bytes que constituye el ID de instancia. Si no hay ID, este parámetro tendrá un valor de 0.
[in] aInstanceId
La matriz de bytes opcional utilizada como identificador de instancia de perfil. Este argumento puede ser NULL en el caso de que no se especifique un ID de instancia.
[in] aPathLen
La longitud, posiblemente 0, de la lista de elementos de ruta más allá del especificador de perfil inicial.
[in] ...
La lista opcional de longitud variable de etiquetas de ruta adicionales.
Devoluciones
WEAVE_NO_ERROR éxito On. De lo contrario, devolver un WEAVE_ERROR que refleja la incapacidad para dar formato a la ruta dada.

EncodePath

WEAVE_ERROR EncodePath(
  TLVWriter & aWriter,
  const uint64_t & aTag,
  uint32_t aProfileId,
  const char *aInstanceId,
  uint32_t aPathLen,
  ...
)

Codifique una ruta WDM con un ID de instancia de cadena.

Nota: Escribir un TLV ruta del tipo de los utilizados en la gestión de datos en el que, en particular, no es una designación perfil se coloca al comienzo con el fin de permitir la interpretación de los elementos de ruta posteriores. Esta versión del método toma un ID de instancia de perfil de cadena.

Este método inserta el ID de la instancia mediante ContextTag (kTag_WDMPathProfileInstance), que es la última versión para codificar una ruta.

Detalles
Parámetros
[in] aWriter
Una referencia a la TLV escritor utiliza para escribir la ruta de acceso.
[in] aTag
Una referencia a la totalmente calificado TLV etiqueta que se aplica a este camino.
[in] aProfileId
El ID de perfil bajo el cual se interpretarán los elementos de la ruta.
[in] aInstanceId
La cadena opcional utilizada como identificador de instancia de perfil. Este argumento puede ser NULL si no se especifica ningún ID de instancia.
[in] aPathLen
La longitud, posiblemente 0, de la lista de elementos de ruta más allá del especificador de perfil inicial.
[in] ...
La lista opcional de longitud variable de etiquetas de ruta adicionales.
Devoluciones
WEAVE_NO_ERROR éxito On. De lo contrario, devolver un WEAVE_ERROR que refleja la incapacidad para dar formato a la ruta dada.

EndDataListElement

WEAVE_ERROR EndDataListElement(
  nl::Weave::TLV::TLVWriter & aWriter
)

Termine de escribir un elemento de lista de datos.

Escribir el TLV para el final de un elemento de lista de datos WDM. Tenga en cuenta que esto pasa automáticamente en un tipo de kTLVType_Array a la llamada EndContainer () asumiendo que siempre estamos cerrando un elemento de la lista.

Detalles
Parámetros
[in] aWriter
Una referencia a un TLV escritor con el que escribir el final del artículo.
Devoluciones
WEAVE_NO_ERROR éxito On. De lo contrario devolver un WEAVE_ERROR que refleja la incapacidad para poner fin a un recipiente.

EndEncodePath

WEAVE_ERROR EndEncodePath(
  TLVWriter & aWriter,
  TLVType & mOuterContainer,
  WEAVE_ERROR mError
)

EndList

WEAVE_ERROR EndList(
  nl::Weave::TLV::TLVWriter & aWriter
)

Termine de escribir una lista de rutas o una lista de datos.

Escribir el TLV para el final de un camino WDM o lista de datos. Además, finalice el escritor.

Detalles
Parámetros
[in,out] aWriter
Una referencia a un TLV escritor con el que escribir el final de la lista.
Devoluciones
WEAVE_NO_ERROR éxito On. De lo contrario devolver un WEAVE_ERROR que refleja la incapacidad para poner fin a un recipiente.

EndList

WEAVE_ERROR EndList(
  ReferencedTLVData & aList,
  nl::Weave::TLV::TLVWriter & aWriter
)

Termine de escribir una lista de rutas o una lista de datos.

Escribir el TLV para el final de un camino WDM o lista de datos. Además, finalice el escritor. En este caso, la ReferencedTLVData objeto al que el TLV está siendo escrito se pasa en y modificado para reflejar la cantidad de datos escritos.

Detalles
Parámetros
[in,out] aList
Una referencia al objeto ReferenceTLVData en el que se estaba escribiendo la lista.
[in] aWriter
Una referencia a un TLV escritor con el que escribir el final de la lista.
Devoluciones
WEAVE_NO_ERROR éxito On. De lo contrario devolver un WEAVE_ERROR que refleja la incapacidad para poner fin a un recipiente.

IsPublisherSpecific

bool IsPublisherSpecific(
  const TopicIdentifier & aTopicId
)

Compruebe si el ID de un tema es específico del editor.

Detalles
Parámetros
[in] aTopicId
un identificador de tema para comprobar
Devoluciones
Es true si el ID del tema es específico del editor; en caso contrario, es false.

OpenDataList

WEAVE_ERROR OpenDataList(
  ReferencedTLVData & aDataList,
  nl::Weave::TLV::TLVReader & aReader
)

Empiece a leer una lista de datos.

Con un lector nuevo y una lista de datos, comience a leer la lista y valide las etiquetas y los tipos que se encontraron inicialmente en el proceso. Si todo va bien, el lector se detiene después de ingresar al contenedor de la lista.

Detalles
Parámetros
[in] aDataList
Una lista de datos pasado como una referencia a un ReferencedTLVData objeto. El caso de uso normal será donde la lista todavía esté en un búfer después de la recepción.
[out] aReader
Una referencia a un TLV lector utilizado para leer la lista de datos. Este lector se dejará apuntando justo antes del primer elemento de la lista.
Devoluciones
WEAVE_NO_ERROR éxito On. De lo contrario, devolver un WEAVE_ERROR que refleja un fracaso del abra la lista de datos y / o validar las etiquetas y los tipos pertinentes.

OpenDataListElement

WEAVE_ERROR OpenDataListElement(
  nl::Weave::TLV::TLVReader & aReader,
  nl::Weave::TLV::TLVReader & aPathReader,
  uint64_t & aVersion
)

Empiece a leer un elemento de la lista de datos.

Dado un lector colocado en un elemento de la lista de datos, comience a leer el elemento y valide las etiquetas y los tipos que se encontraron inicialmente en el proceso. Si todo va bien, el lector termina posicionado en los datos del elemento de datos y el lector de ruta de entrada / salida se coloca en la ruta correspondiente.

Detalles
Parámetros
[in] aReader
Una referencia a un TLV lector colocado en un elemento de la lista de datos.
[out] aPathReader
Una referencia a un TLV lector a señalar en el componente de la ruta del elemento de lista de datos.
[out] aVersion
Una referencia a un entero de 64 bits que se establecerá en la versión del elemento de la lista de datos si hay uno presente o en kVersionNotSpecified.
Devoluciones
WEAVE_NO_ERROR en caso de éxito o de lo contrario un WEAVE_ERROR asociados con la apertura y lectura del elemento de lista de datos.

OpenPathList

WEAVE_ERROR OpenPathList(
  ReferencedTLVData & aPathList,
  nl::Weave::TLV::TLVReader & aReader
)

Empiece a leer una lista de rutas.

Con un lector nuevo y una lista de rutas, comience a leer la lista y valide las etiquetas y los tipos que se encontraron inicialmente en el proceso. Si todo va bien, el lector se detiene después de ingresar al contenedor de la lista.

Detalles
Parámetros
[in] aPathList
Una lista de rutas pasado como una referencia a un ReferencedTLVData objeto. El caso de uso normal será donde la lista todavía esté en un búfer después de la recepción.
[out] aReader
Una referencia a un TLV lector utilizado para leer la lista de rutas. Este lector quedará apuntando justo antes de la primera ruta de la lista.
Devoluciones
WEAVE_NO_ERROR en el éxito; de lo contrario, un WEAVE_ERROR que refleja un fracaso de la abrir la lista de rutas y / o validar las etiquetas y los tipos pertinentes.

PublisherSpecificTopicId

TopicIdentifier PublisherSpecificTopicId(
  void
)

Genere un ID de tema específico del editor desde cero.

Detalles
Devoluciones
el nuevo identificador de tema.

SendStatusReport

WEAVE_ERROR SendStatusReport(
  ExchangeContext *aExchangeCtx,
  StatusReport & aStatus
)

StartDataList

WEAVE_ERROR StartDataList(
  nl::Weave::TLV::TLVWriter & aWriter
)

Empiece a escribir una lista de datos.

Escribir el TLV para el comienzo de una lista de datos WDM, por ejemplo, como el argumento principal de un UpdateRequest ().

Detalles
Parámetros
[in] aWriter
Una referencia a un TLV escritor con el que empezar a escribir.
Devoluciones
WEAVE_NO_ERROR éxito On. De lo contrario, devolver un WEAVE_ERROR que refleja la incapacidad de iniciar un contenedor.

StartDataList

WEAVE_ERROR StartDataList(
  ReferencedTLVData & aDataList,
  nl::Weave::TLV::TLVWriter & aWriter
)

Comience a escribir una lista de datos a un determinado ReferencedTLVData objeto.

Escribir el TLV para el comienzo de una lista de datos WDM. En este caso, se supone que estamos escribiendo la lista de datos a una referencia TLV estructura de datos. Se supone que el escritor no está inicializado o, en cualquier caso, se inicializará para apuntar al objeto dado.

Detalles
Parámetros
[out] aDataList
Una referencia a un ReferencedTLVData objeto que ha de ser el objetivo del escritor y, finalmente, contiene los datos de interés.
[in] aWriter
Una referencia a un TLV escritor con el que empezar a escribir.
Devoluciones
WEAVE_NO_ERROR éxito On. De lo contrario, devolver un WEAVE_ERROR que refleja la incapacidad de iniciar un contenedor.

StartDataListElement

WEAVE_ERROR StartDataListElement(
  nl::Weave::TLV::TLVWriter & aWriter
)

Empiece a escribir un elemento de la lista de datos.

Escribir el TLV para el comienzo de un elemento de lista de datos WDM.

Detalles
Parámetros
[in] aWriter
Una referencia a un TLV escritor con el que empezar a escribir.
Devoluciones
WEAVE_NO_ERROR éxito On. De lo contrario, devolver un WEAVE_ERROR que refleja la incapacidad de iniciar un contenedor.

StartEncodePath

WEAVE_ERROR StartEncodePath(
  TLVWriter & aWriter,
  const uint64_t & aTag,
  uint32_t aProfileId,
  TLVType & mOuterContainer,
  TLVType & mPath
)

StartPathList

WEAVE_ERROR StartPathList(
  nl::Weave::TLV::TLVWriter & aWriter
)

Empiece a escribir una lista de rutas.

Escribir el TLV para el comienzo de una lista de rutas de WDM, por ejemplo, como el argumento principal de un ViewRequest ().

Detalles
Parámetros
[in] aWriter
Una referencia a un TLV escritor con el que empezar a escribir.
Devoluciones
WEAVE_NO_ERROR éxito On. De lo contrario, devolver un WEAVE_ERROR que refleja la incapacidad de iniciar un contenedor.

TxnResponseHandler

void TxnResponseHandler(
  ExchangeContext *anExchangeCtx,
  const IPPacketInfo *anAddrInfo,
  const WeaveMessageInfo *aMsgInfo,
  uint32_t aProfileId,
  uint8_t aMsgType,
  PacketBuffer *aMsg
)

TxnTimeoutHandler

void TxnTimeoutHandler(
  ExchangeContext *anExchangeCtx
)

ValidateTLVType

WEAVE_ERROR ValidateTLVType(
  nl::Weave::TLV::TLVType aType,
  nl::Weave::TLV::TLVReader & aReader
)

Validar que un TLV elemento que se tiene la lectura esperada TLV tipo.

Comprobar un determinado TLV tipo contra el tipo de elemento a la cabeza de un TLV lector y devolverá un error si no hay ninguna coincidencia.

Detalles
Parámetros
[in] aType
El TLVType que se va a validar con un elemento específico.
[in] aReader
Una referencia a un TLV lector posicionado en el elemento a ser validada.
Devoluciones
WEAVE_NO_ERROR si hay una coincidencia o una WEAVE_ERROR_WRONG_TLV_TYPE si no.
Ver también:
WeaveTLVTypes.h

Validar WDMTag

WEAVE_ERROR ValidateWDMTag(
  uint32_t aTagNum,
  nl::Weave::TLV::TLVReader & aReader
)

Validar que un TLV elemento de bienestar lectura tiene la etiqueta WDM esperado.

Detalles
Parámetros
[in] aTagNum
El número de etiqueta de 32 bits de la etiqueta WDM esperada.
[in] aReader
A TLV lector posicionado en el elemento a ser validada.
Devoluciones
WEAVE_NO_ERROR éxito On. De lo contrario WEAVE_ERROR_INVALID_TLV_TAG si la etiqueta no coincide con el número de la etiqueta dada cuando se interpreta como una etiqueta WDM.