O Google tem o compromisso de promover a igualdade racial para as comunidades negras. Saiba como.

nl :: Tecer:: Perfis :: DataManagement_Legacy

Este namespace inclui todas as interfaces dentro do Weave para o perfil Weave Data Management (WDM) que está prestes a ser descontinuado.

Resumo

Enumerações

@103 {
kStatus_CancelSuccess = 0x0001,
kStatus_InvalidPath = 0x0013,
kStatus_UnknownTopic = 0x0014,
kStatus_IllegalReadRequest = 0x0015,
kStatus_IllegalWriteRequest = 0x0016,
kStatus_InvalidVersion = 0x0017,
kStatus_UnsupportedSubscriptionMode = 0x0018
}		 enum
@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
}		 enum
Tamanhos de piscina e mesa 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
}		 enum
Os tipos de mensagem do perfil WDM.
@168 {
kTransactionIdNotSpecified = 0,
kResponseTimeoutNotSpecified = 0,
kVersionNotSpecified = 0xFFFFFFFFFFFFFFFFULL,
kInstanceIdNotSpecified = 0,
kDefaultBindingTableIndex = 0,
kWeaveTLVTagLen = 8,
kWeaveTLVControlByteLen = 1
}		 enum
Constantes diversas específicas do WDM.
@169 {
kStatus_CancelSuccess = 0x0001,
kStatus_InvalidPath = 0x0013,
kStatus_UnknownTopic = 0x0014,
kStatus_IllegalReadRequest = 0x0015,
kStatus_IllegalWriteRequest = 0x0016,
kStatus_InvalidVersion = 0x0017,
kStatus_UnsupportedSubscriptionMode = 0x0018
}		 enum
Códigos de status específicos do 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
}		 enum
Tags do protocolo de gerenciamento de dados.
@171 {
kTopicIdPublisherSpecificMask = 0xFFFF000000000000ULL,
kTopicIdNotSpecified = 0x0000000000000000ULL,
kAnyTopicId = 0xFFFFFFFFFFFFFFFFULL
}		 enum
IDs de tópicos distintos.
WeaveTransportOption {
kTransport_TCP = 1,
kTransport_WRMP = 2,
kTransport_UDP = 3
}		 enum
Opções de transporte WDM.

Typedefs

TopicIdentifier typedef
uint64_t
O identificador do tópico.

Funções

CheckTLVType ( nl::Weave::TLV::TLVType aType,nl::Weave::TLV::TLVReader & aReader)
bool
Verifique se a TLV leitura elemento estar tem o esperado TLV tipo.
CheckWDMTag (uint32_t aTagNum,nl::Weave::TLV::TLVReader & aReader)
bool
Verifique uma tag específica do WDM.
CloseDataListElement (nl::Weave::TLV::TLVReader & aReader)
Pare de ler um elemento da lista de dados WDM.
CloseList (nl::Weave::TLV::TLVReader & aReader)
Pare de ler um caminho WDM ou lista de dados.
EncodeDeprecatedPath (TLVWriter & aWriter, const uint64_t & aTag, uint32_t aProfileId, const uint64_t & aInstanceId, uint32_t aPathLen, ...)
Codifique um caminho WDM com tags obsoletas e um ID de instância inteiro.
EncodeDeprecatedPath (TLVWriter & aWriter, const uint64_t & aTag, uint32_t aProfileId, const char *aInstanceId, uint32_t aPathLen, ...)
Codifique um caminho WDM com tags obsoletas e um ID de instância de string.
EncodePath (TLVWriter & aWriter, const uint64_t & aTag, uint32_t aProfileId, const uint64_t & aInstanceId, uint32_t aPathLen, ...)
Codifique um caminho WDM com um ID de instância de perfil inteiro.
EncodePath (TLVWriter & aWriter, const uint64_t & aTag, uint32_t aProfileId, const uint32_t aInstanceIdLen, const uint8_t *aInstanceId, uint32_t aPathLen, ...)
Codifique um caminho WDM com um ID de instância de matriz de bytes.
EncodePath (TLVWriter & aWriter, const uint64_t & aTag, uint32_t aProfileId, const char *aInstanceId, uint32_t aPathLen, ...)
Codifique um caminho WDM com um ID de instância de string.
EndDataListElement (nl::Weave::TLV::TLVWriter & aWriter)
Termine de escrever um elemento da lista de dados.
EndEncodePath (TLVWriter & aWriter, TLVType & mOuterContainer, WEAVE_ERROR mError)
EndList (nl::Weave::TLV::TLVWriter & aWriter)
Termine de escrever uma lista de caminhos ou lista de dados.
EndList ( ReferencedTLVData & aList,nl::Weave::TLV::TLVWriter & aWriter)
Termine de escrever uma lista de caminhos ou lista de dados.
IsPublisherSpecific (const TopicIdentifier & aTopicId)
bool
Verifique se um ID de tópico é específico do editor.
OpenDataList ( ReferencedTLVData & aDataList,nl::Weave::TLV::TLVReader & aReader)
Comece a ler uma lista de dados.
OpenDataListElement (nl::Weave::TLV::TLVReader & aReader,nl::Weave::TLV::TLVReader & aPathReader, uint64_t & aVersion)
Comece a ler um elemento da lista de dados.
OpenPathList ( ReferencedTLVData & aPathList,nl::Weave::TLV::TLVReader & aReader)
Comece a ler uma lista de caminhos.
PublisherSpecificTopicId (void)
Gere um ID de tópico específico do editor do zero.
SendStatusReport ( ExchangeContext *aExchangeCtx, StatusReport & aStatus)
StartDataList (nl::Weave::TLV::TLVWriter & aWriter)
Comece a escrever uma lista de dados.
StartDataList ( ReferencedTLVData & aDataList,nl::Weave::TLV::TLVWriter & aWriter)
Comece a escrever uma lista de dados para um determinado ReferencedTLVData objeto.
StartDataListElement (nl::Weave::TLV::TLVWriter & aWriter)
Comece a escrever um elemento da lista de dados.
StartEncodePath (TLVWriter & aWriter, const uint64_t & aTag, uint32_t aProfileId, TLVType & mOuterContainer, TLVType & mPath)
StartPathList (nl::Weave::TLV::TLVWriter & aWriter)
Comece a escrever uma lista de caminhos.
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 uma TLV elemento a ser lido tem a espera TLV tipo.
ValidateWDMTag (uint32_t aTagNum,nl::Weave::TLV::TLVReader & aReader)
Validar que uma TLV elemento a ser lido tem a tag WDM esperado.

