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

CoAP

Este módulo inclui funções que controlam a comunicação CoAP.

Resumo

As funções deste módulo estão disponíveis quando o recurso CoAP API ( OPENTHREAD_CONFIG_COAP_API_ENABLE ) está habilitado.

Enumerações

otCoapBlockSzx enumerar
Expoentes de tamanho de bloco CoAP.
otCoapCode {
OT_COAP_CODE_EMPTY = (((( 0 )&0x7) << 5) | (( 0 )&0x1f)),
OT_COAP_CODE_GET = (((( 0 )&0x7) << 5) | (( 1 )&0x1f)),
OT_COAP_CODE_POST = (((( 0 )&0x7) << 5) | (( 2 )&0x1f)),
OT_COAP_CODE_PUT = (((( 0 )&0x7) << 5) | (( 3 )&0x1f)),
OT_COAP_CODE_DELETE = (((( 0 )&0x7) << 5) | (( 4 )&0x1f)),
OT_COAP_CODE_RESPONSE_MIN = (((( 2 )&0x7) << 5) | (( 0 )&0x1f)),
OT_COAP_CODE_CREATED = (((( 2 )&0x7) << 5) | (( 1 )&0x1f)),
OT_COAP_CODE_DELETED = (((( 2 )&0x7) << 5) | (( 2 )&0x1f)),
OT_COAP_CODE_VALID = (((( 2 )&0x7) << 5) | (( 3 )&0x1f)),
OT_COAP_CODE_CHANGED = (((( 2 )&0x7) << 5) | (( 4 )&0x1f)),
OT_COAP_CODE_CONTENT = (((( 2 )&0x7) << 5) | (( 5 )&0x1f)),
OT_COAP_CODE_CONTINUE = (((( 2 )&0x7) << 5) | (( 31 )&0x1f)),
OT_COAP_CODE_BAD_REQUEST = (((( 4 )&0x7) << 5) | (( 0 )&0x1f)),
OT_COAP_CODE_UNAUTHORIZED = (((( 4 )&0x7) << 5) | (( 1 )&0x1f)),
OT_COAP_CODE_BAD_OPTION = (((( 4 )&0x7) << 5) | (( 2 )&0x1f)),
OT_COAP_CODE_FORBIDDEN = (((( 4 )&0x7) << 5) | (( 3 )&0x1f)),
OT_COAP_CODE_NOT_FOUND = (((( 4 )&0x7) << 5) | (( 4 )&0x1f)),
OT_COAP_CODE_METHOD_NOT_ALLOWED = (((( 4 )&0x7) << 5) | (( 5 )&0x1f)),
OT_COAP_CODE_NOT_ACCEPTABLE = (((( 4 )&0x7) << 5) | (( 6 )&0x1f)),
OT_COAP_CODE_REQUEST_INCOMPLETE = (((( 4 )&0x7) << 5) | (( 8 )&0x1f)),
OT_COAP_CODE_PRECONDITION_FAILED = (((( 4 )&0x7) << 5) | (( 12 )&0x1f)),
OT_COAP_CODE_REQUEST_TOO_LARGE = (((( 4 )&0x7) << 5) | (( 13 )&0x1f)),
OT_COAP_CODE_UNSUPPORTED_FORMAT = (((( 4 )&0x7) << 5) | (( 15 )&0x1f)),
OT_COAP_CODE_INTERNAL_ERROR = (((( 5 )&0x7) << 5) | (( 0 )&0x1f)),
OT_COAP_CODE_NOT_IMPLEMENTED = (((( 5 )&0x7) << 5) | (( 1 )&0x1f)),
OT_COAP_CODE_BAD_GATEWAY = (((( 5 )&0x7) << 5) | (( 2 )&0x1f)),
OT_COAP_CODE_SERVICE_UNAVAILABLE = (((( 5 )&0x7) << 5) | (( 3 )&0x1f)),
OT_COAP_CODE_GATEWAY_TIMEOUT = (((( 5 )&0x7) << 5) | (( 4 )&0x1f)),
OT_COAP_CODE_PROXY_NOT_SUPPORTED = (((( 5 )&0x7) << 5) | (( 5 )&0x1f))
}
enumerar
Valores do código CoAP.
otCoapOptionContentFormat {
OT_COAP_OPTION_CONTENT_FORMAT_TEXT_PLAIN = 0,
OT_COAP_OPTION_CONTENT_FORMAT_COSE_ENCRYPT0 = 16,
OT_COAP_OPTION_CONTENT_FORMAT_COSE_MAC0 = 17,
OT_COAP_OPTION_CONTENT_FORMAT_COSE_SIGN1 = 18,
OT_COAP_OPTION_CONTENT_FORMAT_LINK_FORMAT = 40,
OT_COAP_OPTION_CONTENT_FORMAT_XML = 41,
OT_COAP_OPTION_CONTENT_FORMAT_OCTET_STREAM = 42,
OT_COAP_OPTION_CONTENT_FORMAT_EXI = 47,
OT_COAP_OPTION_CONTENT_FORMAT_JSON = 50,
OT_COAP_OPTION_CONTENT_FORMAT_JSON_PATCH_JSON = 51,
OT_COAP_OPTION_CONTENT_FORMAT_MERGE_PATCH_JSON = 52,
OT_COAP_OPTION_CONTENT_FORMAT_CBOR = 60,
OT_COAP_OPTION_CONTENT_FORMAT_CWT = 61,
OT_COAP_OPTION_CONTENT_FORMAT_COSE_ENCRYPT = 96,
OT_COAP_OPTION_CONTENT_FORMAT_COSE_MAC = 97,
OT_COAP_OPTION_CONTENT_FORMAT_COSE_SIGN = 98,
OT_COAP_OPTION_CONTENT_FORMAT_COSE_KEY = 101,
OT_COAP_OPTION_CONTENT_FORMAT_COSE_KEY_SET = 102,
OT_COAP_OPTION_CONTENT_FORMAT_SENML_JSON = 110,
OT_COAP_OPTION_CONTENT_FORMAT_SENSML_JSON = 111,
OT_COAP_OPTION_CONTENT_FORMAT_SENML_CBOR = 112,
OT_COAP_OPTION_CONTENT_FORMAT_SENSML_CBOR = 113,
OT_COAP_OPTION_CONTENT_FORMAT_SENML_EXI = 114,
OT_COAP_OPTION_CONTENT_FORMAT_SENSML_EXI = 115,
OT_COAP_OPTION_CONTENT_FORMAT_COAP_GROUP_JSON = 256,
OT_COAP_OPTION_CONTENT_FORMAT_SENML_XML = 310,
OT_COAP_OPTION_CONTENT_FORMAT_SENSML_XML = 311
}
enumerar
Códigos de formato de conteúdo CoAP.
otCoapOptionType {
OT_COAP_OPTION_IF_MATCH = 1,
OT_COAP_OPTION_URI_HOST = 3,
OT_COAP_OPTION_E_TAG = 4,
OT_COAP_OPTION_IF_NONE_MATCH = 5,
OT_COAP_OPTION_OBSERVE = 6,
OT_COAP_OPTION_URI_PORT = 7,
OT_COAP_OPTION_LOCATION_PATH = 8,
OT_COAP_OPTION_URI_PATH = 11,
OT_COAP_OPTION_CONTENT_FORMAT = 12,
OT_COAP_OPTION_MAX_AGE = 14,
OT_COAP_OPTION_URI_QUERY = 15,
OT_COAP_OPTION_ACCEPT = 17,
OT_COAP_OPTION_LOCATION_QUERY = 20,
OT_COAP_OPTION_BLOCK2 = 23,
OT_COAP_OPTION_BLOCK1 = 27,
OT_COAP_OPTION_SIZE2 = 28,
OT_COAP_OPTION_PROXY_URI = 35,
OT_COAP_OPTION_PROXY_SCHEME = 39,
OT_COAP_OPTION_SIZE1 = 60
}
enumerar
Números de opção CoAP.
otCoapType {
OT_COAP_TYPE_CONFIRMABLE = 0,
OT_COAP_TYPE_NON_CONFIRMABLE = 1,
OT_COAP_TYPE_ACKNOWLEDGMENT = 2,
OT_COAP_TYPE_RESET = 3
}
enumerar
Valores do tipo CoAP (inteiro sem sinal de 2 bits).

