Google is committed to advancing racial equity for Black communities. See how.
Esta página foi traduzida pela API Cloud Translation.
Switch to English

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.

Enumerações

otCoapBlockSize enum
Expoentes do tamanho do 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))
}
enum
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
}
enum
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_PROXY_URI = 35,
OT_COAP_OPTION_PROXY_SCHEME = 39,
OT_COAP_OPTION_SIZE1 = 60
}
enum
Números de opções do CoAP.
otCoapType {
OT_COAP_TYPE_CONFIRMABLE = 0,
OT_COAP_TYPE_NON_CONFIRMABLE = 1,
OT_COAP_TYPE_ACKNOWLEDGMENT = 2,
OT_COAP_TYPE_RESET = 3
}
enum
Valores do tipo CoAP (inteiro sem sinal de 2 bits).

Typedefs

otCoapBlockSize typedef
Expoentes do tamanho do bloco CoAP.
otCoapCode typedef
enum otCoapCode
Valores do código CoAP.
otCoapOption typedef
struct otCoapOption
Esta estrutura representa uma opção do CoAP.
otCoapOptionContentFormat typedef
Códigos de formato de conteúdo CoAP.
otCoapOptionIterator typedef
Essa estrutura atua como um iterador para as opções do CoAP.
otCoapOptionType typedef
Números de opções do 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
Esta 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
Esta estrutura representa os parâmetros de transmissão do CoAP.
otCoapType typedef
enum otCoapType
Valores do tipo CoAP (inteiro sem sinal de 2 bits).

Funções

otCoapAddResource ( otInstance *aInstance, otCoapResource *aResource)
void
Esta função adiciona um recurso ao servidor CoAP.
otCoapBlockSizeFromExponent ( otCoapBlockSize 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, otCoapBlockSize aSize)
Esta função anexa uma opção Bloco1.
otCoapMessageAppendBlock2Option ( otMessage *aMessage, uint32_t aNum, bool aMore, otCoapBlockSize 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 *const aValue)
Esta função preenche o valor da opção atual em aValue assumindo que o valor atual é um inteiro não assinado 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.
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.
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.
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

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

otCoapBlockSize

 otCoapBlockSize

Expoentes do tamanho do 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

Alterado.

OT_COAP_CODE_CONTENT

Conteúdo.

OT_COAP_CODE_CONTINUE

RFC7959 Continue.

OT_COAP_CODE_CREATED

Criada.

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

Obter.

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

Postar.

OT_COAP_CODE_PRECONDITION_FAILED

A pré-condição falhou.

OT_COAP_CODE_PROXY_NOT_SUPPORTED

Proxying não suportado.

OT_COAP_CODE_PUT

Colocar.

OT_COAP_CODE_REQUEST_INCOMPLETE

RFC7959 Solicitar Entidade Incompleta.

OT_COAP_CODE_REQUEST_TOO_LARGE

Solicitar entidade 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 compatível.

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 / cose; cose-type = "cose-encrypt": [RFC8152]

OT_COAP_OPTION_CONTENT_FORMAT_COSE_ENCRYPT0

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

OT_COAP_OPTION_CONTENT_FORMAT_COSE_KEY

aplicação / cose-key: [RFC8152]

OT_COAP_OPTION_CONTENT_FORMAT_COSE_KEY_SET

application / cose-key-set: [RFC8152]

OT_COAP_OPTION_CONTENT_FORMAT_COSE_MAC

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

OT_COAP_OPTION_CONTENT_FORMAT_COSE_MAC0

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

OT_COAP_OPTION_CONTENT_FORMAT_COSE_SIGN

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

OT_COAP_OPTION_CONTENT_FORMAT_COSE_SIGN1

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

OT_COAP_OPTION_CONTENT_FORMAT_CWT

application / 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

formato de aplicativo / link: [RFC6690]

OT_COAP_OPTION_CONTENT_FORMAT_MERGE_PATCH_JSON

application / merge-patch + json: [RFC7396]

OT_COAP_OPTION_CONTENT_FORMAT_OCTET_STREAM

aplicativo / fluxo de octeto: [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

aplicação / 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

application / 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

aplicativo / xml: [RFC3023]

otCoapOptionType

 otCoapOptionType

Números de opções do CoAP.

Propriedades
OT_COAP_OPTION_ACCEPT

Aceitar.

OT_COAP_OPTION_BLOCK1

Block1 (RFC7959)

OT_COAP_OPTION_BLOCK2

Block2 (RFC7959)

OT_COAP_OPTION_CONTENT_FORMAT

Formato de conteúdo.

OT_COAP_OPTION_E_TAG

ETag.

OT_COAP_OPTION_IF_MATCH

If-Match.

OT_COAP_OPTION_IF_NONE_MATCH

If-None-Match.

OT_COAP_OPTION_LOCATION_PATH

Localização-caminho.

OT_COAP_OPTION_LOCATION_QUERY

Consulta de localização.

OT_COAP_OPTION_MAX_AGE

Max-Age.

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_URI_HOST

Uri-Host.

OT_COAP_OPTION_URI_PATH

Uri-Path.

OT_COAP_OPTION_URI_PORT

Uri-Port.

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

otCoapBlockSize

enum otCoapBlockSize otCoapBlockSize

Expoentes do tamanho do bloco CoAP.

otCoapCode

enum otCoapCode otCoapCode

Valores do código CoAP.

otCoapOption

struct otCoapOption otCoapOption

Esta estrutura representa uma opção do 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 as opções do CoAP.

otCoapOptionType

enum otCoapOptionType otCoapOptionType

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

otCoapResource

struct otCoapResource otCoapResource

Esta 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 for recebida.
[in] aMessageInfo
Um ponteiro para as informações da mensagem para aMessage . NULL se nenhuma resposta for recebida.
[in] aResult
Um resultado da transação CoAP.
Valores Retornados
OT_ERROR_NONE
Uma resposta foi recebida com sucesso.
OT_ERROR_ABORT
Uma transação CoAP foi redefinida por par.
OT_ERROR_RESPONSE_TIMEOUT
Nenhuma resposta ou confirmação recebida durante o período de tempo limite.

otCoapTxParameters

struct otCoapTxParameters otCoapTxParameters

Esta 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

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(
  otCoapBlockSize aSize
)

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

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

otCoapMessageAppendBlock1Option

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

Esta função anexa uma opção Bloco1.

Detalhes
Parâmetros
[in,out] aMessage
Um ponteiro para a mensagem CoAP.
[in] aNum
Número do bloco atual.
[in] aMore
Booleano para indicar que mais blocos devem ser enviados.
[in] aSize
Expoente do tamanho do bloco.
Valores Retornados
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,
  otCoapBlockSize aSize
)