Aulas

nl :: Weave :: Profiles :: DataManagement_Legacy :: Encadernação

O Binding classe gerencia o estado de comunicação em nome de uma entidade aplicativo usando Weave.

nl :: Weave :: Profiles :: DataManagement_Legacy :: ClientDataManager

Uma classe abstrata contendo definições de método de confirmação e indicação exigidas pelo cliente WDM.

nl :: Weave :: Profiles :: DataManagement_Legacy :: ClientNotifier

Uma classe auxiliar empregada quando o suporte de assinatura e notificação é desejado em um cliente WDM.

nl :: Weave :: Profiles :: DataManagement_Legacy :: DMClient

A classe base abstrata para clientes WDM específicos de aplicativos.

nl :: Weave :: Profiles :: DataManagement_Legacy :: DMPublisher

A classe base abstrata para editores WDM específicos de aplicativos.

nl :: Weave :: Profiles :: DataManagement_Legacy :: ProfileDatabase

O resumo ProfileDatabase classe auxiliar.

nl :: Weave :: Profiles :: DataManagement_Legacy :: ProtocolEngine

A classe de mecanismo do protocolo WDM.

nl :: Weave :: Profiles :: DataManagement_Legacy :: PublisherDataManager

Uma classe abstrata contendo definições de método de confirmação e notificação exigidas pelo editor WDM.

Enumerações

@ 103

 @103
Propriedades
kStatus_CancelSuccess

Este código de status legado significa que uma assinatura foi cancelada com sucesso.

Este código de status significa que uma assinatura foi cancelada com sucesso.

kStatus_IllegalReadRequest

Este código de status legado significa que o nó que faz uma solicitação para ler um determinado item de dados não tem permissão para fazê-lo.

Este código de status significa que o nó que faz uma solicitação para ler um determinado item de dados não tem permissão para fazê-lo.

kStatus_IllegalWriteRequest

Este código de status legado significa que o nó que faz uma solicitação para gravar um determinado item de dados não tem permissão para fazê-lo.

Este código de status significa que o nó que faz uma solicitação para gravar um item de dados específico não tem permissão para fazê-lo.

kStatus_InvalidPath

Este código de status legado significa que um caminho da lista de caminhos de um quadro de solicitação de visualização ou atualização não correspondeu ao esquema residente no nó do respondente.

Este código de status significa que um caminho da lista de caminhos de um quadro de solicitação de visualização ou atualização não correspondeu ao esquema residente no nó do respondente.

kStatus_InvalidVersion

Este código de status legado significa que a versão dos dados incluídos em uma solicitação de atualização não corresponde à versão mais recente no editor e, portanto, a atualização não pode ser aplicada.

Este código de status significa que a versão dos dados incluídos em uma solicitação de atualização não corresponde à versão mais recente do editor e, portanto, a atualização não pode ser aplicada.

kStatus_UnknownTopic

Este código de status legado significa que o identificador de tópico fornecido em uma solicitação de cancelamento ou notificação não correspondeu a nenhuma assinatura existente no nó de recebimento.

Este código de status significa que o identificador de tópico fornecido em uma solicitação de cancelamento ou notificação não correspondeu a nenhuma assinatura existente no nó de recebimento.

kStatus_UnsupportedSubscriptionMode

Este código de status legado significa que o modo de assinatura solicitado não é compatível com o dispositivo receptor.

Este código de status significa que o modo de assinatura solicitado não é compatível com o dispositivo receptor.

@ 166

 @166

Tamanhos de piscina e mesa WDM.

O WDM define vários pools e tabelas que são necessários para sua operação, como segue.

Pools de transações do cliente:

  • kViewPoolSize
  • kSubscribePoolSize
  • kCancelSubscriptionPoolSize
  • kUpdatePoolSize

Pools de transações do editor:

  • kNotifyPoolSize

Tabelas de mecanismo de protocolo:

  • kTransactionTableSize
  • kBindingTableSize