Typedefs

otCoapBlockSzx typedef
Expoentes de tamanho de bloco CoAP.
otCoapBlockwiseReceiveHook )(void *aContext, const uint8_t *aBlock, uint32_t aPosition, uint16_t aBlockLength, bool aMore, uint32_t aTotalLength) typedef
Este ponteiro de função é chamado quando uma mensagem CoAP com uma opção de transferência em bloco é recebida.
otCoapBlockwiseResource typedef
Essa estrutura representa um recurso CoAP com transferência em bloco.
otCoapBlockwiseTransmitHook )(void *aContext, uint8_t *aBlock, uint32_t aPosition, uint16_t *aBlockLength, bool *aMore) typedef
Este ponteiro de função é chamado antes que o próximo bloco em uma transferência em bloco seja enviado.
otCoapCode typedef
Valores do código CoAP.
otCoapOption typedef
struct otCoapOption
Essa estrutura representa uma opção CoAP.
otCoapOptionContentFormat typedef
Códigos de formato de conteúdo CoAP.
otCoapOptionIterator typedef
Essa estrutura atua como um iterador para opções CoAP.
otCoapOptionType typedef
Números de opção CoAP.
otCoapRequestHandler )(void *aContext, otMessage *aMessage, const otMessageInfo *aMessageInfo) typedef
void(*
Este ponteiro de função é chamado quando uma solicitação CoAP com um determinado Uri-Path é recebida.
otCoapResource typedef
Essa estrutura representa um recurso CoAP.
otCoapResponseHandler )(void *aContext, otMessage *aMessage, const otMessageInfo *aMessageInfo, otError aResult) typedef
void(*
Este ponteiro de função é chamado quando uma resposta CoAP é recebida ou no tempo limite da solicitação.
otCoapTxParameters typedef
Essa estrutura representa os parâmetros de transmissão do CoAP.
otCoapType typedef
Valores do tipo CoAP (inteiro sem sinal de 2 bits).

Funções

otCoapAddBlockWiseResource ( otInstance *aInstance, otCoapBlockwiseResource *aResource)
void
Esta função adiciona um recurso em 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 CoAP Block para o tamanho real do bloco.
otCoapMessageAppendBlock1Option ( otMessage *aMessage, uint32_t aNum, bool aMore, otCoapBlockSzx aSize)
Esta função acrescenta uma opção Block1.
otCoapMessageAppendBlock2Option ( otMessage *aMessage, uint32_t aNum, bool aMore, otCoapBlockSzx aSize)
Esta função acrescenta uma opção Block2.
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 .
otCoapMessageAppendMaxAgeOption ( otMessage *aMessage, uint32_t aMaxAge)
Esta função acrescenta uma opção Max-Age.
otCoapMessageAppendObserveOption ( otMessage *aMessage, uint32_t aObserve)
Esta função acrescenta 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 anexa uma única opção Uri-Query.
otCoapMessageCodeToString (const otMessage *aMessage)
const char *
Este método retorna o código CoAP como uma 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 de 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 Tipo.
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.
otCoapMessageSetCode ( otMessage *aMessage, otCoapCode aCode)
void
Esta função define o valor do Código.
otCoapMessageSetPayloadMarker ( otMessage *aMessage)
Esta função adiciona o marcador de carga útil que indica 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 que corresponde ao número de opção especificado.
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 que corresponde 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
Essa função define o manipulador padrão para solicitações CoAP não tratadas.
otCoapStart ( otInstance *aInstance, uint16_t aPort)
Esta função inicia o servidor CoAP.
otCoapStop ( otInstance *aInstance)
Esta função para o servidor CoAP.

Estruturas

otCoapBlockwiseResource

Essa estrutura representa um recurso CoAP com transferência em bloco.

otCoapOption

Essa estrutura representa uma opção CoAP.

otCoapOptionIterator

Essa estrutura atua como um iterador para opções CoAP.

otCoapResource

Essa estrutura representa um recurso CoAP.

otCoapTxParameters

Essa estrutura representa os parâmetros de transmissão do CoAP.

Enumerações

otCoapBlockSzx

 otCoapBlockSzx

Expoentes de tamanho de bloco CoAP.

otCoapCode

 otCoapCode

Valores do código CoAP.

Propriedades
OT_COAP_CODE_BAD_GATEWAY

Gateway ruim.

OT_COAP_CODE_BAD_OPTION

Opção ruim.

OT_COAP_CODE_BAD_REQUEST

Pedido ruim.

OT_COAP_CODE_CHANGED

Mudado.

OT_COAP_CODE_CONTENT

Contente.

OT_COAP_CODE_CONTINUE

RFC7959 Continuar.

OT_COAP_CODE_CREATED

Criado.

OT_COAP_CODE_DELETE

Excluir.

OT_COAP_CODE_DELETED

Excluído.

OT_COAP_CODE_EMPTY

Código de mensagem vazio.

OT_COAP_CODE_FORBIDDEN

Proibido.

OT_COAP_CODE_GATEWAY_TIMEOUT

Tempo limite do gateway.

OT_COAP_CODE_GET

Pegue.

OT_COAP_CODE_INTERNAL_ERROR

Erro do Servidor Interno.

OT_COAP_CODE_METHOD_NOT_ALLOWED

Método não permitido.

OT_COAP_CODE_NOT_ACCEPTABLE

Não aceitável.

OT_COAP_CODE_NOT_FOUND

Não encontrado.

OT_COAP_CODE_NOT_IMPLEMENTED

Não implementado.

OT_COAP_CODE_POST

Publicar.

OT_COAP_CODE_PRECONDITION_FAILED

Falha na pré-condição.

OT_COAP_CODE_PROXY_NOT_SUPPORTED

Proxy não suportado.

OT_COAP_CODE_PUT

Colocar.

OT_COAP_CODE_REQUEST_INCOMPLETE

RFC7959 Solicitar Entidade Incompleta.

OT_COAP_CODE_REQUEST_TOO_LARGE

Entidade de solicitação muito grande.

OT_COAP_CODE_RESPONSE_MIN

2,00

OT_COAP_CODE_SERVICE_UNAVAILABLE

Serviço indisponível.

OT_COAP_CODE_UNAUTHORIZED

Não autorizado.

OT_COAP_CODE_UNSUPPORTED_FORMAT

Formato de conteúdo não suportado.

OT_COAP_CODE_VALID

Válido.

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

Propriedades
OT_COAP_OPTION_CONTENT_FORMAT_CBOR

aplicativo/cbor: [RFC7049]

OT_COAP_OPTION_CONTENT_FORMAT_COAP_GROUP_JSON

application/coap-group+json: [RFC7390]

OT_COAP_OPTION_CONTENT_FORMAT_COSE_ENCRYPT

aplicação/caso; cose-type="cose-encrypt": [RFC8152]

OT_COAP_OPTION_CONTENT_FORMAT_COSE_ENCRYPT0

aplicação/caso; cose-type="cose-encrypt0": [RFC8152]

OT_COAP_OPTION_CONTENT_FORMAT_COSE_KEY

aplicativo/chave de cose: [RFC8152]

OT_COAP_OPTION_CONTENT_FORMAT_COSE_KEY_SET

aplicativo/conjunto de chave cose: [RFC8152]

OT_COAP_OPTION_CONTENT_FORMAT_COSE_MAC

aplicação/caso; cose-type="cose-mac": [RFC8152]

OT_COAP_OPTION_CONTENT_FORMAT_COSE_MAC0

aplicação/caso; cose-type="cose-mac0": [RFC8152]

OT_COAP_OPTION_CONTENT_FORMAT_COSE_SIGN

aplicação/caso; cose-type="cose-sign": [RFC8152]

OT_COAP_OPTION_CONTENT_FORMAT_COSE_SIGN1

aplicação/caso; cose-type="cose-sign1": [RFC8152]

OT_COAP_OPTION_CONTENT_FORMAT_CWT

aplicativo/cwt: [RFC8392]

OT_COAP_OPTION_CONTENT_FORMAT_EXI

application/exi: ["Efficient XML Interchange (EXI) Format 1.0 (Second Edition)", fevereiro de 2014]

OT_COAP_OPTION_CONTENT_FORMAT_JSON

application/json: [RFC7159]

OT_COAP_OPTION_CONTENT_FORMAT_JSON_PATCH_JSON

application/json-patch+json: [RFC6902]

OT_COAP_OPTION_CONTENT_FORMAT_LINK_FORMAT

aplicativo/formato de link: [RFC6690]

OT_COAP_OPTION_CONTENT_FORMAT_MERGE_PATCH_JSON

application/merge-patch+json: [RFC7396]

OT_COAP_OPTION_CONTENT_FORMAT_OCTET_STREAM

application/octet-stream: [RFC2045][RFC2046]

OT_COAP_OPTION_CONTENT_FORMAT_SENML_CBOR

aplicativo/senml+cbor: [RFC8428]

OT_COAP_OPTION_CONTENT_FORMAT_SENML_EXI

application/senml-exi: [RFC8428]

OT_COAP_OPTION_CONTENT_FORMAT_SENML_JSON

application/senml+json: [RFC8428]

OT_COAP_OPTION_CONTENT_FORMAT_SENML_XML

application/senml+xml: [RFC8428]

OT_COAP_OPTION_CONTENT_FORMAT_SENSML_CBOR

aplicativo/sensml+cbor: [RFC8428]

OT_COAP_OPTION_CONTENT_FORMAT_SENSML_EXI

application/sensml-exi: [RFC8428]

OT_COAP_OPTION_CONTENT_FORMAT_SENSML_JSON

aplicativo/sensml+json: [RFC8428]

OT_COAP_OPTION_CONTENT_FORMAT_SENSML_XML

aplicativo/sensml+xml: [RFC8428]

OT_COAP_OPTION_CONTENT_FORMAT_TEXT_PLAIN

texto/simples; charset=utf-8: [RFC2046][RFC3676][RFC5147]

OT_COAP_OPTION_CONTENT_FORMAT_XML

application/xml: [RFC3023]

otCoapOptionType

 otCoapOptionType

Números de opção CoAP.

Propriedades
OT_COAP_OPTION_ACCEPT

Aceitar.

OT_COAP_OPTION_BLOCK1

Bloco1 (RFC7959)

OT_COAP_OPTION_BLOCK2

Bloco2 (RFC7959)

OT_COAP_OPTION_CONTENT_FORMAT

Conteúdo-Formato.

OT_COAP_OPTION_E_TAG

Etag.

OT_COAP_OPTION_IF_MATCH

Se-Correspondência.

OT_COAP_OPTION_IF_NONE_MATCH

Se-Nenhum-Correspondência.

OT_COAP_OPTION_LOCATION_PATH

Localização-Caminho.

OT_COAP_OPTION_LOCATION_QUERY

Localização-Consulta.

OT_COAP_OPTION_MAX_AGE

Max-idade.

OT_COAP_OPTION_OBSERVE

Observe [RFC7641].

OT_COAP_OPTION_PROXY_SCHEME

Esquema de proxy.

OT_COAP_OPTION_PROXY_URI

Proxy-Uri.

OT_COAP_OPTION_SIZE1

Tamanho1.

OT_COAP_OPTION_SIZE2

Tamanho2 (RFC7959)

OT_COAP_OPTION_URI_HOST

Uri-Host.

OT_COAP_OPTION_URI_PATH

Uri-Caminho.

OT_COAP_OPTION_URI_PORT

Uri-Porto.

OT_COAP_OPTION_URI_QUERY

Uri-Query.

otCoapType

 otCoapType

Valores do tipo CoAP (inteiro sem sinal de 2 bits).

Propriedades
OT_COAP_TYPE_ACKNOWLEDGMENT

Reconhecimento.

OT_COAP_TYPE_CONFIRMABLE

Confirmável.

OT_COAP_TYPE_NON_CONFIRMABLE

Não confirmável.

OT_COAP_TYPE_RESET

Redefinir.

Typedefs

otCoapBlockSzx

enum otCoapBlockSzx otCoapBlockSzx

Expoentes de tamanho de bloco CoAP.

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
[in] aContext
Um ponteiro para o contexto específico do aplicativo.
[in] aBlock
Um ponteiro para o segmento de bloco.
[in] aPosition
A posição de aBlock em uma sequência em bytes.
[in] aBlockLength
O comprimento do segmento de bloco em bytes.
[in] aMore
Sinalize se mais segmentos de bloco estiverem seguindo.
[in] aTotalLength
O comprimento total em bytes das informações transferidas (indicado por uma opção Tamanho1 ou Tamanho2).
Valores de retorno
OT_ERROR_NONE
O segmento do bloco foi armazenado com sucesso.
OT_ERROR_NO_BUFS
Não há mais memória para armazenar blocos.
OT_ERROR_NO_FRAME_RECEIVED
Segmento de bloco ausente.

otCoapBlockwiseResource

struct otCoapBlockwiseResource otCoapBlockwiseResource

Essa 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 recebimento do primeiro bloco, pois alterações posteriores podem causar problemas com outras implementações de CoAP.

Detalhes
Parâmetros
[in] aContext
Um ponteiro para o contexto específico do aplicativo.
[in,out] aBlock
Um ponteiro para onde o segmento de bloco pode ser gravado.
[in] aPosition
A posição em uma sequência da qual obter o segmento de bloco.
[in,out] aBlockLength
Na entrada, o comprimento máximo do segmento de bloco em bytes.
[out] aMore
Um ponteiro para o sinalizador se mais segmentos de bloco se seguirem.
Valores de retorno
OT_ERROR_NONE
Nenhum erro ocorreu.
OT_ERROR_INVALID_ARGS
Bloquear em aPosition não existe.

otCoapCode

enum otCoapCode otCoapCode

Valores do código CoAP.

otCoapOption

struct otCoapOption otCoapOption

Essa estrutura representa uma opção CoAP.

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 opções CoAP.

otCoapOptionType

enum otCoapOptionType otCoapOptionType

Números de opção 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
[in] aContext
Um ponteiro para informações de contexto arbitrárias.
[in] aMessage
Um ponteiro para a mensagem.
[in] aMessageInfo
Um ponteiro para as informações da mensagem para aMessage .

otCoapResource

struct otCoapResource otCoapResource

Essa estrutura representa um recurso CoAP.

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
[in] aContext
Um ponteiro para o contexto específico do aplicativo.
[in] aMessage
Um ponteiro para o buffer de mensagem que contém a resposta. NULL se nenhuma resposta foi recebida.
[in] aMessageInfo
Um ponteiro para as informações da mensagem para aMessage . NULL se nenhuma resposta foi recebida.
[in] aResult
Um resultado da transação CoAP.
Valores de retorno
OT_ERROR_NONE
Uma resposta foi recebida com sucesso.
OT_ERROR_ABORT
Uma transação CoAP foi redefinida por peer.
OT_ERROR_RESPONSE_TIMEOUT
Nenhuma resposta ou confirmação recebida durante o período de tempo limite.

otCoapTxParameters

struct otCoapTxParameters otCoapTxParameters

Essa estrutura representa os parâmetros de transmissão do CoAP.

otCoapType

enum otCoapType otCoapType

Valores do tipo CoAP (inteiro sem sinal de 2 bits).

Funções

otCoapAddBlockWiseResource

void otCoapAddBlockWiseResource(
  otInstance *aInstance,
  otCoapBlockwiseResource *aResource
)

Esta função adiciona um recurso em bloco ao servidor CoAP.

Detalhes
Parâmetros
[in] aInstance
Um ponteiro para uma instância OpenThread.
[in] aResource
Um ponteiro para o recurso.

otCoapAddResource

void otCoapAddResource(
  otInstance *aInstance,
  otCoapResource *aResource
)

Esta função adiciona um recurso ao servidor CoAP.

Detalhes
Parâmetros
[in] aInstance
Um ponteiro para uma instância OpenThread.
[in] aResource
Um ponteiro para o recurso.

otCoapBlockSizeFromExponent

uint16_t otCoapBlockSizeFromExponent(
  otCoapBlockSzx aSize
)

Esta função converte um campo SZX da opção CoAP Block para o tamanho real do bloco.

Detalhes
Parâmetros
[in] aSize
Expoente do tamanho do bloco.
Devoluções
O valor do expoente de tamanho real.

otCoapMessageAppendBlock1Option

otError otCoapMessageAppendBlock1Option(
  otMessage *aMessage,
  uint32_t aNum,
  bool aMore,
  otCoapBlockSzx aSize
)

Esta função acrescenta uma opção Block1.

Detalhes
Parâmetros
[in,out] aMessage
Um ponteiro para a mensagem CoAP.
[in] aNum
Número do bloco atual.
[in] aMore
Boolean para indicar que mais blocos devem ser enviados.
[in] aSize
Expoente do tamanho do bloco.
Valores de retorno
OT_ERROR_NONE
Opção anexada com sucesso.
OT_ERROR_INVALID_ARGS
O tipo de opção não é igual ou maior que o último tipo de opção.
OT_ERROR_NO_BUFS
O comprimento da opção excede o tamanho do buffer.

otCoapMessageAppendBlock2Option

otError otCoapMessageAppendBlock2Option(
  otMessage *aMessage,
  uint32_t aNum,
  bool aMore,
  otCoapBlockSzx aSize
)

Esta função acrescenta uma opção Block2.

Detalhes
Parâmetros
[in,out] aMessage
Um ponteiro para a mensagem CoAP.
[in] aNum
Número do bloco atual.
[in] aMore
Boolean para indicar que mais blocos devem ser enviados.
[in] aSize
Expoente do tamanho do bloco.
Valores de retorno
OT_ERROR_NONE
Opção anexada com sucesso.
OT_ERROR_INVALID_ARGS
O tipo de opção não é igual ou maior que o último tipo de opção.
OT_ERROR_NO_BUFS
O comprimento da opção excede o tamanho do buffer.

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 .

Isso deve ser chamado antes de configurar otCoapMessageSetPayloadMarker se uma carga útil for incluída na mensagem.

A função é um wrapper de conveniência em torno de otCoapMessageAppendUintOption e, se o código do tipo de formato desejado não estiver listado em otCoapOptionContentFormat, essa função base deve ser usada.

Detalhes
Parâmetros
[in,out] aMessage
Um ponteiro para a mensagem CoAP.
[in] aContentFormat
Um dos formatos de conteúdo listados em otCoapOptionContentFormat acima.
Valores de retorno
OT_ERROR_NONE
Opção anexada com sucesso.
OT_ERROR_INVALID_ARGS
O tipo de opção não é igual ou maior que o último tipo de opção.
OT_ERROR_NO_BUFS
O comprimento da opção excede o tamanho do buffer.

otCoapMessageAppendMaxAgeOption

otError otCoapMessageAppendMaxAgeOption(
  otMessage *aMessage,
  uint32_t aMaxAge
)

Esta função acrescenta uma opção Max-Age.

Detalhes
Parâmetros
[in,out] aMessage
Um ponteiro para a mensagem CoAP.
[in] aMaxAge
O valor da idade máxima.
Valores de retorno
OT_ERROR_NONE
Opção anexada com sucesso.
OT_ERROR_INVALID_ARGS
O tipo de opção não é igual ou maior que o último tipo de opção.
OT_ERROR_NO_BUFS
O comprimento da opção excede o tamanho do buffer.

otCoapMessageAppendObserveOption

otError otCoapMessageAppendObserveOption(
  otMessage *aMessage,
  uint32_t aObserve
)

Esta função acrescenta uma opção Observar.

Detalhes
Parâmetros
[in,out] aMessage
Um ponteiro para a mensagem CoAP.
[in] aObserve
Observe o valor do campo.
Valores de retorno
OT_ERROR_NONE
Opção anexada com sucesso.
OT_ERROR_INVALID_ARGS
O tipo de opção não é igual ou maior que o último tipo de opção.
OT_ERROR_NO_BUFS
O comprimento da opção excede o tamanho do buffer.

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
[in,out] aMessage
Um ponteiro para a mensagem CoAP.
[in] aNumber
O número da Opção CoAP.
[in] aLength
O comprimento da opção CoAP.
[in] aValue
Um ponteiro para o valor CoAP.
Valores de retorno
OT_ERROR_NONE
Opção anexada com sucesso.
OT_ERROR_INVALID_ARGS
O tipo de opção não é igual ou maior que o último tipo de opção.
OT_ERROR_NO_BUFS
O comprimento da opção excede o tamanho do buffer.

otCoapMessageAppendProxyUriOption

otError otCoapMessageAppendProxyUriOption(
  otMessage *aMessage,
  const char *aUriPath
)

Esta função acrescenta uma opção Proxy-Uri.

Detalhes
Parâmetros
[in,out] aMessage
Um ponteiro para a mensagem CoAP.
[in] aUriPath
Um ponteiro para uma string terminada em NULL.
Valores de retorno
OT_ERROR_NONE
Opção anexada com sucesso.
OT_ERROR_INVALID_ARGS
O tipo de opção não é igual ou maior que o último tipo de opção.
OT_ERROR_NO_BUFS
O comprimento da opção excede o tamanho do buffer.

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
[in,out] aMessage
Um ponteiro para a mensagem CoAP.
[in] aNumber
O número da Opção CoAP.
[in] aValue
O valor inteiro não assinado da opção CoAP.
Valores de retorno
OT_ERROR_NONE
Opção anexada com sucesso.
OT_ERROR_INVALID_ARGS
O tipo de opção não é igual ou maior que o último tipo de opção.
OT_ERROR_NO_BUFS
O comprimento da opção excede o tamanho do buffer.
Veja também:
otCoapMessageGetOptionUintValue

otCoapMessageAppendUriPathOptions

otError otCoapMessageAppendUriPathOptions(
  otMessage *aMessage,
  const char *aUriPath
)

Esta função acrescenta uma opção Uri-Path.

Detalhes
Parâmetros
[in,out] aMessage
Um ponteiro para a mensagem CoAP.
[in] aUriPath
Um ponteiro para uma string terminada em NULL.
Valores de retorno
OT_ERROR_NONE
Opção anexada com sucesso.
OT_ERROR_INVALID_ARGS
O tipo de opção não é igual ou maior que o último tipo de opção.
OT_ERROR_NO_BUFS
O comprimento da opção excede o tamanho do buffer.

otCoapMessageAppendUriQueryOption

otError otCoapMessageAppendUriQueryOption(
  otMessage *aMessage,
  const char *aUriQuery
)

Esta função anexa uma única opção Uri-Query.

Detalhes
Parâmetros
[in,out] aMessage
Um ponteiro para a mensagem CoAP.
[in] aUriQuery
Um ponteiro para string terminada em NULL, que deve conter um único par chave=valor.
Valores de retorno
OT_ERROR_NONE
Opção anexada com sucesso.
OT_ERROR_INVALID_ARGS
O tipo de opção não é igual ou maior que o último tipo de opção.
OT_ERROR_NO_BUFS
O comprimento da opção excede o tamanho do buffer.

otCoapMessageCodeToString

const char * otCoapMessageCodeToString(
  const otMessage *aMessage
)

Este método retorna o código CoAP como uma string legível por humanos.

@ retorna o código CoAP como string.

Detalhes
Parâmetros
[in] aMessage
Um ponteiro para a mensagem CoAP.

otCoapMessageGenerateToken

void otCoapMessageGenerateToken(
  otMessage *aMessage,
  uint8_t aTokenLength
)

Esta função define o comprimento do Token e randomiza seu valor.

Detalhes
Parâmetros
[in,out] aMessage
Um ponteiro para a mensagem CoAP.
[in] aTokenLength
O comprimento de um token a ser definido.

otCoapMessageGetCode

otCoapCode otCoapMessageGetCode(
  const otMessage *aMessage
)

Esta função retorna o valor do código.

Detalhes
Parâmetros
[in] aMessage
Um ponteiro para a mensagem CoAP.
Devoluções
O valor do Código.

otCoapMessageGetMessageId

uint16_t otCoapMessageGetMessageId(
  const otMessage *aMessage
)

Esta função retorna o valor de ID da mensagem.

Detalhes
Parâmetros
[in] aMessage
Um ponteiro para a mensagem CoAP.
Devoluções
O valor de 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
[in] aMessage
Um ponteiro para a mensagem CoAP.
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
[in] aMessage
Um ponteiro para a mensagem CoAP.
Devoluções
O comprimento do token.

otCoapMessageGetType

otCoapType otCoapMessageGetType(
  const otMessage *aMessage
)

Esta função retorna o valor Tipo.

Detalhes
Parâmetros
[in] aMessage
Um ponteiro para a mensagem CoAP.
Devoluções
O valor Tipo.

otCoapMessageInit

void otCoapMessageInit(
  otMessage *aMessage,
  otCoapType aType,
  otCoapCode aCode
)

Esta função inicializa o cabeçalho CoAP.

Detalhes
Parâmetros
[in,out] aMessage
Um ponteiro para a mensagem CoAP para inicializar.
[in] aType
Tipo de mensagem CoAP.
[in] aCode
Código da mensagem CoAP.

otCoapMessageInitResponse

otError otCoapMessageInitResponse(
  otMessage *aResponse,
  const otMessage *aRequest,
  otCoapType aType,
  otCoapCode aCode
)

Esta função inicializa uma mensagem de resposta.

Detalhes
Parâmetros
[in,out] aResponse
Um ponteiro para a mensagem de resposta do CoAP.
[in] aRequest
Um ponteiro para a mensagem de solicitação do CoAP.
[in] aType
Tipo de mensagem CoAP.
[in] aCode
Código da mensagem CoAP.
Valores de retorno
OT_ERROR_NONE
Inicializou com sucesso a mensagem de resposta.
OT_ERROR_NO_BUFS
Buffers de mensagem insuficientes disponíveis para inicializar a mensagem de resposta.

otCoapMessageSetCode

void otCoapMessageSetCode(
  otMessage *aMessage,
  otCoapCode aCode
)

Esta função define o valor do Código.

Detalhes
Parâmetros
[in,out] aMessage
Um ponteiro para a mensagem CoAP para inicializar.
[in] aCode
Código da mensagem CoAP.

otCoapMessageSetPayloadMarker

otError otCoapMessageSetPayloadMarker(
  otMessage *aMessage
)

Esta função adiciona o marcador de carga útil que indica o início da carga útil ao cabeçalho CoAP.

Detalhes
Parâmetros
[in,out] aMessage
Um ponteiro para a mensagem CoAP.
Valores de retorno
OT_ERROR_NONE
Marcador de carga adicionado com sucesso.
OT_ERROR_NO_BUFS
O marcador de carga útil do cabeçalho excede o tamanho do buffer.

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
[in,out] aMessage
Um ponteiro para a mensagem CoAP.
[in] aToken
Um ponteiro para o valor do Token.
[in] aTokenLength
O comprimento de um aToken .
Valores de retorno
OT_ERROR_NONE
Defina com sucesso o valor do Token.
OT_ERROR_NO_BUFS
Buffers insuficientes para definir o valor do Token.

otCoapNewMessage

otMessage * otCoapNewMessage(
  otInstance *aInstance,
  const otMessageSettings *aSettings
)

Esta função cria uma nova mensagem CoAP.

Detalhes
Parâmetros
[in] aInstance
Um ponteiro para uma instância OpenThread.
[in] aSettings
Um ponteiro para as configurações de mensagem ou NULL para definir as configurações padrão.
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
[in,out] aIterator
Um ponteiro para o iterador de opção de mensagem CoAP.
Devoluções
Um ponteiro para a primeira opção. Se nenhuma opção estiver presente, o ponteiro NULL será retornado.

otCoapOptionIteratorGetFirstOptionMatching

const otCoapOption * otCoapOptionIteratorGetFirstOptionMatching(
  otCoapOptionIterator *aIterator,
  uint16_t aOption
)

Esta função retorna um ponteiro para a primeira opção que corresponde ao número de opção especificado.

Detalhes
Parâmetros
[in] aIterator
Um ponteiro para o iterador de opção de mensagem CoAP.
[in] aOption
O número da opção procurada.
Devoluções
Um ponteiro para a primeira opção correspondente. Se nenhuma opção correspondente estiver presente, o ponteiro NULL será retornado.

otCoapOptionIteratorGetNextOption

const otCoapOption * otCoapOptionIteratorGetNextOption(
  otCoapOptionIterator *aIterator
)

Esta função retorna um ponteiro para a próxima opção.

Detalhes
Parâmetros
[in,out] aIterator
Um ponteiro para o iterador de opção de mensagem CoAP.
Devoluções
Um ponteiro para a próxima opção. Se não houver mais opções, 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 que corresponde ao número da opção especificada.

Detalhes
Parâmetros
[in] aIterator
Um ponteiro para o iterador de opção de mensagem CoAP.
[in] aOption
O número da opção procurada.
Devoluções
Um ponteiro para a próxima opção correspondente. Se nenhuma outra opção de correspondência estiver presente, o ponteiro NULL será 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
[in,out] aIterator
Um ponteiro para o iterador de opção de mensagem CoAP.
[out] aValue
Um ponteiro para um inteiro sem sinal para receber o valor da opção.
Valores de retorno
OT_ERROR_NONE
Valor preenchido com sucesso.
OT_ERROR_NOT_FOUND
Nenhuma opção atual.
OT_ERROR_NO_BUFS
O valor é muito longo para caber em um uint64_t.
Veja também:
otCoapMessageAppendUintOption

otCoapOptionIteratorGetOptionValue

otError otCoapOptionIteratorGetOptionValue(
  otCoapOptionIterator *aIterator,
  void *aValue
)

Esta função preenche o valor da opção atual em aValue .

Detalhes
Parâmetros
[in,out] aIterator
Um ponteiro para o iterador de opção de mensagem CoAP.
[out] aValue
Um ponteiro para um buffer para receber o valor da opção.
Valores de retorno
OT_ERROR_NONE
Valor preenchido com sucesso.
OT_ERROR_NOT_FOUND
Nenhuma opção atual.

otCoapOptionIteratorInit

otError otCoapOptionIteratorInit(
  otCoapOptionIterator *aIterator,
  const otMessage *aMessage
)

Esta função inicializa um iterador para as opções na mensagem fornecida.

Detalhes
Parâmetros
[in,out] aIterator
Um ponteiro para o iterador de opção de mensagem CoAP.
[in] aMessage
Um ponteiro para a mensagem CoAP.
Valores de retorno
OT_ERROR_NONE
Inicializado com sucesso.
OT_ERROR_PARSE
O estado da mensagem é inconsistente.

otCoapRemoveBlockWiseResource

void otCoapRemoveBlockWiseResource(
  otInstance *aInstance,
  otCoapBlockwiseResource *aResource
)

Esta função remove um recurso em bloco do servidor CoAP.

Detalhes
Parâmetros
[in] aInstance
Um ponteiro para uma instância OpenThread.
[in] aResource
Um ponteiro para o recurso.

otCoapRemoveResource

void otCoapRemoveResource(
  otInstance *aInstance,
  otCoapResource *aResource
)

Esta função remove um recurso do servidor CoAP.

Detalhes
Parâmetros
[in] aInstance
Um ponteiro para uma instância OpenThread.
[in] aResource
Um ponteiro para o recurso.

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 para uma solicitação for esperada, as respectivas informações de função e contexto devem ser fornecidas. Se nenhuma resposta for esperada, esses argumentos devem ser ponteiros NULL.

Detalhes
Parâmetros
[in] aInstance
Um ponteiro para uma instância OpenThread.
[in] aMessage
Um ponteiro para a mensagem a ser enviada.
[in] aMessageInfo
Um ponteiro para as informações da mensagem associadas a aMessage .
[in] aHandler
Um ponteiro de função que deve ser chamado na recepção da resposta ou no tempo limite.
[in] aContext
Um ponteiro para informações de contexto arbitrárias. Pode ser NULL se não for usado.
Valores de retorno
OT_ERROR_NONE
Mensagem CoAP enviada com sucesso.
OT_ERROR_NO_BUFS
Falha ao alocar dados de retransmissão.

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 para uma solicitação for esperada, as respectivas informações de função e 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
[in] aInstance
Um ponteiro para uma instância OpenThread.
[in] aMessage
Um ponteiro para a mensagem a ser enviada.
[in] aMessageInfo
Um ponteiro para as informações da mensagem associadas a aMessage .
[in] aHandler
Um ponteiro de função que deve ser chamado na recepção da resposta ou no tempo limite.
[in] aContext
Um ponteiro para informações de contexto arbitrárias. Pode ser NULL se não for usado.
[in] aTransmitHook
Um ponteiro para uma função de gancho para transferência em bloco de saída.
[in] aReceiveHook
Um ponteiro para uma função de gancho para transferência em bloco de entrada.
Valores de retorno
OT_ERROR_NONE
Mensagem CoAP enviada com sucesso.
OT_ERROR_NO_BUFS
Falha ao alocar dados de retransmissão.

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 para uma solicitação for esperada, as respectivas informações de função e 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
[in] aInstance
Um ponteiro para uma instância OpenThread.
[in] aMessage
Um ponteiro para a mensagem a ser enviada.
[in] aMessageInfo
Um ponteiro para as informações da mensagem associadas a aMessage .
[in] aHandler
Um ponteiro de função que deve ser chamado na recepção da resposta ou no tempo limite.
[in] aContext
Um ponteiro para informações de contexto arbitrárias. Pode ser NULL se não for usado.
[in] aTxParameters
Um ponteiro para parâmetros de transmissão para esta solicitação. Use NULL para padrões.
[in] aTransmitHook
Um ponteiro para uma função de gancho para transferência em bloco de saída.
[in] aReceiveHook
Um ponteiro para uma função de gancho para transferência em bloco de entrada.
Valores de retorno
OT_ERROR_NONE
Mensagem CoAP enviada com sucesso.
OT_ERROR_NO_BUFS
Falha ao alocar dados de retransmissão.

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 para uma solicitação for esperada, as respectivas informações de função e contexto devem ser fornecidas. Se nenhuma resposta for esperada, esses argumentos devem ser ponteiros NULL.

Detalhes
Parâmetros
[in] aInstance
Um ponteiro para uma instância OpenThread.
[in] aMessage
Um ponteiro para a mensagem a ser enviada.
[in] aMessageInfo
Um ponteiro para as informações da mensagem associadas a aMessage .
[in] aHandler
Um ponteiro de função que deve ser chamado na recepção da resposta ou no tempo limite.
[in] aContext
Um ponteiro para informações de contexto arbitrárias. Pode ser NULL se não for usado.
[in] aTxParameters
Um ponteiro para parâmetros de transmissão para esta solicitação. Use NULL para padrões. Caso contrário, os parâmetros fornecidos devem atender às seguintes condições:
  1. mMaxRetransmit não é maior que OT_COAP_MAX_RETRASMIT.
  2. mAckRandomFactorNumerator / mAckRandomFactorDenominator não deve ser inferior a 1.0.
  3. A vida útil da troca calculada não deve exceder uint32_t.
Valores de retorno
OT_ERROR_INVALID_ARGS
aTxParameters é inválido.
OT_ERROR_NONE
Mensagem CoAP enviada com sucesso.
OT_ERROR_NO_BUFS
Falha ao alocar dados de retransmissão.

otCoapSendResponse

otError otCoapSendResponse(
  otInstance *aInstance,
  otMessage *aMessage,
  const otMessageInfo *aMessageInfo
)

Esta função envia uma resposta CoAP do servidor.

Detalhes
Parâmetros
[in] aInstance
Um ponteiro para uma instância OpenThread.
[in] aMessage
Um ponteiro para a resposta do CoAP a ser enviada.
[in] aMessageInfo
Um ponteiro para as informações da mensagem associadas a aMessage .
Valores de retorno
OT_ERROR_NONE
Enfileirado com sucesso a mensagem de resposta do CoAP.
OT_ERROR_NO_BUFS
Buffers insuficientes disponíveis para enviar a resposta CoAP.

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
[in] aInstance
Um ponteiro para uma instância OpenThread.
[in] aMessage
Um ponteiro para a resposta do CoAP a ser enviada.
[in] aMessageInfo
Um ponteiro para as informações da mensagem associadas a aMessage .
[in] aContext
Um ponteiro para informações de contexto arbitrárias. Pode ser NULL se não for usado.
[in] aTransmitHook
Um ponteiro para uma função de gancho para transferência em bloco de saída.
Valores de retorno
OT_ERROR_NONE
Enfileirado com sucesso a mensagem de resposta do CoAP.
OT_ERROR_NO_BUFS
Buffers insuficientes disponíveis para enviar a resposta CoAP.

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
[in] aInstance
Um ponteiro para uma instância OpenThread.
[in] aMessage
Um ponteiro para a resposta do CoAP a ser enviada.
[in] aMessageInfo
Um ponteiro para as informações da mensagem associadas a aMessage .
[in] aTxParameters
Um ponteiro para parâmetros de transmissão para esta resposta. Use NULL para padrões.
[in] aContext
Um ponteiro para informações de contexto arbitrárias. Pode ser NULL se não for usado.
[in] aTransmitHook
Um ponteiro para uma função de gancho para transferência em bloco de saída.
Valores de retorno
OT_ERROR_NONE
Enfileirado com sucesso a mensagem de resposta do CoAP.
OT_ERROR_NO_BUFS
Buffers insuficientes disponíveis para enviar a resposta CoAP.

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
[in] aInstance
Um ponteiro para uma instância OpenThread.
[in] aMessage
Um ponteiro para a resposta do CoAP a ser enviada.
[in] aMessageInfo
Um ponteiro para as informações da mensagem associadas a aMessage .
[in] aTxParameters
Um ponteiro para parâmetros de transmissão para esta resposta. Use NULL para padrões.
Valores de retorno
OT_ERROR_NONE
Enfileirado com sucesso a mensagem de resposta do CoAP.
OT_ERROR_NO_BUFS
Buffers insuficientes disponíveis para enviar a resposta CoAP.

otCoapSetDefaultHandler

void otCoapSetDefaultHandler(
  otInstance *aInstance,
  otCoapRequestHandler aHandler,
  void *aContext
)

Essa função define o manipulador padrão para solicitações CoAP não tratadas.

Detalhes
Parâmetros
[in] aInstance
Um ponteiro para uma instância OpenThread.
[in] aHandler
Um ponteiro de função que deve ser chamado quando uma solicitação não tratada chega.
[in] aContext
Um ponteiro para informações de contexto arbitrárias. Pode ser NULL se não for usado.

otCoapStart

otError otCoapStart(
  otInstance *aInstance,
  uint16_t aPort
)

Esta função inicia o servidor CoAP.

Detalhes
Parâmetros
[in] aInstance
Um ponteiro para uma instância OpenThread.
[in] aPort
A porta UDP local à qual se ligar.
Valores de retorno
OT_ERROR_NONE
Iniciado com sucesso o servidor CoAP.
OT_ERROR_FAILED
Falha ao iniciar o servidor CoAP.

otCoapStop

otError otCoapStop(
  otInstance *aInstance
)

Esta função para o servidor CoAP.

Detalhes
Parâmetros
[in] aInstance
Um ponteiro para uma instância OpenThread.
Valores de retorno
OT_ERROR_NONE
O servidor CoAP foi interrompido com sucesso.

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 do token padrão.

OT_COAP_MAX_RETRANSMIT

 OT_COAP_MAX_RETRANSMIT 20

Retransmissão máxima suportada pelo 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 suportado pelo OpenThread.

OT_DEFAULT_COAP_PORT

 OT_DEFAULT_COAP_PORT 5683

Porta CoAP padrão, conforme especificado no RFC 7252.

Recursos

Os tópicos de referência da API OpenThread se originam do código-fonte, disponível no GitHub . Para obter mais informações ou contribuir com nossa documentação, consulte Recursos .