nl::Weave::Support

Resumo

Typedefs

MessageNameFunct)(uint32_t inProfileId, uint8_t inMsgType) typedef
const char *(*
Typedef para uma função de callback que retorna uma string C legível e terminada em NULL descrevendo o tipo de mensagem associado ao identificador de perfil especificado.
ProfileNameFunct)(uint32_t inProfileId) typedef
const char *(*
Typedef para uma função de callback que retorna uma string C legível e terminada em NULL que descreve o perfil com o identificador de perfil especificado.
StatusReportFormatStringFunct)(uint32_t inProfileId, uint16_t inStatusCode) typedef
const char *(*
Typedef para uma função de callback que retorna uma string C legível e terminada em NULL que descreve o código de status associado ao identificador de perfil especificado.

Variáveis

sProfileStringContextHead
Ponteiro do registro vinculado individualmente.

remotas

FindProfileStringContext(const ProfileStringContext & inContext)
Encontre um contexto de suporte para a string de perfil correspondente ao contexto especificado, com base no identificador de perfil associado ao contexto.
FindProfileStringInfo(uint32_t inProfileId)
NL_DLL_EXPORT const ProfileStringInfo *
Encontre, se registrada, a string de perfil que permite callbacks associados ao identificador de perfil especificado.
InsertProfileStringContext(ProfileStringContext & inOutContext)
bool
Insira o contexto de suporte da string de perfil especificada no registro.
RegisterProfileStringInfo(ProfileStringContext & inOutContext)
NL_DLL_EXPORT WEAVE_ERROR
Registre as chamadas de suporte da string de perfil fornecida.
RemoveProfileStringContext(ProfileStringContext & inOutContext)
bool
Remove do registro o contexto de suporte da string de perfil especificada.
UnregisterProfileStringInfo(ProfileStringContext & inOutContext)
NL_DLL_EXPORT WEAVE_ERROR
Cancele o registro das chamadas de suporte da string de perfil fornecida.

Estruturas

nl::Weave::Support::ProfileStringContext

Contexto para registrar e cancelar o registro de callbacks associados ao identificador de perfil especificado para retornar strings de suporte legíveis associadas ao perfil.

nl::Weave::Support::ProfileStringInfo

Callbacks associados ao identificador de perfil especificado para retornar strings de suporte legíveis por humanos associadas ao perfil.

Typedefs

MessageNameFunct

const char *(* MessageNameFunct)(uint32_t inProfileId, uint8_t inMsgType)

Typedef para uma função de callback que retorna uma string C legível e terminada em NULL descrevendo o tipo de mensagem associado ao identificador de perfil especificado.

Esse callback, quando registrado, é invocado quando é necessária uma string C legível por humanos e terminada em NULL para descrever o tipo de mensagem associado ao identificador de perfil especificado.

Detalhes
Parâmetros
[in] inProfileId
O identificador de perfil associado ao tipo de mensagem especificado.
[in] inMsgType
O tipo de mensagem que busca uma string descritiva legível.
Retorna
um ponteiro para a string C terminada em NULL se uma correspondência for encontrada; caso contrário, NULL.

ProfileNameFunct

const char *(* ProfileNameFunct)(uint32_t inProfileId)

Typedef para uma função de callback que retorna uma string C legível e terminada em NULL que descreve o perfil com o identificador de perfil especificado.

Esse callback, quando registrado, é invocado quando é necessária uma string C legível por humanos e terminada em NULL para descrever o perfil com o identificador de perfil especificado.

Detalhes
Parâmetros
[in] inProfileId
O identificador do perfil para o qual uma string descritiva legível é procurada.
Retorna
um ponteiro para a string C terminada em NULL se uma correspondência for encontrada; caso contrário, NULL.

StatusReportFormatStringFunct

const char *(* StatusReportFormatStringFunct)(uint32_t inProfileId, uint16_t inStatusCode)

Typedef para uma função de callback que retorna uma string C legível e terminada em NULL que descreve o código de status associado ao identificador de perfil especificado.

Esse callback, quando registrado, é invocado quando é necessária uma string C legível por humanos e terminada em NULL para descrever o código de status associado ao identificador de perfil especificado.

Detalhes
Parâmetros
[in] inProfileId
O identificador de perfil associado ao código de status especificado.
[in] inStatusCode
O código de status para o qual uma string descritiva legível é procurada.
Retorna
um ponteiro para a string C terminada em NULL se uma correspondência for encontrada; caso contrário, NULL.

Variáveis

sProfileStringContextHead

ProfileStringContext * sProfileStringContextHead

Ponteiro do registro vinculado individualmente.

remotas

FindProfileStringContext

ProfileStringContext * FindProfileStringContext(
  const ProfileStringContext & inContext
)

Encontre um contexto de suporte para a string de perfil correspondente ao contexto especificado, com base no identificador de perfil associado ao contexto.

Essa função encontra um contexto de suporte para a string de perfil correspondente ao contexto especificado, com base no identificador de perfil associado ao contexto.

Detalhes
Parâmetros
[in] inContext
Uma referência somente leitura ao contexto de suporte da string de perfil a ser encontrado.
Retorna
um ponteiro somente leitura para a string de perfil, é compatível com o contexto, se encontrado; caso contrário, NULL.

FindProfileStringInfo

NL_DLL_EXPORT const ProfileStringInfo * FindProfileStringInfo(
  uint32_t inProfileId
)

Encontre, se registrada, a string de perfil que permite callbacks associados ao identificador de perfil especificado.

Detalhes
Parâmetros
[in] inProfileId
O identificador de perfil para o qual encontrar callbacks de suporte a string.
Retorna
um ponteiro somente leitura para a string do perfil oferece suporte a callbacks, se encontrados; caso contrário, NULL.
Consulte também:
RegisterProfielStringInfo
UnregisterProfielStringInfo

InsertProfileStringContext

bool InsertProfileStringContext(
  ProfileStringContext & inOutContext
)

Insira o contexto de suporte da string de perfil especificada no registro.

Essa função insere o contexto de suporte da string de perfil especificada no registro, se ainda não estiver presente, em ordem classificada, com base no identificador do perfil crescente.

Detalhes
Parâmetros
[in,out] inOutContext
Uma referência ao contexto de suporte da string de perfil que será inserido no registro. Enquanto o contexto estiver presente no registro, o campo "mNext" poderá ser modificado à medida que outros contextos forem inseridos ou removidos.
Retorna
verdadeiro se o contexto tiver sido inserido; caso contrário, falso.

RegisterProfileStringInfo

NL_DLL_EXPORT WEAVE_ERROR RegisterProfileStringInfo(
  ProfileStringContext & inOutContext
)

Registre as chamadas de suporte da string de perfil fornecida.

Essa função registra e disponibiliza a string de perfil fornecida e oferece suporte a callbacks.

Detalhes
Parâmetros
[in,out] inOutContext
Uma referência à string de perfil de contexto de suporte que será registrada e adicionada ao registro. Enquanto o contexto estiver registrado, o campo "mNext" poderá ser modificado à medida que outros contextos forem registrados ou tiver o registro cancelado.
Valores de retorno
WEAVE_NO_ERROR
Se der certo.
WEAVE_ERROR_PROFILE_STRING_CONTEXT_ALREADY_REGISTERED
Se o contexto já estiver registrado.
Consulte também:
FindStringProfileInfo
UnregisterProfielStringInfo

RemoveProfileStringContext

bool RemoveProfileStringContext(
  ProfileStringContext & inOutContext
)

Remove do registro o contexto de suporte da string de perfil especificada.

Essa função remove o contexto de suporte da string de perfil especificada do registro, se presente, com base no identificador de perfil.

Detalhes
Parâmetros
[in,out] inOutContext
Uma referência ao contexto de suporte da string de perfil que será removido, se presente. Quando o contexto é removido, o campo "mNext" pode ser modificado.
Retorna
verdadeiro se o contexto foi removido; caso contrário, falso.

UnregisterProfileStringInfo

NL_DLL_EXPORT WEAVE_ERROR UnregisterProfileStringInfo(
  ProfileStringContext & inOutContext
)

Cancele o registro das chamadas de suporte da string de perfil fornecida.

Essa função cancela o registro e torna indisponível a string de perfil fornecida de suporte a callbacks.

Detalhes
Parâmetros
[in,out] inOutContext
Uma referência ao contexto de suporte da string de perfil que terá o registro cancelado, se registrado, e será removido do registro. Quando o contexto não é registrado, o campo mNext pode ser modificado.
Valores de retorno
WEAVE_NO_ERROR
Se der certo.
WEAVE_ERROR_PROFILE_STRING_CONTEXT_NOT_REGISTERED
Se o contexto não estiver registrado.
Consulte também:
FindStringProfileInfo
RegisterProfielStringInfo