Tabelas relacionadas a assinaturas:

  • kNotifierTableSize (apenas cliente)
  • kSubscriptionMgrTableSize (apenas editor)

Note-se que estas são quantidades configuráveis e que os valores por plataformas aparecer no associada WeaveConfig.h .

Propriedades
kBindingTableSize

Este é o tamanho padrão da tabela de ligação no mecanismo de protocolo WDM.

Este valor pode ser configurado por meio de WEAVE_CONFIG_WDM_BINDING_TABLE_SIZE .

kCancelSubscriptionPoolSize

Este é o tamanho padrão do conjunto de transações de solicitação de cancelamento de assinatura para um cliente WDM.

Este valor pode ser configurado por meio de WEAVE_CONFIG_WDM_CANCEL_SUBSCRIPTION_POOL_SIZE .

kNotifierTableSize

Este é o tamanho padrão da tabela de notificação para clientes WDM.

Este valor pode ser configurado por meio de WEAVE_CONFIG_WDM_NOTIFIER_TABLE_SIZE .

kNotifyPoolSize

Este é o tamanho padrão do conjunto de transações de solicitação de notificação para um editor WDM.

Este valor pode ser configurado por meio de WEAVE_CONFIG_WDM_NOTIFY_POOL_SIZE .

kSubscribePoolSize

Este é o tamanho padrão do conjunto de transações de solicitação de assinatura para um cliente WDM.

Este valor pode ser configurado por meio de WEAVE_CONFIG_WDM_SUBSCRIBE_POOL_SIZE .

kSubscriptionMgrTableSize

Este é o tamanho padrão da tabela de assinatura para editores WDM.

Este valor pode ser configurado por meio de WEAVE_CONFIG_WDM_SUBSCRIPTION_MGR_TABLE_SIZE .

kTransactionTableSize

Este é o tamanho padrão da tabela de transações no mecanismo de protocolo WDM.

Este valor pode ser configurado por meio de WEAVE_CONFIG_WDM_TRANSACTION_TABLE_SIZE .

kUpdatePoolSize

Este é o tamanho padrão do conjunto de transações de solicitação de atualização para um cliente WDM.

Este valor pode ser configurado por meio de WEAVE_CONFIG_WDM_UPDATE_POOL_SIZE .

kViewPoolSize

Este é o tamanho padrão do pool de transações de solicitação de visualização para um cliente WDM.

Este valor pode ser configurado por meio de WEAVE_CONFIG_WDM_VIEW_POOL_SIZE .

@ 167

 @167

Os tipos de mensagem do perfil WDM.

Esses valores são chamados na especificação de gerenciamento de dados.

NOTA!! A partir do primeiro trimestre de 2015, os tipos de mensagem usados ​​nas versões anteriores do WDM foram descontinuados e novos tipos de mensagem foram definidos, refletindo uma mudança suficiente com detalhes de empacotamento e análise anteriores para justificar uma quebra limpa.

Propriedades
kMsgType_CancelSubscriptionRequest

Cancelar mensagem de solicitação de assinatura.

kMsgType_CancelSubscriptionRequest_Deprecated

descontinuada

kMsgType_NotifyRequest

Notificar mensagem de solicitação.

kMsgType_NotifyRequest_Deprecated

descontinuada

kMsgType_SubscribeRequest

Mensagem de solicitação de inscrição.

kMsgType_SubscribeRequest_Deprecated

descontinuada

kMsgType_SubscribeResponse

Assine a mensagem de resposta.

kMsgType_SubscribeResponse_Deprecated

descontinuada

kMsgType_UpdateRequest

Mensagem de solicitação de atualização.

kMsgType_UpdateRequest_Deprecated

descontinuada

kMsgType_ViewRequest

Veja a mensagem de solicitação.

kMsgType_ViewRequest_Deprecated

descontinuada

kMsgType_ViewResponse

Veja a mensagem de resposta.

kMsgType_ViewResponse_Deprecated

descontinuada

@ 168

 @168

Constantes diversas específicas do WDM.

Propriedades
kDefaultBindingTableIndex

O índice da ligação padrão em uma tabela de ligação do mecanismo de protocolo com mais de uma entrada.

kInstanceIdNotSpecified

Em chamadas que requerem uma especificação de instância de perfil, indica "nenhum".

Na maioria das vezes, isso significa que apenas uma instância do perfil está presente na entidade em questão.

kResponseTimeoutNotSpecified

Nos métodos que solicitam uma transação, indica que o chamador se recusou a especificar um tempo limite.

Geralmente, isso significa que um padrão deve ser usado.

kTransactionIdNotSpecified

Em métodos e estruturas de dados que usam um ID de transação, indica "nenhum" ou um valor curinga.

kVersionNotSpecified

Em chamadas que requerem a especificação de uma versão de dados, indica "nenhuma versão particular".

kWeaveTLVControlByteLen

O comprimento de um TLV byte de controle, utilizado em métodos de suporte que codificam estruturas WDM em TLV .

kWeaveTLVTagLen

O comprimento padrão em bytes de um completo qualificado TLV tag, utilizado em métodos de suporte que codificam estruturas WDM em TLV .

@ 169

 @169

Códigos de status específicos do WDM.

