CoAP
Este módulo inclui funções que controlam a comunicação CoAP.
Resumo
As funções neste módulo estão disponíveis quando o recurso CoAP API ( OPENTHREAD_CONFIG_COAP_API_ENABLE
) está habilitado.
Typedefs | |
---|---|
otCoapBlockSzx | typedefenum otCoapBlockSzx Expoentes do tamanho do bloco CoAP. |
otCoapBlockwiseReceiveHook )(void *aContext, const uint8_t *aBlock, uint32_t aPosition, uint16_t aBlockLength, bool aMore, uint32_t aTotalLength) | typedefotError (* Este ponteiro de função é chamado quando uma mensagem CoAP com uma opção de transferência em bloco é recebida. |
otCoapBlockwiseResource | typedefstruct otCoapBlockwiseResource Esta estrutura representa um recurso CoAP com transferência em bloco. |
otCoapBlockwiseTransmitHook )(void *aContext, uint8_t *aBlock, uint32_t aPosition, uint16_t *aBlockLength, bool *aMore) | typedefotError (* Este ponteiro de função é chamado antes que o próximo bloco em uma transferência em bloco seja enviado. |
otCoapCode | typedefenum otCoapCode Valores do código CoAP. |
otCoapOption | typedefstruct otCoapOption Esta estrutura representa uma opção do CoAP. |
otCoapOptionContentFormat | typedef Códigos de formato de conteúdo CoAP. |
otCoapOptionIterator | typedefstruct otCoapOptionIterator Essa estrutura atua como um iterador para as opções do CoAP. |
otCoapOptionType | typedefenum otCoapOptionType Números de opções do CoAP. |
otCoapRequestHandler )(void *aContext, otMessage *aMessage, const otMessageInfo *aMessageInfo) | typedefvoid(* Este ponteiro de função é chamado quando uma solicitação CoAP com um determinado Uri-Path é recebida. |
otCoapResource | typedefstruct otCoapResource Esta estrutura representa um recurso CoAP. |
otCoapResponseHandler )(void *aContext, otMessage *aMessage, const otMessageInfo *aMessageInfo, otError aResult) | typedefvoid(* Este ponteiro de função é chamado quando uma resposta CoAP é recebida ou no tempo limite da solicitação. |
otCoapTxParameters | typedefstruct otCoapTxParameters Esta estrutura representa os parâmetros de transmissão do CoAP. |
otCoapType | typedefenum otCoapType Valores do tipo CoAP (inteiro sem sinal de 2 bits). |
Funções | |
---|---|
otCoapAddBlockWiseResource ( otInstance *aInstance, otCoapBlockwiseResource *aResource) | void Esta função adiciona um recurso de bloco ao servidor CoAP. |
otCoapAddResource ( otInstance *aInstance, otCoapResource *aResource) | void Esta função adiciona um recurso ao servidor CoAP. |
otCoapBlockSizeFromExponent ( otCoapBlockSzx aSize) | uint16_t Esta função converte um campo SZX da opção Bloco CoAP para o tamanho real do bloco. |
otCoapMessageAppendBlock1Option ( otMessage *aMessage, uint32_t aNum, bool aMore, otCoapBlockSzx aSize) | Esta função anexa uma opção Bloco1. |
otCoapMessageAppendBlock2Option ( otMessage *aMessage, uint32_t aNum, bool aMore, otCoapBlockSzx aSize) | Esta função anexa uma opção Bloco2. |
otCoapMessageAppendContentFormatOption ( otMessage *aMessage, otCoapOptionContentFormat aContentFormat) | Esta função anexa a opção CoAP de formato de conteúdo conforme especificado em https://tools.ietf.org/html/rfc7252#page-92 . |
otCoapMessageAppendMaxAgeOption ( otMessage *aMessage, uint32_t aMaxAge) | Esta função acrescenta uma opção Max-Age. |
otCoapMessageAppendObserveOption ( otMessage *aMessage, uint32_t aObserve) | Esta função anexa uma opção Observar. |
otCoapMessageAppendOption ( otMessage *aMessage, uint16_t aNumber, uint16_t aLength, const void *aValue) | Esta função anexa uma opção CoAP em um cabeçalho. |
otCoapMessageAppendProxyUriOption ( otMessage *aMessage, const char *aUriPath) | Esta função acrescenta uma opção Proxy-Uri. |
otCoapMessageAppendUintOption ( otMessage *aMessage, uint16_t aNumber, uint32_t aValue) | Esta função anexa uma opção CoAP de inteiro não assinado conforme especificado em https://tools.ietf.org/html/rfc7252#section-3.2 . |
otCoapMessageAppendUriPathOptions ( otMessage *aMessage, const char *aUriPath) | Esta função acrescenta uma opção Uri-Path. |
otCoapMessageAppendUriQueryOption ( otMessage *aMessage, const char *aUriQuery) | Esta função acrescenta uma única opção Uri-Query. |
otCoapMessageCodeToString (const otMessage *aMessage) | const char * Este método retorna o Código CoAP como string legível por humanos. |
otCoapMessageGenerateToken ( otMessage *aMessage, uint8_t aTokenLength) | void Esta função define o comprimento do token e randomiza seu valor. |
otCoapMessageGetCode (const otMessage *aMessage) | Esta função retorna o valor do código. |
otCoapMessageGetMessageId (const otMessage *aMessage) | uint16_t Esta função retorna o valor do ID da mensagem. |
otCoapMessageGetToken (const otMessage *aMessage) | const uint8_t * Esta função retorna um ponteiro para o valor do Token. |
otCoapMessageGetTokenLength (const otMessage *aMessage) | uint8_t Esta função retorna o comprimento do token. |
otCoapMessageGetType (const otMessage *aMessage) | Esta função retorna o valor Type. |
otCoapMessageInit ( otMessage *aMessage, otCoapType aType, otCoapCode aCode) | void Esta função inicializa o cabeçalho CoAP. |
otCoapMessageInitResponse ( otMessage *aResponse, const otMessage *aRequest, otCoapType aType, otCoapCode aCode) | Esta função inicializa uma mensagem de resposta. |
otCoapMessageSetPayloadMarker ( otMessage *aMessage) | Esta função adiciona o marcador de carga útil indicando o início da carga útil ao cabeçalho CoAP. |
otCoapMessageSetToken ( otMessage *aMessage, const uint8_t *aToken, uint8_t aTokenLength) | Esta função define o valor e o comprimento do Token em um cabeçalho. |
otCoapNewMessage ( otInstance *aInstance, const otMessageSettings *aSettings) | Esta função cria uma nova mensagem CoAP. |
otCoapOptionIteratorGetFirstOption ( otCoapOptionIterator *aIterator) | const otCoapOption * Esta função retorna um ponteiro para a primeira opção. |
otCoapOptionIteratorGetFirstOptionMatching ( otCoapOptionIterator *aIterator, uint16_t aOption) | const otCoapOption * Esta função retorna um ponteiro para a primeira opção correspondente ao número da opção especificada. |
otCoapOptionIteratorGetNextOption ( otCoapOptionIterator *aIterator) | const otCoapOption * Esta função retorna um ponteiro para a próxima opção. |
otCoapOptionIteratorGetNextOptionMatching ( otCoapOptionIterator *aIterator, uint16_t aOption) | const otCoapOption * Esta função retorna um ponteiro para a próxima opção correspondente ao número da opção especificada. |
otCoapOptionIteratorGetOptionUintValue ( otCoapOptionIterator *aIterator, uint64_t *aValue) | Esta função preenche o valor da opção atual em aValue assumindo que o valor atual é um inteiro sem sinal codificado de acordo com https://tools.ietf.org/html/rfc7252#section-3.2 . |
otCoapOptionIteratorGetOptionValue ( otCoapOptionIterator *aIterator, void *aValue) | Esta função preenche o valor da opção atual em aValue . |
otCoapOptionIteratorInit ( otCoapOptionIterator *aIterator, const otMessage *aMessage) | Esta função inicializa um iterador para as opções na mensagem fornecida. |
otCoapRemoveBlockWiseResource ( otInstance *aInstance, otCoapBlockwiseResource *aResource) | void Esta função remove um recurso em bloco do servidor CoAP. |
otCoapRemoveResource ( otInstance *aInstance, otCoapResource *aResource) | void Esta função remove um recurso do servidor CoAP. |
otCoapSendRequest ( otInstance *aInstance, otMessage *aMessage, const otMessageInfo *aMessageInfo, otCoapResponseHandler aHandler, void *aContext) | Esta função envia uma solicitação CoAP. |
otCoapSendRequestBlockWise ( otInstance *aInstance, otMessage *aMessage, const otMessageInfo *aMessageInfo, otCoapResponseHandler aHandler, void *aContext, otCoapBlockwiseTransmitHook aTransmitHook, otCoapBlockwiseReceiveHook aReceiveHook) | Esta função envia uma solicitação CoAP em bloco. |
otCoapSendRequestBlockWiseWithParameters ( otInstance *aInstance, otMessage *aMessage, const otMessageInfo *aMessageInfo, otCoapResponseHandler aHandler, void *aContext, const otCoapTxParameters *aTxParameters, otCoapBlockwiseTransmitHook aTransmitHook, otCoapBlockwiseReceiveHook aReceiveHook) | Esta função envia uma solicitação CoAP em bloco com parâmetros de transmissão personalizados. |
otCoapSendRequestWithParameters ( otInstance *aInstance, otMessage *aMessage, const otMessageInfo *aMessageInfo, otCoapResponseHandler aHandler, void *aContext, const otCoapTxParameters *aTxParameters) | Esta função envia uma solicitação CoAP com parâmetros de transmissão personalizados. |
otCoapSendResponse ( otInstance *aInstance, otMessage *aMessage, const otMessageInfo *aMessageInfo) | Esta função envia uma resposta CoAP do servidor. |
otCoapSendResponseBlockWise ( otInstance *aInstance, otMessage *aMessage, const otMessageInfo *aMessageInfo, void *aContext, otCoapBlockwiseTransmitHook aTransmitHook) | Esta função envia uma resposta CoAP em bloco do servidor. |
otCoapSendResponseBlockWiseWithParameters ( otInstance *aInstance, otMessage *aMessage, const otMessageInfo *aMessageInfo, const otCoapTxParameters *aTxParameters, void *aContext, otCoapBlockwiseTransmitHook aTransmitHook) | Esta função envia uma resposta CoAP em bloco do servidor com parâmetros de transmissão personalizados. |
otCoapSendResponseWithParameters ( otInstance *aInstance, otMessage *aMessage, const otMessageInfo *aMessageInfo, const otCoapTxParameters *aTxParameters) | Esta função envia uma resposta CoAP do servidor com parâmetros de transmissão personalizados. |
otCoapSetDefaultHandler ( otInstance *aInstance, otCoapRequestHandler aHandler, void *aContext) | void Esta função define o manipulador padrão para solicitações CoAP não manipuladas. |
otCoapStart ( otInstance *aInstance, uint16_t aPort) | Esta função inicia o servidor CoAP. |
otCoapStop ( otInstance *aInstance) | Esta função interrompe o servidor CoAP. |
Structs | |
---|---|
otCoapBlockwiseResource | Esta estrutura representa um recurso CoAP com transferência em bloco. |
otCoapOption | Esta estrutura representa uma opção do CoAP. |
otCoapOptionIterator | Essa estrutura atua como um iterador para as opções do CoAP. |
otCoapResource | Esta estrutura representa um recurso CoAP. |
otCoapTxParameters | Esta estrutura representa os parâmetros de transmissão do CoAP. |
Enumerações
otCoapBlockSzx
otCoapBlockSzx
Expoentes do tamanho do bloco CoAP.
otCoapCode
otCoapCode
Valores do código CoAP.
otCoapOptionContentFormat
otCoapOptionContentFormat
Códigos de formato de conteúdo CoAP.
A lista completa está documentada em https://www.iana.org/assignments/core-parameters/core-parameters.xhtml#content-formats
otCoapOptionType
otCoapOptionType
Números de opções do CoAP.
otCoapType
otCoapType
Typedefs
otCoapBlockwiseReceiveHook
otError(* otCoapBlockwiseReceiveHook)(void *aContext, const uint8_t *aBlock, uint32_t aPosition, uint16_t aBlockLength, bool aMore, uint32_t aTotalLength)
Este ponteiro de função é chamado quando uma mensagem CoAP com uma opção de transferência em bloco é recebida.
Esta função está disponível quando a configuração OPENTHREAD_CONFIG_COAP_BLOCKWISE_TRANSFER_ENABLE está habilitada.
Detalhes | |||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|
Parâmetros |
| ||||||||||||
Valores Retornados |
|
otCoapBlockwiseResource
struct otCoapBlockwiseResource otCoapBlockwiseResource
Esta estrutura representa um recurso CoAP com transferência em bloco.
otCoapBlockwiseTransmitHook
otError(* otCoapBlockwiseTransmitHook)(void *aContext, uint8_t *aBlock, uint32_t aPosition, uint16_t *aBlockLength, bool *aMore)
Este ponteiro de função é chamado antes que o próximo bloco em uma transferência em bloco seja enviado.
Esta função está disponível quando a configuração OPENTHREAD_CONFIG_COAP_BLOCKWISE_TRANSFER_ENABLE está habilitada.
Ao alterar o valor de aBlockLength, o tamanho do bloco de toda a troca é renegociado. Recomenda-se fazer isso após o primeiro bloco ter sido recebido, pois as alterações posteriores podem causar problemas com outras implementações do CoAP.
Detalhes | |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
Parâmetros |
| ||||||||||
Valores Retornados |
|
otCoapOptionContentFormat
enum otCoapOptionContentFormat otCoapOptionContentFormat
Códigos de formato de conteúdo CoAP.
A lista completa está documentada em https://www.iana.org/assignments/core-parameters/core-parameters.xhtml#content-formats
otCoapOptionIterator
struct otCoapOptionIterator otCoapOptionIterator
Essa estrutura atua como um iterador para as opções do CoAP.
otCoapRequestHandler
void(* otCoapRequestHandler)(void *aContext, otMessage *aMessage, const otMessageInfo *aMessageInfo)
Este ponteiro de função é chamado quando uma solicitação CoAP com um determinado Uri-Path é recebida.
Detalhes | |||||||
---|---|---|---|---|---|---|---|
Parâmetros |
|
otCoapResponseHandler
void(* otCoapResponseHandler)(void *aContext, otMessage *aMessage, const otMessageInfo *aMessageInfo, otError aResult)
Este ponteiro de função é chamado quando uma resposta CoAP é recebida ou no tempo limite da solicitação.
Detalhes | |||||||||
---|---|---|---|---|---|---|---|---|---|
Parâmetros |
| ||||||||
Valores Retornados |
|
otCoapTxParameters
struct otCoapTxParameters otCoapTxParameters
Esta estrutura representa os parâmetros de transmissão do CoAP.
Funções
otCoapAddBlockWiseResource
void otCoapAddBlockWiseResource( otInstance *aInstance, otCoapBlockwiseResource *aResource )
Esta função adiciona um recurso de bloco ao servidor CoAP.
Detalhes | |||||
---|---|---|---|---|---|
Parâmetros |
|
otCoapAddResource
void otCoapAddResource( otInstance *aInstance, otCoapResource *aResource )
Esta função adiciona um recurso ao servidor CoAP.
Detalhes | |||||
---|---|---|---|---|---|
Parâmetros |
|
otCoapBlockSizeFromExponent
uint16_t otCoapBlockSizeFromExponent( otCoapBlockSzx aSize )
Esta função converte um campo SZX da opção Bloco CoAP para o tamanho real do bloco.
Detalhes | |||
---|---|---|---|
Parâmetros |
| ||
Devoluções | O valor expoente do tamanho real. |
otCoapMessageAppendBlock1Option
otError otCoapMessageAppendBlock1Option( otMessage *aMessage, uint32_t aNum, bool aMore, otCoapBlockSzx aSize )
Esta função anexa uma opção Bloco1.
Detalhes | |||||||||
---|---|---|---|---|---|---|---|---|---|
Parâmetros |
| ||||||||
Valores Retornados |
|
otCoapMessageAppendBlock2Option
otError otCoapMessageAppendBlock2Option( otMessage *aMessage, uint32_t aNum, bool aMore, otCoapBlockSzx aSize )
Esta função anexa uma opção Bloco2.
Detalhes | |||||||||
---|---|---|---|---|---|---|---|---|---|
Parâmetros |
| ||||||||
Valores Retornados |
|
otCoapMessageAppendContentFormatOption
otError otCoapMessageAppendContentFormatOption( otMessage *aMessage, otCoapOptionContentFormat aContentFormat )
Esta função anexa a opção Content Format CoAP conforme especificado em https://tools.ietf.org/html/rfc7252#page-92 .
Deve ser chamado antes de definir otCoapMessageSetPayloadMarker se uma carga útil for incluída na mensagem.
A função é um invólucro conveniente em torno de otCoapMessageAppendUintOption e, se o código do tipo de formato desejado não estiver listado em otCoapOptionContentFormat, esta função básica deve ser usada em seu lugar.
Detalhes | |||||||
---|---|---|---|---|---|---|---|
Parâmetros |
| ||||||
Valores Retornados |
|
otCoapMessageAppendMaxAgeOption
otError otCoapMessageAppendMaxAgeOption( otMessage *aMessage, uint32_t aMaxAge )
Esta função acrescenta uma opção Max-Age.
Detalhes | |||||||
---|---|---|---|---|---|---|---|
Parâmetros |
| ||||||
Valores Retornados |
|
otCoapMessageAppendObserveOption
otError otCoapMessageAppendObserveOption( otMessage *aMessage, uint32_t aObserve )
Esta função anexa uma opção Observar.
Detalhes | |||||||
---|---|---|---|---|---|---|---|
Parâmetros |
| ||||||
Valores Retornados |
|
otCoapMessageAppendOption
otError otCoapMessageAppendOption( otMessage *aMessage, uint16_t aNumber, uint16_t aLength, const void *aValue )
Esta função anexa uma opção CoAP em um cabeçalho.
Detalhes | |||||||||
---|---|---|---|---|---|---|---|---|---|
Parâmetros |
| ||||||||
Valores Retornados |
|
otCoapMessageAppendProxyUriOption
otError otCoapMessageAppendProxyUriOption( otMessage *aMessage, const char *aUriPath )
Esta função acrescenta uma opção Proxy-Uri.
Detalhes | |||||||
---|---|---|---|---|---|---|---|
Parâmetros |
| ||||||
Valores Retornados |
|
otCoapMessageAppendUintOption
otError otCoapMessageAppendUintOption( otMessage *aMessage, uint16_t aNumber, uint32_t aValue )
Esta função anexa uma opção CoAP de inteiro não assinado conforme especificado em https://tools.ietf.org/html/rfc7252#section-3.2 .
Detalhes | |||||||
---|---|---|---|---|---|---|---|
Parâmetros |
| ||||||
Valores Retornados |
|
otCoapMessageGetOptionUintValue
otCoapMessageAppendUriPathOptions
otError otCoapMessageAppendUriPathOptions( otMessage *aMessage, const char *aUriPath )
Esta função acrescenta uma opção Uri-Path.
Detalhes | |||||||
---|---|---|---|---|---|---|---|
Parâmetros |
| ||||||
Valores Retornados |
|
otCoapMessageAppendUriQueryOption
otError otCoapMessageAppendUriQueryOption( otMessage *aMessage, const char *aUriQuery )
Esta função acrescenta uma única opção Uri-Query.
Detalhes | |||||||
---|---|---|---|---|---|---|---|
Parâmetros |
| ||||||
Valores Retornados |
|
otCoapMessageCodeToString
const char * otCoapMessageCodeToString( const otMessage *aMessage )
Este método retorna o Código CoAP como string legível por humanos.
@ retorna o código CoAP como string.
Detalhes | |||
---|---|---|---|
Parâmetros |
|
otCoapMessageGenerateToken
void otCoapMessageGenerateToken( otMessage *aMessage, uint8_t aTokenLength )
Esta função define o comprimento do token e randomiza seu valor.
Detalhes | |||||
---|---|---|---|---|---|
Parâmetros |
|
otCoapMessageGetCode
otCoapCode otCoapMessageGetCode( const otMessage *aMessage )
Esta função retorna o valor do código.
Detalhes | |||
---|---|---|---|
Parâmetros |
| ||
Devoluções | O valor do código. |
otCoapMessageGetMessageId
uint16_t otCoapMessageGetMessageId( const otMessage *aMessage )
Esta função retorna o valor do ID da mensagem.
Detalhes | |||
---|---|---|---|
Parâmetros |
| ||
Devoluções | O valor do ID da mensagem. |
otCoapMessageGetToken
const uint8_t * otCoapMessageGetToken( const otMessage *aMessage )
Esta função retorna um ponteiro para o valor do Token.
Detalhes | |||
---|---|---|---|
Parâmetros |
| ||
Devoluções | Um ponteiro para o valor do Token. |
otCoapMessageGetTokenLength
uint8_t otCoapMessageGetTokenLength( const otMessage *aMessage )
Esta função retorna o comprimento do token.
Detalhes | |||
---|---|---|---|
Parâmetros |
| ||
Devoluções | O comprimento do token. |
otCoapMessageGetType
otCoapType otCoapMessageGetType( const otMessage *aMessage )
Esta função retorna o valor Type.
Detalhes | |||
---|---|---|---|
Parâmetros |
| ||
Devoluções | O valor do tipo. |
otCoapMessageInit
void otCoapMessageInit( otMessage *aMessage, otCoapType aType, otCoapCode aCode )
Esta função inicializa o cabeçalho CoAP.
Detalhes | |||||||
---|---|---|---|---|---|---|---|
Parâmetros |
|
otCoapMessageInitResponse
otError otCoapMessageInitResponse( otMessage *aResponse, const otMessage *aRequest, otCoapType aType, otCoapCode aCode )
Esta função inicializa uma mensagem de resposta.
Detalhes | |||||||||
---|---|---|---|---|---|---|---|---|---|
Parâmetros |
| ||||||||
Valores Retornados |
|
otCoapMessageSetPayloadMarker
otError otCoapMessageSetPayloadMarker( otMessage *aMessage )
Esta função adiciona o marcador de carga útil indicando o início da carga útil ao cabeçalho CoAP.
Detalhes | |||||
---|---|---|---|---|---|
Parâmetros |
| ||||
Valores Retornados |
|
otCoapMessageSetToken
otError otCoapMessageSetToken( otMessage *aMessage, const uint8_t *aToken, uint8_t aTokenLength )
Esta função define o valor e o comprimento do Token em um cabeçalho.
Detalhes | |||||||
---|---|---|---|---|---|---|---|
Parâmetros |
| ||||||
Valores Retornados |
|
otCoapNewMessage
otMessage * otCoapNewMessage( otInstance *aInstance, const otMessageSettings *aSettings )
Esta função cria uma nova mensagem CoAP.
Detalhes | |||||
---|---|---|---|---|---|
Parâmetros |
| ||||
Devoluções | Um ponteiro para o buffer de mensagem ou NULL se nenhum buffer de mensagem estiver disponível ou os parâmetros forem inválidos. |
otCoapOptionIteratorGetFirstOption
const otCoapOption * otCoapOptionIteratorGetFirstOption( otCoapOptionIterator *aIterator )
Esta função retorna um ponteiro para a primeira opção.
Detalhes | |||
---|---|---|---|
Parâmetros |
| ||
Devoluções | Um ponteiro para a primeira opção. Se nenhuma opção estiver presente, o ponteiro NULL é retornado. |
otCoapOptionIteratorGetFirstOptionMatching
const otCoapOption * otCoapOptionIteratorGetFirstOptionMatching( otCoapOptionIterator *aIterator, uint16_t aOption )
Esta função retorna um ponteiro para a primeira opção correspondente ao número da opção especificada.
Detalhes | |||||
---|---|---|---|---|---|
Parâmetros |
| ||||
Devoluções | Um ponteiro para a primeira opção correspondente. Se nenhuma opção correspondente estiver presente, o ponteiro NULL é retornado. |
otCoapOptionIteratorGetNextOption
const otCoapOption * otCoapOptionIteratorGetNextOption( otCoapOptionIterator *aIterator )
Esta função retorna um ponteiro para a próxima opção.
Detalhes | |||
---|---|---|---|
Parâmetros |
| ||
Devoluções | Um ponteiro para a próxima opção. Se não houver mais opções presentes, o ponteiro NULL é retornado. |
otCoapOptionIteratorGetNextOptionMatching
const otCoapOption * otCoapOptionIteratorGetNextOptionMatching( otCoapOptionIterator *aIterator, uint16_t aOption )
Esta função retorna um ponteiro para a próxima opção correspondente ao número da opção especificada.
Detalhes | |||||
---|---|---|---|---|---|
Parâmetros |
| ||||
Devoluções | Um ponteiro para a próxima opção correspondente. Se nenhuma outra opção correspondente estiver presente, o ponteiro NULL é retornado. |
otCoapOptionIteratorGetOptionUintValue
otError otCoapOptionIteratorGetOptionUintValue( otCoapOptionIterator *aIterator, uint64_t *aValue )
Esta função preenche o valor da opção atual em aValue
assumindo que o valor atual é um inteiro sem sinal codificado de acordo com https://tools.ietf.org/html/rfc7252#section-3.2 .
Detalhes | |||||||
---|---|---|---|---|---|---|---|
Parâmetros |
| ||||||
Valores Retornados |
|
otCoapMessageAppendUintOption
otCoapOptionIteratorGetOptionValue
otError otCoapOptionIteratorGetOptionValue( otCoapOptionIterator *aIterator, void *aValue )
Esta função preenche o valor da opção atual em aValue
.
Detalhes | |||||
---|---|---|---|---|---|
Parâmetros |
| ||||
Valores Retornados |
|
otCoapOptionIteratorInit
otError otCoapOptionIteratorInit( otCoapOptionIterator *aIterator, const otMessage *aMessage )
Esta função inicializa um iterador para as opções na mensagem fornecida.
Detalhes | |||||
---|---|---|---|---|---|
Parâmetros |
| ||||
Valores Retornados |
|
otCoapRemoveBlockWiseResource
void otCoapRemoveBlockWiseResource( otInstance *aInstance, otCoapBlockwiseResource *aResource )
Esta função remove um recurso em bloco do servidor CoAP.
Detalhes | |||||
---|---|---|---|---|---|
Parâmetros |
|
otCoapRemoveResource
void otCoapRemoveResource( otInstance *aInstance, otCoapResource *aResource )
Esta função remove um recurso do servidor CoAP.
Detalhes | |||||
---|---|---|---|---|---|
Parâmetros |
|
otCoapSendRequest
otError otCoapSendRequest( otInstance *aInstance, otMessage *aMessage, const otMessageInfo *aMessageInfo, otCoapResponseHandler aHandler, void *aContext )
Esta função envia uma solicitação CoAP.
Se uma resposta a uma solicitação for esperada, as respectivas funções e informações de contexto devem ser fornecidas. Se nenhuma resposta for esperada, esses argumentos devem ser ponteiros NULL.
Detalhes | |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
Parâmetros |
| ||||||||||
Valores Retornados |
|
otCoapSendRequestBlockWise
otError otCoapSendRequestBlockWise( otInstance *aInstance, otMessage *aMessage, const otMessageInfo *aMessageInfo, otCoapResponseHandler aHandler, void *aContext, otCoapBlockwiseTransmitHook aTransmitHook, otCoapBlockwiseReceiveHook aReceiveHook )
Esta função envia uma solicitação CoAP em bloco.
Esta função está disponível quando a configuração OPENTHREAD_CONFIG_COAP_BLOCKWISE_TRANSFER_ENABLE está habilitada.
Se uma resposta a uma solicitação for esperada, as respectivas funções e informações de contexto devem ser fornecidas. Se espera-se que a resposta seja em bloco, uma função de gancho respectiva deve ser fornecida. Se nenhuma resposta for esperada, esses argumentos devem ser ponteiros NULL.
Detalhes | |||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
Parâmetros |
| ||||||||||||||
Valores Retornados |
|
otCoapSendRequestBlockWiseWithParameters
otError otCoapSendRequestBlockWiseWithParameters( otInstance *aInstance, otMessage *aMessage, const otMessageInfo *aMessageInfo, otCoapResponseHandler aHandler, void *aContext, const otCoapTxParameters *aTxParameters, otCoapBlockwiseTransmitHook aTransmitHook, otCoapBlockwiseReceiveHook aReceiveHook )
Esta função envia uma solicitação CoAP em bloco com parâmetros de transmissão personalizados.
Esta função está disponível quando a configuração OPENTHREAD_CONFIG_COAP_BLOCKWISE_TRANSFER_ENABLE está habilitada.
Se uma resposta a uma solicitação for esperada, as respectivas funções e informações de contexto devem ser fornecidas. Se espera-se que a resposta seja em bloco, uma função de gancho respectiva deve ser fornecida. Se nenhuma resposta for esperada, esses argumentos devem ser ponteiros NULL.
Detalhes | |||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
Parâmetros |
| ||||||||||||||||
Valores Retornados |
|
otCoapSendRequestWithParameters
otError otCoapSendRequestWithParameters( otInstance *aInstance, otMessage *aMessage, const otMessageInfo *aMessageInfo, otCoapResponseHandler aHandler, void *aContext, const otCoapTxParameters *aTxParameters )
Esta função envia uma solicitação CoAP com parâmetros de transmissão personalizados.
Se uma resposta a uma solicitação for esperada, as respectivas funções e informações de contexto devem ser fornecidas. Se nenhuma resposta for esperada, esses argumentos devem ser ponteiros NULL.
Detalhes | |||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|
Parâmetros |
| ||||||||||||
Valores Retornados |
|
otCoapSendResponse
otError otCoapSendResponse( otInstance *aInstance, otMessage *aMessage, const otMessageInfo *aMessageInfo )
Esta função envia uma resposta CoAP do servidor.
Detalhes | |||||||
---|---|---|---|---|---|---|---|
Parâmetros |
| ||||||
Valores Retornados |
|
otCoapSendResponseBlockWise
otError otCoapSendResponseBlockWise( otInstance *aInstance, otMessage *aMessage, const otMessageInfo *aMessageInfo, void *aContext, otCoapBlockwiseTransmitHook aTransmitHook )
Esta função envia uma resposta CoAP em bloco do servidor.
Esta função está disponível quando a configuração OPENTHREAD_CONFIG_COAP_BLOCKWISE_TRANSFER_ENABLE está habilitada.
Detalhes | |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
Parâmetros |
| ||||||||||
Valores Retornados |
|
otCoapSendResponseBlockWiseWithParameters
otError otCoapSendResponseBlockWiseWithParameters( otInstance *aInstance, otMessage *aMessage, const otMessageInfo *aMessageInfo, const otCoapTxParameters *aTxParameters, void *aContext, otCoapBlockwiseTransmitHook aTransmitHook )
Esta função envia uma resposta CoAP em bloco do servidor com parâmetros de transmissão personalizados.
Esta função está disponível quando a configuração OPENTHREAD_CONFIG_COAP_BLOCKWISE_TRANSFER_ENABLE está habilitada.
Detalhes | |||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|
Parâmetros |
| ||||||||||||
Valores Retornados |
|
otCoapSendResponseWithParameters
otError otCoapSendResponseWithParameters( otInstance *aInstance, otMessage *aMessage, const otMessageInfo *aMessageInfo, const otCoapTxParameters *aTxParameters )
Esta função envia uma resposta CoAP do servidor com parâmetros de transmissão personalizados.
Detalhes | |||||||||
---|---|---|---|---|---|---|---|---|---|
Parâmetros |
| ||||||||
Valores Retornados |
|
otCoapSetDefaultHandler
void otCoapSetDefaultHandler( otInstance *aInstance, otCoapRequestHandler aHandler, void *aContext )
Esta função define o manipulador padrão para solicitações CoAP não processadas.
Detalhes | |||||||
---|---|---|---|---|---|---|---|
Parâmetros |
|
otCoapStart
otError otCoapStart( otInstance *aInstance, uint16_t aPort )
Esta função inicia o servidor CoAP.
Detalhes | |||||
---|---|---|---|---|---|
Parâmetros |
| ||||
Valores Retornados |
|
otCoapStop
otError otCoapStop( otInstance *aInstance )
Esta função interrompe o servidor CoAP.
Detalhes | |||
---|---|---|---|
Parâmetros |
| ||
Valores Retornados |
|
Macros
OT_COAP_CODE
OT_COAP_CODE ((((c)&0x7) << 5) | ((d)&0x1f))
Macro auxiliar para definir os valores do Código CoAP.
OT_COAP_DEFAULT_TOKEN_LENGTH
OT_COAP_DEFAULT_TOKEN_LENGTH 2
Comprimento padrão do token.
OT_COAP_MAX_RETRANSMIT
OT_COAP_MAX_RETRANSMIT 20
Retransmissão máxima compatível com OpenThread.
OT_COAP_MAX_TOKEN_LENGTH
OT_COAP_MAX_TOKEN_LENGTH 8
Comprimento máximo do token conforme especificado (RFC 7252).
OT_COAP_MIN_ACK_TIMEOUT
OT_COAP_MIN_ACK_TIMEOUT 1000
Tempo limite mínimo de ACK em milissegundos compatível com OpenThread.
OT_DEFAULT_COAP_PORT
OT_DEFAULT_COAP_PORT 5683
Porta CoAP padrão, conforme especificado em RFC 7252.