Esta função anexa uma opção Bloco2.

Detalhes
Parâmetros
[in,out] aMessage
Um ponteiro para a mensagem CoAP.
[in] aNum
Número do bloco atual.
[in] aMore
Booleano para indicar que mais blocos devem ser enviados.
[in] aSize
Expoente do tamanho do bloco.
Valores Retornados
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 CoAP de formato de conteúdo conforme especificado em https://tools.ietf.org/html/rfc7252#page-92 .

Ele 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, essa função básica 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 Retornados
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 Max-Age.
Valores Retornados
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 anexa uma opção Observar.

Detalhes
Parâmetros
[in,out] aMessage
Um ponteiro para a mensagem CoAP.
[in] aObserve
Observe o valor do campo.
Valores Retornados
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 Retornados
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 Retornados
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 sem sinal da opção CoAP.
Valores Retornados
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 Retornados
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 acrescenta 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 Retornados
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 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 do ID da mensagem.

Detalhes
Parâmetros
[in] aMessage
Um ponteiro para a mensagem CoAP.
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
[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 de tipo.

Detalhes
Parâmetros
[in] aMessage
Um ponteiro para a mensagem CoAP.
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
[in,out] aMessage
Um ponteiro para a mensagem CoAP a ser inicializada.
[in] aType
Tipo de mensagem CoAP.
[in] aCode
Código de 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 CoAP.
[in] aType
Tipo de mensagem CoAP.
[in] aCode
Código da mensagem CoAP.
Valores Retornados
OT_ERROR_NONE
Mensagem de resposta inicializada com sucesso.
OT_ERROR_NO_BUFS
Buffers de mensagem insuficientes disponíveis para inicializar a mensagem de resposta.

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
[in,out] aMessage
Um ponteiro para a mensagem CoAP.
Valores Retornados
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 do aToken .
Valores Retornados
OT_ERROR_NONE
Defina o valor do Token com sucesso.
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 é 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
[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 é 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 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
[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 correspondente estiver presente, o ponteiro NULL será retornado.

otCoapOptionIteratorGetOptionUintValue

otError otCoapOptionIteratorGetOptionUintValue(
  otCoapOptionIterator *aIterator,
  uint64_t *const aValue
)

Esta função preenche o valor da opção atual em aValue assumindo que o valor atual é um inteiro não assinado 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 Retornados
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 Retornados
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 Retornados
OT_ERROR_NONE
Inicializado com sucesso.
OT_ERROR_PARSE
O estado da mensagem é inconsistente.

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 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
[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ário. Pode ser NULL se não for usado.
Valores Retornados
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 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
[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ário. Pode ser NULL se não for usado.
[in] aTxParameters
Um ponteiro para os parâmetros de transmissão desta solicitação. Use NULL para os padrões. Caso contrário, os parâmetros fornecidos devem atender às seguintes condições:
  1. mMaxRetransmit não é mais do que OT_COAP_MAX_RETRANSMIT.
  2. mAckRandomFactorNumerator / mAckRandomFactorDenominator não deve ser inferior a 1,0.
  3. O tempo de vida de troca calculado não deve ultrapassar uint32_t.
Valores Retornados
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 CoAP a ser enviada.
[in] aMessageInfo
Um ponteiro para as informações da mensagem associadas a aMessage .
Valores Retornados
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 CoAP a ser enviada.
[in] aMessageInfo
Um ponteiro para as informações da mensagem associadas a aMessage .
[in] aTxParameters
Um ponteiro para os parâmetros de transmissão desta resposta. Use NULL para os padrões.
Valores Retornados
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
)

Esta função define o manipulador padrão para solicitações CoAP não manipuladas.

Detalhes
Parâmetros
[in] aInstance
Um ponteiro para uma instância OpenThread.
[in] aHandler
Um ponteiro de função que deve ser chamado quando chega uma solicitação não tratada.
[in] aContext
Um ponteiro para informações de contexto arbitrário. 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 conectar.
Valores Retornados
OT_ERROR_NONE
O servidor CoAP foi iniciado com sucesso.

otCoapStop

otError otCoapStop(
  otInstance *aInstance
)

Esta função interrompe o servidor CoAP.

Detalhes
Parâmetros
[in] aInstance
Um ponteiro para uma instância OpenThread.
Valores Retornados
OT_ERROR_NONE
Parou o servidor CoAP 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 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.