Propriedades
kStatus_CancelSuccess

Este código de status legado significa que uma assinatura foi cancelada com sucesso.

Este código de status significa que uma assinatura foi cancelada com sucesso.

kStatus_IllegalReadRequest

Este código de status legado significa que o nó que faz uma solicitação para ler um determinado item de dados não tem permissão para fazê-lo.

Este código de status significa que o nó que faz uma solicitação para ler um determinado item de dados não tem permissão para fazê-lo.

kStatus_IllegalWriteRequest

Este código de status legado significa que o nó que faz uma solicitação para gravar um determinado item de dados não tem permissão para fazê-lo.

Este código de status significa que o nó que faz uma solicitação para gravar um item de dados específico não tem permissão para fazê-lo.

kStatus_InvalidPath

Este código de status legado significa que um caminho da lista de caminhos de um quadro de solicitação de visualização ou atualização não correspondeu ao esquema residente no nó do respondente.

Este código de status significa que um caminho da lista de caminhos de um quadro de solicitação de visualização ou atualização não correspondeu ao esquema residente no nó do respondente.

kStatus_InvalidVersion

Este código de status legado significa que a versão dos dados incluídos em uma solicitação de atualização não corresponde à versão mais recente no editor e, portanto, a atualização não pode ser aplicada.

Este código de status significa que a versão dos dados incluídos em uma solicitação de atualização não corresponde à versão mais recente do editor e, portanto, a atualização não pode ser aplicada.

kStatus_UnknownTopic

Este código de status legado significa que o identificador de tópico fornecido em uma solicitação de cancelamento ou notificação não correspondeu a nenhuma assinatura existente no nó de recebimento.

Este código de status significa que o identificador de tópico fornecido em uma solicitação de cancelamento ou notificação não correspondeu a nenhuma assinatura existente no nó de recebimento.

kStatus_UnsupportedSubscriptionMode

Este código de status legado significa que o modo de assinatura solicitado não é compatível com o dispositivo receptor.

Este código de status significa que o modo de assinatura solicitado não é compatível com o dispositivo receptor.

@ 170

 @170

Tags do protocolo de gerenciamento de dados.

O protocolo de gestão de dados define um certo número de etiquetas para ser utilizado no TLV representação de dados de perfil.

Como de costume, há problemas de compatibilidade entre o novo WDM e o antigo. Antigamente, todas essas tags eram aplicadas como específicas de perfil, o que era uma perda de espaço. agora estamos usando tags de contexto sempre que possível, mas precisamos manter as antigas por perto (e ter um mecanismo para codificar caminhos com elas no lugar) quando apropriado.

A tag kTag_WDMDataListElementData não foi usada em versões anteriores e foi completamente ignorada pelo código, portanto, não precisamos fornecer uma versão obsoleta.

Propriedades
kTag_WDMDataList

O elemento é uma lista de estruturas contendo caminho, versão opcional e elementos de dados.

Tipo de tag: Tipo de elemento específico do perfil: Array Disposição: Nível superior

kTag_WDMDataListElementData

O elemento representa os dados apontados por determinado caminho e tendo a versão fornecida.

Tipo de tag: Tipo de elemento específico do contexto: Qualquer disposição: necessária

kTag_WDMDataListElementData_Deprecated

Descontinuada.

Tipo de tag: Tipo de elemento específico do contexto: Qualquer disposição: necessária

kTag_WDMDataListElementPath

O elemento é o componente do caminho de um elemento da lista de dados.

Tipo de tag: Tipo de elemento específico do contexto: Caminho Disposição: Obrigatório

kTag_WDMDataListElementPath_Deprecated

Descontinuada.

Tipo de tag: Tipo de elemento específico do perfil: Caminho Disposição: Obrigatório

kTag_WDMDataListElementVersion

O elemento é o componente da versão de um elemento da lista de dados.

Tipo de tag: Tipo de elemento específico do contexto: Inteiro Disposição: necessária

kTag_WDMDataListElementVersion_Deprecated

Descontinuada.

Tipo de tag: específico do perfil Tipo de elemento: Inteiro Disposição: necessária

kTag_WDMPathArrayIndexSelector

O elemento path corresponde a uma matriz no esquema e o elemento inteiro contido deve ser usado como um índice nessa matriz.

Tipo de tag: Tipo de elemento específico do perfil: Número inteiro Disposição: Opcional

kTag_WDMPathArrayValueSelector

O elemento path corresponde a uma matriz no esquema e o elemento encapsulado deve ser usado como um seletor de registro.

Tipo de tag: Tipo de elemento específico do perfil: Estrutura Disposição: Opcional

kTag_WDMPathList

O elemento é uma lista de TLV caminhos.

Tipo de tag: Tipo de elemento específico do perfil: Array Disposição: Nível superior

kTag_WDMPathProfile

O elemento é uma estrutura que é usada para iniciar um caminho e contém as informações do perfil à luz das quais as marcas no caminho devem ser interpretadas.

Tipo de tag: Tipo de elemento específico do perfil: Estrutura Disposição: Obrigatório

kTag_WDMPathProfileId

O elemento é um componente perfil ID do elemento de perfil caminho que começa a TLV caminho.

Tipo de tag: Tipo de elemento específico do contexto: Inteiro Disposição: necessária

kTag_WDMPathProfileId_Deprecated

Descontinuada.

Tipo de tag: específico do perfil Tipo de elemento: Inteiro Disposição: necessária

kTag_WDMPathProfileInstance

O elemento é um exemplo de perfil, que pode seguir o ID do perfil em um TLV caminho.

Observe que um nó pode ou não ter várias instâncias de um determinado perfil e, no caso de haver apenas um, este elemento pode ser omitido.

Tipo de tag: Tipo de elemento específico do contexto: Qualquer Disposição: Opcional

kTag_WDMPathProfileInstance_Deprecated

Descontinuada.

Tipo de tag: Tipo de elemento específico do perfil: Qualquer disposição: opcional

@ 171

 @171

IDs de tópicos distintos.

Existem três IDs de tópico distintos de interesse, todos os três formatados como "específicos do editor".

Propriedades
kAnyTopicId

Isso é reservado como um ID de tópico curinga.

kTopicIdNotSpecified

Este é um valor especial reservado para expressar um ID de tópico inválido ou curinga.

kTopicIdPublisherSpecificMask

Isso é usado como uma máscara para criar ou decompor um ID topci.

WeaveTransportOption

 WeaveTransportOption

Opções de transporte WDM.

Essas são opções de transporte mutuamente exclusivas para WDM.

Propriedades
kTransport_TCP

O transporte subjacente é o TCP.

A ligação pode ser concluída usando o gerenciador de serviço ou diretamente usando a camada de mensagem.

kTransport_UDP

O transporte subjacente é exclusivamente UDP.

kTransport_WRMP

O transporte subjacente é exclusivamente UDP, mas com aprimoramentos de confiabilidade da "camada de suporte de aplicativo".

Typedefs

TopicIdentifier

uint64_t TopicIdentifier

O identificador do tópico.

Os identificadores de tópico são quantidades de 64 bits com dois usos / semânticos relacionados. Em primeiro lugar, eles podem ser usados ​​como uma abreviatura convencional para um conjunto bem conhecido de caminhos, por exemplo, "o detector de fumaça Nest". Os IDs de tópico usados ​​dessa forma devem, como identificadores de perfil, conter um código de fornecedor que evita que os IDs de tópico escolhidos de forma autônoma por fornecedores distintos entrem em conflito, como segue:

bit 48 - 63 bit 0 - 47
ID do fornecedor Número do tópico
O segundo uso / semântica para identificadores de tópico surge nesse caso de uma assinatura dinâmica entre um cliente WDM e um editor. neste caso, o editor deve sempre fornecer um ID de tópico exclusivo que representa a assinatura específica e deve fazer isso se a assinatura foi solicitada usando um ID de tópico conhecido ou uma lista de caminho arbitrário. os identificadores de tópico desta forma são diferenciados por terem um código de fornecedor de 0xFFFF.

Veja também:
WeaveVendorIdentifiers.hpp

Funções

CheckTLVType

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

Verifique se a TLV leitura elemento estar tem o esperado TLV tipo.

Confira um determinado TLV tipo contra o tipo de elemento na cabeça de um TLV leitor.

Detalhes
Parâmetros
[in] aType
O TLVType a ser verificado em relação a um elemento específico
[in] aReader
Uma referência a um TLV leitor posicionado no elemento a ser verificado
Devoluções
verdadeiro sse o TLVType do elemento e um tipo de correspondência.
Veja também:
WeaveTLVTypes.h

CheckWDMTag

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

Verifique uma tag específica do WDM.

Verifique o número de uma marcação específica do WDM, a partir de ... / dados de gerenciamento / DMConstants.h, contra o tag real na cabeça de um TLV leitor.

Detalhes
Parâmetros
[in] aTagNum
O número da etiqueta a ser verificado contra um específico TLV elemento.
[in] aReader
Uma referência a um TLV leitor apontando para o elemento a ser verificado.
Devoluções
true iff aReader.GetTag () produz uma tag que corresponde a uma das formas de tag esperadas para o número de tag fornecido.

CloseDataListElement

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

Pare de ler um elemento da lista de dados WDM.

Este método assume que o elemento em questão faz parte de uma lista de dados WDM e então passa kTLVType_Array para ExitContainer ().

Detalhes
Parâmetros
[in,out] aReader
Um TLV leitor posicionado em um elemento da lista de dados WDM.
Devoluções
WEAVE_NO_ERROR Em caso de sucesso. Caso contrário devolver um WEAVE_ERROR reflecte uma incapacidade de sair de um recipiente.

CloseList

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

Pare de ler um caminho WDM ou lista de dados.

Este método assume que a lista em questão é o mais alto TLV elemento e assim passa kTLVType_Sructure para ExitContainer ().

Detalhes
Parâmetros
[in,out] aReader
Um TLV leitor posicionado num caminho WDM ou lista de dados.
Devoluções
WEAVE_NO_ERROR Em caso de sucesso. Caso contrário devolver um WEAVE_ERROR reflecte uma incapacidade de sair de um recipiente.

EncodeDeprecatedPath

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

Codifique um caminho WDM com tags obsoletas e um ID de instância inteiro.

Nota: Encode um caminho usando o conjunto de tag deprecated aceite pelo serviço antes Weave versão 2.0. Esta versão do método usa um identificador de instância numérico. Este método inicia um contêiner com ProfileTag (kWeaveProfile_WDM, kTag_WDMPathProfile) e, em seguida, insere o ID do perfil com ProfileTag (kWeaveProfile_WDM, kTag_WDMPathProfileId_Deprecated). Em seguida, ele insere o ID da instância com ProfileTag (kWeaveProfile_WDM, kTag_WDMPathProfileInstance_Deprecated). Esta é uma das versões obsoletas para codificação de um caminho e novos designs devem evitar o uso deste formato.

Detalhes
Parâmetros
[in] aWriter
Uma referência para o TLV escritor usado para escrever o caminho.
[in] aTag
Uma referência para o totalmente qualificado TLV tag que se aplica a este caminho.
[in] aProfileId
O ID do perfil sob o qual os elementos do caminho devem ser interpretados.
[in] aInstanceId
Uma referência ao ID de instância opcional do perfil a ser usado.
[in] aPathLen
O comprimento, possivelmente 0, da lista de elementos de caminho além do especificador de perfil inicial.
[in] ...
A lista opcional de comprimento variável de tags de caminho adicionais.
Devoluções
WEAVE_NO_ERROR Em caso de sucesso. Caso contrário retornar um WEAVE_ERROR refletindo uma incapacidade de formatar o caminho dado.

EncodeDeprecatedPath

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

Codifique um caminho WDM com tags obsoletas e um ID de instância de string.

Nota: Encode um caminho usando o conjunto de tag deprecated (veja DMConstants.h). Esta versão do método usa uma string de ID de instância. Este método inicia um contêiner com ProfileTag (kWeaveProfile_WDM, kTag_WDMPathProfile) e, em seguida, insere o ID do perfil com ProfileTag (kWeaveProfile_WDM, kTag_WDMPathProfileId_Deprecated). Em seguida, ele insere o ID da instância com ProfileTag (kWeaveProfile_WDM, kTag_WDMPathProfileInstance_Deprecated). Esta é uma das versões obsoletas para codificação de um caminho e novos designs devem evitar o uso deste formato.

Detalhes
Parâmetros
[in] aWriter
Uma referência para o TLV escritor usado para escrever o caminho.
[in] aTag
Uma referência para o totalmente qualificado TLV tag que se aplica a este caminho.
[in] aProfileId
O ID do perfil sob o qual os elementos do caminho devem ser interpretados.
[in] aInstanceId
A string opcional usada como um identificador de instância de perfil. Este argumento pode ser NULL se nenhum ID de instância for especificado.
[in] aPathLen
O comprimento, possivelmente 0, da lista de elementos de caminho além do especificador de perfil inicial.
[in] ...
A lista opcional de comprimento variável de tags de caminho adicionais.
Devoluções
WEAVE_NO_ERROR Em caso de sucesso. Caso contrário retornar um WEAVE_ERROR refletindo uma incapacidade de formatar o caminho dado.

EncodePath

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

Codifique um caminho WDM com um ID de instância de perfil inteiro.

Nota: Adicione uma TLV caminho do tipo utilizado na gestão de dados, onde, em particular, há uma designação perfil colocado no início, a fim de permitir a interpretação dos elementos de caminho subsequentes. Esta versão do método usa um ID de instância de perfil de número inteiro.

Este método insere o ID da instância usando ContextTag (kTag_WDMPathProfileInstance), que é a versão mais recente para codificar um caminho.

Detalhes
Parâmetros
[in] aWriter
Uma referência para o TLV escritor usado para escrever o caminho.
[in] aTag
Uma referência para o totalmente qualificado TLV tag que se aplica a este caminho.
[in] aProfileId
O ID do perfil sob o qual os elementos do caminho devem ser interpretados.
[in] aInstanceId
Uma referência ao identificador de instância opcional do perfil a ser usado. Se nenhum ID de instância for usado, este parâmetro deve ter um valor de kInstanceIdNotSpecified.
[in] aPathLen
O comprimento, possivelmente 0, da lista de elementos de caminho além do especificador de perfil inicial.
[in] ...
A lista opcional de comprimento variável de tags de caminho adicionais.
Devoluções
WEAVE_NO_ERROR Em caso de sucesso. Caso contrário retornar um WEAVE_ERROR refletindo uma incapacidade de formatar o caminho dado.

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 um caminho WDM com um ID de instância de matriz de bytes.

Nota: Adicione uma TLV caminho do tipo utilizado na gestão de dados, onde, em particular, há uma designação perfil colocado no início, a fim de permitir a interpretação dos elementos de caminho subsequentes. Esta versão do método usa um ID de instância de perfil de matriz de bytes junto com um comprimento.

Este método insere o ID da instância usando ContextTag (kTag_WDMPathProfileInstance), que é a versão mais recente para codificar um caminho.

Detalhes
Parâmetros
[in] aWriter
Uma referência para o TLV escritor usado para escrever o caminho.
[in] aTag
Uma referência para o totalmente qualificado TLV tag que se aplica a este caminho.
[in] aProfileId
O ID do perfil sob o qual os elementos do caminho devem ser interpretados.
[in] aInstanceIdLen
O comprimento da matriz de bytes que constitui o ID da instância. Se não houver ID, este parâmetro deve ter o valor 0.
[in] aInstanceId
A matriz de bytes opcional usada como um identificador de instância de perfil. Este argumento pode ser NULL no caso em que nenhum ID de instância é especificado.
[in] aPathLen
O comprimento, possivelmente 0, da lista de elementos de caminho além do especificador de perfil inicial.
[in] ...
A lista opcional de comprimento variável de tags de caminho adicionais.
Devoluções
WEAVE_NO_ERROR Em caso de sucesso. Caso contrário retornar um WEAVE_ERROR refletindo uma incapacidade de formatar o caminho dado.

EncodePath

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

Codifique um caminho WDM com um ID de instância de string.

Nota: Adicione uma TLV caminho do tipo utilizado na gestão de dados, onde, em particular, há uma designação perfil colocado no início, a fim de permitir a interpretação dos elementos de caminho subsequentes. Esta versão do método usa um ID de instância de perfil de string.

Este método insere o ID da instância usando ContextTag (kTag_WDMPathProfileInstance), que é a versão mais recente para codificar um caminho.

Detalhes
Parâmetros
[in] aWriter
Uma referência para o TLV escritor usado para escrever o caminho.
[in] aTag
Uma referência para o totalmente qualificado TLV tag que se aplica a este caminho.
[in] aProfileId
O ID do perfil sob o qual os elementos do caminho devem ser interpretados.
[in] aInstanceId
A string opcional usada como um identificador de instância de perfil. Este argumento pode ser NULL se nenhum ID de instância for especificado.
[in] aPathLen
O comprimento, possivelmente 0, da lista de elementos de caminho além do especificador de perfil inicial.
[in] ...
A lista opcional de comprimento variável de tags de caminho adicionais.
Devoluções
WEAVE_NO_ERROR Em caso de sucesso. Caso contrário retornar um WEAVE_ERROR refletindo uma incapacidade de formatar o caminho dado.

EndDataListElement

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

Termine de escrever um elemento da lista de dados.

Escreva o TLV para o final de um elemento da lista de dados WDM. Observe que isso passa automaticamente um tipo de kTLVType_Array para a chamada EndContainer (), assumindo que estamos sempre fechando um item da lista.

Detalhes
Parâmetros
[in] aWriter
Uma referência a um TLV escritor com o qual a escrever o final do item.
Devoluções
WEAVE_NO_ERROR Em caso de sucesso. Caso contrário devolver um WEAVE_ERROR reflecte uma incapacidade para acabar com um recipiente.

EndEncodePath

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

EndList

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

Termine de escrever uma lista de caminhos ou lista de dados.

Escreva o TLV para o final de um caminho WDM ou lista de dados. Além disso, finalize o escritor.

Detalhes
Parâmetros
[in,out] aWriter
Uma referência a um TLV escritor com o qual a escrever o final da lista.
Devoluções
WEAVE_NO_ERROR Em caso de sucesso. Caso contrário devolver um WEAVE_ERROR reflecte uma incapacidade para acabar com um recipiente.

EndList

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

Termine de escrever uma lista de caminhos ou lista de dados.

Escreva o TLV para o final de um caminho WDM ou lista de dados. Além disso, finalize o escritor. Neste caso, o ReferencedTLVData objecto ao qual o TLV está a ser escrito é passado e modificada de modo a reflectir a quantidade de dados gravados.

Detalhes
Parâmetros
[in,out] aList
Uma referência ao objeto ReferenceTLVData no qual a lista estava sendo gravada.
[in] aWriter
Uma referência a um TLV escritor com o qual a escrever o final da lista.
Devoluções
WEAVE_NO_ERROR Em caso de sucesso. Caso contrário devolver um WEAVE_ERROR reflecte uma incapacidade para acabar com um recipiente.

IsPublisherSpecific

bool IsPublisherSpecific(
  const TopicIdentifier & aTopicId
)

Verifique se um ID de tópico é específico do editor.

Detalhes
Parâmetros
[in] aTopicId
um identificador de tópico para verificar
Devoluções
verdadeiro se o ID do tópico for específico do editor, falso caso contrário

OpenDataList

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

Comece a ler uma lista de dados.

Com um novo leitor e uma lista de dados, comece a ler a lista e valide as tags e os tipos encontrados inicialmente no processo. Se tudo correr bem, o leitor para depois que o contêiner da lista é inserido.

Detalhes
Parâmetros
[in] aDataList
Uma lista de dados passada como uma referência a um ReferencedTLVData objecto. O caso de uso normal será quando a lista ainda estiver em um buffer após o recebimento.
[out] aReader
Uma referência a um TLV leitor usado para ler a lista de dados. Este leitor será deixado apontando antes do primeiro item da lista.
Devoluções
WEAVE_NO_ERROR Em caso de sucesso. Caso contrário retornar um WEAVE_ERROR refletindo uma falha a abrir a lista de dados e / ou validar as marcas e tipos relevantes.

OpenDataListElement

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

Comece a ler um elemento da lista de dados.

Dado um leitor posicionado em um elemento da lista de dados, comece a ler o elemento e valide as tags e os tipos encontrados inicialmente no processo. Se tudo correr bem, o leitor acaba posicionado nos dados do elemento de dados e o leitor do caminho de entrada / saída é posicionado no caminho correspondente.

Detalhes
Parâmetros
[in] aReader
Uma referência a um TLV leitor posicionado a um elemento da lista de dados.
[out] aPathReader
Uma referência a um TLV leitor para ser apontado para o componente do caminho do elemento da lista de dados.
[out] aVersion
Uma referência a um número inteiro de 64 bits a ser definido para a versão do elemento da lista de dados, se houver, ou para kVersionNotSpecified.
Devoluções
WEAVE_NO_ERROR em caso de sucesso, ou então um WEAVE_ERROR associado à abertura e lendo o elemento da lista de dados.

OpenPathList

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

Comece a ler uma lista de caminhos.

Dado um novo leitor e uma lista de caminhos, comece a ler a lista e valide as tags e tipos encontrados inicialmente no processo. Se tudo correr bem, o leitor para depois que o contêiner da lista é inserido.

Detalhes
Parâmetros
[in] aPathList
Uma lista caminho passada como uma referência a um ReferencedTLVData objecto. O caso de uso normal será quando a lista ainda estiver em um buffer após o recebimento.
[out] aReader
Uma referência a um TLV leitor usado para ler a lista do caminho. Este leitor será deixado apontando um pouco antes do primeiro caminho na lista.
Devoluções
WEAVE_NO_ERROR em caso de sucesso; Caso contrário, um WEAVE_ERROR refletindo uma falha a abrir a lista de caminho e / ou validar as marcas e tipos relevantes.

PublisherSpecificTopicId

TopicIdentifier PublisherSpecificTopicId(
  void
)

Gere um ID de tópico específico do editor do zero.

Detalhes
Devoluções
o novo identificador de tópico.

SendStatusReport

WEAVE_ERROR SendStatusReport(
  ExchangeContext *aExchangeCtx,
  StatusReport & aStatus
)

StartDataList

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

Comece a escrever uma lista de dados.

Escreva o TLV para o início de uma lista de dados WDM, por exemplo, como o argumento principal de um UpdateRequest ().

Detalhes
Parâmetros
[in] aWriter
Uma referência a um TLV escritor com que para começar a escrever.
Devoluções
WEAVE_NO_ERROR Em caso de sucesso. Caso contrário devolver um WEAVE_ERROR reflecte uma incapacidade para iniciar um recipiente.

StartDataList

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

Comece a escrever uma lista de dados para um determinado ReferencedTLVData objeto.

Escreva o TLV para o início de uma lista de dados WDM. Neste caso, assumimos que estamos escrevendo a lista de dados para um referenciada TLV estrutura de dados. O gravador é considerado não inicializado - ou, em qualquer caso, será inicializado para apontar para o objeto fornecido.

Detalhes
Parâmetros
[out] aDataList
Uma referência a um ReferencedTLVData objecto que está para ser o destino do escritor e, eventualmente, conter os dados de interesse.
[in] aWriter
Uma referência a um TLV escritor com que para começar a escrever.
Devoluções
WEAVE_NO_ERROR Em caso de sucesso. Caso contrário devolver um WEAVE_ERROR reflecte uma incapacidade para iniciar um recipiente.

StartDataListElement

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

Comece a escrever um elemento da lista de dados.

Escreva o TLV para o início de um elemento da lista de dados WDM.

Detalhes
Parâmetros
[in] aWriter
Uma referência a um TLV escritor com que para começar a escrever.
Devoluções
WEAVE_NO_ERROR Em caso de sucesso. Caso contrário devolver um WEAVE_ERROR reflecte uma incapacidade para iniciar um recipiente.

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
)

Comece a escrever uma lista de caminhos.

Escreva o TLV para o início de uma lista caminho WDM, por exemplo, como o argumento principal de um ViewRequest ().

Detalhes
Parâmetros
[in] aWriter
Uma referência a um TLV escritor com que para começar a escrever.
Devoluções
WEAVE_NO_ERROR Em caso de sucesso. Caso contrário devolver um WEAVE_ERROR reflecte uma incapacidade para iniciar um recipiente.

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 uma TLV elemento a ser lido tem a espera TLV tipo.

Confira um determinado TLV tipo contra o tipo de elemento na cabeça de um TLV leitor e retornar um erro se não houver correspondência.

Detalhes
Parâmetros
[in] aType
O TLVType a ser validado em relação a um elemento específico.
[in] aReader
Uma referência a um TLV leitor posicionado no elemento a ser validado.
Devoluções
WEAVE_NO_ERROR se houver uma correspondência ou WEAVE_ERROR_WRONG_TLV_TYPE se não.
Veja também:
WeaveTLVTypes.h

ValidateWDMTag

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

Validar que uma TLV elemento a ser lido tem a tag WDM esperado.

Detalhes
Parâmetros
[in] aTagNum
O número da marca de 32 bits da marca WDM esperada.
[in] aReader
Um TLV leitor posicionado no elemento a ser validado.
Devoluções
WEAVE_NO_ERROR Em caso de sucesso. Caso contrário WEAVE_ERROR_INVALID_TLV_TAG se o tag não corresponde ao número determinado tag quando interpretado como um tag WDM.