Google se compromete a impulsar la igualdad racial para las comunidades afrodescendientes. Obtén información al respecto.

CoAP

Este módulo incluye funciones que controlan la comunicación de CoAP.

Resumen

Las funciones de este módulo están disponibles cuando la función de API de CoAP (OPENTHREAD_CONFIG_COAP_API_ENABLE) está habilitada.

Enumeraciones

otCoapBlockSzx enum
Exponentes de tamaño de bloque de 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 de 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 contenido de 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
}
enum
Números de opción de 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 de tipo CoAP (número entero de 2 bits sin signo).

Typedefs

otCoapBlockSzx typedef
Exponentes de tamaño de bloque de CoAP.
otCoapBlockwiseReceiveHook)(void *aContext, const uint8_t *aBlock, uint32_t aPosition, uint16_t aBlockLength, bool aMore, uint32_t aTotalLength) typedef
Se llama a este puntero de función cuando se recibe un mensaje de CoAP con una opción de transferencia de bloques.
otCoapBlockwiseResource typedef
Esta estructura representa un recurso CoAP con una transferencia de bloque.
otCoapBlockwiseTransmitHook)(void *aContext, uint8_t *aBlock, uint32_t aPosition, uint16_t *aBlockLength, bool *aMore) typedef
Se llama a este puntero de función antes de enviar el siguiente bloque de una transferencia en bloque.
otCoapCode typedef
enum otCoapCode
Valores de código CoAP.
otCoapOption typedef
struct otCoapOption
Esta estructura representa una opción de CoAP.
otCoapOptionContentFormat typedef
Códigos de formato de contenido de CoAP
otCoapOptionIterator typedef
Esta estructura actúa como un iterador para las opciones de CoAP.
otCoapOptionType typedef
Números de opción de CoAP.
otCoapRequestHandler)(void *aContext, otMessage *aMessage, const otMessageInfo *aMessageInfo) typedef
void(*
Se llama a este puntero de función cuando se recibe una solicitud CoAP con una ruta URI específica.
otCoapResource typedef
Esta estructura representa un recurso de CoAP.
otCoapResponseHandler)(void *aContext, otMessage *aMessage, const otMessageInfo *aMessageInfo, otError aResult) typedef
void(*
Se llama a este puntero de función cuando se recibe una respuesta de CoAP o cuando se agota el tiempo de espera de la solicitud.
otCoapTxParameters typedef
Esta estructura representa los parámetros de transmisión de CoAP.
otCoapType typedef
enum otCoapType
Valores de tipo CoAP (número entero de 2 bits sin signo).

Functions

otCoapAddBlockWiseResource(otInstance *aInstance, otCoapBlockwiseResource *aResource)
void
Esta función agrega un recurso a nivel de bloque al servidor de CoAP.
otCoapAddResource(otInstance *aInstance, otCoapResource *aResource)
void
Esta función agrega un recurso al servidor de CoAP.
otCoapBlockSizeFromExponent(otCoapBlockSzx aSize)
uint16_t
Esta función convierte un campo SZX de opción de bloqueo de CoAP en el tamaño real del bloque.
otCoapMessageAppendBlock1Option(otMessage *aMessage, uint32_t aNum, bool aMore, otCoapBlockSzx aSize)
Esta función agrega una opción Block1.
otCoapMessageAppendBlock2Option(otMessage *aMessage, uint32_t aNum, bool aMore, otCoapBlockSzx aSize)
Esta función agrega una opción Block2.
otCoapMessageAppendContentFormatOption(otMessage *aMessage, otCoapOptionContentFormat aContentFormat)
Esta función agrega la opción de CoAP del formato de contenido como se especifica en https://tools.ietf.org/html/rfc7252#page-92.
otCoapMessageAppendMaxAgeOption(otMessage *aMessage, uint32_t aMaxAge)
Esta función agrega una opción de edad máxima.
otCoapMessageAppendObserveOption(otMessage *aMessage, uint32_t aObserve)
Esta función agrega una opción Observe.
otCoapMessageAppendOption(otMessage *aMessage, uint16_t aNumber, uint16_t aLength, const void *aValue)
Esta función agrega una opción de CoAP en un encabezado.
otCoapMessageAppendProxyUriOption(otMessage *aMessage, const char *aUriPath)
Esta función agrega una opción Proxy-Uri.
otCoapMessageAppendUintOption(otMessage *aMessage, uint16_t aNumber, uint32_t aValue)
Esta función agrega una opción de CoAP de número entero sin firma como se especifica en https://tools.ietf.org/html/rfc7252#section-3.2.
otCoapMessageAppendUriPathOptions(otMessage *aMessage, const char *aUriPath)
Esta función agrega una opción Uri-Path.
otCoapMessageAppendUriQueryOption(otMessage *aMessage, const char *aUriQuery)
Esta función agrega una sola opción de URI.
otCoapMessageCodeToString(const otMessage *aMessage)
const char *
Este método muestra el código CoAP como una string legible.
otCoapMessageGenerateToken(otMessage *aMessage, uint8_t aTokenLength)
void
Esta función establece la longitud del token y aleatoriza su valor.
otCoapMessageGetCode(const otMessage *aMessage)
Esta función muestra el valor del código.
otCoapMessageGetMessageId(const otMessage *aMessage)
uint16_t
Esta función muestra el valor del ID de mensaje.
otCoapMessageGetToken(const otMessage *aMessage)
const uint8_t *
Esta función muestra un puntero para el valor del token.
otCoapMessageGetTokenLength(const otMessage *aMessage)
uint8_t
Esta función muestra la longitud del token.
otCoapMessageGetType(const otMessage *aMessage)
Esta función muestra el valor Type.
otCoapMessageInit(otMessage *aMessage, otCoapType aType, otCoapCode aCode)
void
Esta función inicializa el encabezado de CoAP.
otCoapMessageInitResponse(otMessage *aResponse, const otMessage *aRequest, otCoapType aType, otCoapCode aCode)
Esta función inicializa un mensaje de respuesta.
otCoapMessageSetCode(otMessage *aMessage, otCoapCode aCode)
void
Esta función establece el valor del código.
otCoapMessageSetPayloadMarker(otMessage *aMessage)
Esta función agrega un marcador de carga útil que indica el comienzo de la carga útil en el encabezado de CoAP.
otCoapMessageSetToken(otMessage *aMessage, const uint8_t *aToken, uint8_t aTokenLength)
Esta función establece el valor del token y su longitud en un encabezado.
otCoapNewMessage(otInstance *aInstance, const otMessageSettings *aSettings)
Esta función crea un mensaje de CoAP nuevo.
otCoapOptionIteratorGetFirstOption(otCoapOptionIterator *aIterator)
const otCoapOption *
Esta función muestra un puntero a la primera opción.
otCoapOptionIteratorGetFirstOptionMatching(otCoapOptionIterator *aIterator, uint16_t aOption)
const otCoapOption *
Esta función muestra un puntero para la primera opción que coincide con el número de opción especificado.
otCoapOptionIteratorGetNextOption(otCoapOptionIterator *aIterator)
const otCoapOption *
Esta función muestra un puntero para la siguiente opción.
otCoapOptionIteratorGetNextOptionMatching(otCoapOptionIterator *aIterator, uint16_t aOption)
const otCoapOption *
Esta función muestra un puntero para la siguiente opción que coincide con el número de opción especificado.
otCoapOptionIteratorGetOptionUintValue(otCoapOptionIterator *aIterator, uint64_t *aValue)
Esta función completa el valor de la opción actual en aValue, suponiendo que el valor actual es un número entero sin firma codificado según https://tools.ietf.org/html/rfc7252#section-3.2.
otCoapOptionIteratorGetOptionValue(otCoapOptionIterator *aIterator, void *aValue)
Esta función rellena el valor de la opción actual en aValue.
otCoapOptionIteratorInit(otCoapOptionIterator *aIterator, const otMessage *aMessage)
Esta función inicializa un iterador para las opciones del mensaje en cuestión.
otCoapRemoveBlockWiseResource(otInstance *aInstance, otCoapBlockwiseResource *aResource)
void
Esta función quita un recurso a nivel de bloque del servidor CoAP.
otCoapRemoveResource(otInstance *aInstance, otCoapResource *aResource)
void
Esta función quita un recurso del servidor de CoAP.
otCoapSendRequest(otInstance *aInstance, otMessage *aMessage, const otMessageInfo *aMessageInfo, otCoapResponseHandler aHandler, void *aContext)
Esta función envía una solicitud de CoAP.
otCoapSendRequestBlockWise(otInstance *aInstance, otMessage *aMessage, const otMessageInfo *aMessageInfo, otCoapResponseHandler aHandler, void *aContext, otCoapBlockwiseTransmitHook aTransmitHook, otCoapBlockwiseReceiveHook aReceiveHook)
Esta función envía una solicitud CoAP en bloque.
otCoapSendRequestBlockWiseWithParameters(otInstance *aInstance, otMessage *aMessage, const otMessageInfo *aMessageInfo, otCoapResponseHandler aHandler, void *aContext, const otCoapTxParameters *aTxParameters, otCoapBlockwiseTransmitHook aTransmitHook, otCoapBlockwiseReceiveHook aReceiveHook)
Esta función envía una solicitud CoAP en bloque con parámetros de transmisión personalizados.
otCoapSendRequestWithParameters(otInstance *aInstance, otMessage *aMessage, const otMessageInfo *aMessageInfo, otCoapResponseHandler aHandler, void *aContext, const otCoapTxParameters *aTxParameters)
Esta función envía una solicitud de CoAP con parámetros de transmisión personalizados.
otCoapSendResponse(otInstance *aInstance, otMessage *aMessage, const otMessageInfo *aMessageInfo)
Esta función envía una respuesta CoAP desde el servidor.
otCoapSendResponseBlockWise(otInstance *aInstance, otMessage *aMessage, const otMessageInfo *aMessageInfo, void *aContext, otCoapBlockwiseTransmitHook aTransmitHook)
Esta función envía una respuesta de CoAP a nivel de bloque desde el servidor.
otCoapSendResponseBlockWiseWithParameters(otInstance *aInstance, otMessage *aMessage, const otMessageInfo *aMessageInfo, const otCoapTxParameters *aTxParameters, void *aContext, otCoapBlockwiseTransmitHook aTransmitHook)
Esta función envía una respuesta de CoAP a nivel de bloque desde el servidor con parámetros de transmisión personalizados.
otCoapSendResponseWithParameters(otInstance *aInstance, otMessage *aMessage, const otMessageInfo *aMessageInfo, const otCoapTxParameters *aTxParameters)
Esta función envía una respuesta de CoAP desde el servidor con parámetros de transmisión personalizados.
otCoapSetDefaultHandler(otInstance *aInstance, otCoapRequestHandler aHandler, void *aContext)
void
Esta función establece el controlador predeterminado para las solicitudes de CoAP no controladas.
otCoapStart(otInstance *aInstance, uint16_t aPort)
Esta función inicia el servidor de CoAP.
otCoapStop(otInstance *aInstance)
Esta función detiene el servidor CoAP.

Structs

otCoapBlockwiseResource

Esta estructura representa un recurso CoAP con una transferencia de bloque.

otCoapOption;

Esta estructura representa una opción de CoAP.

otCoapOptionIterator

Esta estructura actúa como un iterador para las opciones de CoAP.

otCoapResource

Esta estructura representa un recurso de CoAP.

OtCoapTxParameters

Esta estructura representa los parámetros de transmisión de CoAP.

Enumeraciones

otCoapBlockSzx

 otCoapBlockSzx

Exponentes de tamaño de bloque de CoAP.

Código otCoap

 otCoapCode

Valores de código CoAP.

Properties
OT_COAP_CODE_BAD_GATEWAY

Puerta de enlace incorrecta.

OT_COAP_CODE_BAD_OPTION

Opción incorrecta.

OT_COAP_CODE_BAD_REQUEST

Solicitud incorrecta.

OT_COAP_CODE_CHANGED

Cambios.

OT_COAP_CODE_CONTENT

Contenido.

OT_COAP_CODE_CONTINUE

RFC7959 Continuar.

OT_COAP_CODE_CREATED

Fecha de creación.

OT_COAP_CODE_DELETE

Delete.

OT_COAP_CODE_DELETED

Se borraron las tareas pendientes.

OT_COAP_CODE_EMPTY

El código del mensaje está vacío.

OT_COAP_CODE_FORBIDDEN

Prohibido.

OT_COAP_CODE_GATEWAY_TIMEOUT

Se agotó el tiempo de espera de la puerta de enlace.

OT_COAP_CODE_GET

¡Completa

OT_COAP_CODE_INTERNAL_ERROR

Error del servidor interno

OT_COAP_CODE_METHOD_NOT_ALLOWED

Método no permitido.

OT_COAP_CODE_NOT_ACCEPTABLE

No aceptable.

OT_COAP_CODE_NOT_FOUND

No se encontró.

OT_COAP_CODE_NOT_IMPLEMENTED

Sin implementar.

OT_COAP_CODE_POST

Publicación.

OT_COAP_CODE_PRECONDITION_FAILED

Error de condición previa.

OT_COAP_CODE_PROXY_NOT_SUPPORTED

No se admite el proxy.

OT_COAP_CODE_PUT

Pon.

OT_COAP_CODE_REQUEST_INCOMPLETE

La entidad de solicitud RFC7959 está incompleta.

OT_COAP_CODE_REQUEST_TOO_LARGE

La entidad solicitada es demasiado grande.

OT_COAP_CODE_RESPONSE_MIN

2.00

OT_COAP_CODE_SERVICE_UNAVAILABLE

Servicio no disponible

OT_COAP_CODE_UNAUTHORIZED

No autorizado.

OT_COAP_CODE_UNSUPPORTED_FORMAT

No se admite el formato de contenido.

OT_COAP_CODE_VALID

Es válida.

otCoapOptionContentFormat

 otCoapOptionContentFormat

Códigos de formato de contenido de CoAP

La lista completa está documentada en https://www.iana.org/assignments/core-parameters/core-parameters.xhtml#content-formats.

Properties
OT_COAP_OPTION_CONTENT_FORMAT_CBOR

aplicación/cbor: [RFC7049]

OT_COAP_OPTION_CONTENT_FORMAT_COAP_GROUP_JSON

application/coap-group+json: [RFC7390]

OT_COAP_OPTION_CONTENT_FORMAT_COSE_ENCRYPT

aplicación/cose; cose-type="cose-encrypt": [RFC8152]

OT_COAP_OPTION_CONTENT_FORMAT_COSE_ENCRYPT0

aplicación/cose; cose-type="cose-encrypt0": [RFC8152]

OT_COAP_OPTION_CONTENT_FORMAT_COSE_KEY

archivo-clave-aplicación: [RFC8152]

OT_COAP_OPTION_CONTENT_FORMAT_COSE_KEY_SET

aplicación/cose-set-clave: [RFC8152]

OT_COAP_OPTION_CONTENT_FORMAT_COSE_MAC

aplicación/cose; cose-type="cose-mac": [RFC8152]

OT_COAP_OPTION_CONTENT_FORMAT_COSE_MAC0

aplicación/cose; cose-type="cose-mac0": [RFC8152]

OT_COAP_OPTION_CONTENT_FORMAT_COSE_SIGN

aplicación/cose; cose-type="cose-sign": [RFC8152]

OT_COAP_OPTION_CONTENT_FORMAT_COSE_SIGN1

aplicación/cose; cose-type="cose-sign1": [RFC8152]

OT_COAP_OPTION_CONTENT_FORMAT_CWT

aplicación/cwt: [RFC8392]

OT_COAP_OPTION_CONTENT_FORMAT_EXI

application/exi: [" eficiente XML Exchange (EXI) Format 1.0 (Second Edition)" febrero de 2014

OT_COAP_OPTION_CONTENT_FORMAT_JSON

aplicación/json: [RFC7159]

OT_COAP_OPTION_CONTENT_FORMAT_JSON_PATCH_JSON

application/json-patch+json: [RFC6902]

OT_COAP_OPTION_CONTENT_FORMAT_LINK_FORMAT

application/link-format: [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

aplicación/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

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

application/sensml+xml: [RFC8428].

OT_COAP_OPTION_CONTENT_FORMAT_TEXT_PLAIN

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

OT_COAP_OPTION_CONTENT_FORMAT_XML

aplicación/xml: [RFC3023]

Tipo de opción de otCoapOption

 otCoapOptionType

Números de opción de CoAP.

Properties
OT_COAP_OPTION_ACCEPT

Aceptar

OT_COAP_OPTION_BLOCK1

Bloque1 (RFC7959)

OT_COAP_OPTION_BLOCK2

Block2 (RFC7959)

OT_COAP_OPTION_CONTENT_FORMAT

Formato del contenido

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

Ruta de ubicación.

OT_COAP_OPTION_LOCATION_QUERY

Consulta de ubicación.

OT_COAP_OPTION_MAX_AGE

Edad máx.

OT_COAP_OPTION_OBSERVE

Observe [RFC7641].

OT_COAP_OPTION_PROXY_SCHEME

Esquema de proxy

OT_COAP_OPTION_PROXY_URI

URI del proxy

OT_COAP_OPTION_SIZE1

Tamaño1.

OT_COAP_OPTION_SIZE2

Tamaño 2 (RFC7959)

OT_COAP_OPTION_URI_HOST

Host de URI.

OT_COAP_OPTION_URI_PATH

Ruta de URI.

OT_COAP_OPTION_URI_PORT

URI de puerto.

OT_COAP_OPTION_URI_QUERY

Uri-Query

Tipo de otCoap

 otCoapType

Valores de tipo CoAP (número entero de 2 bits sin signo).

Properties
OT_COAP_TYPE_ACKNOWLEDGMENT

Declaración.

OT_COAP_TYPE_CONFIRMABLE

Confirmable

OT_COAP_TYPE_NON_CONFIRMABLE

No confirmable.

OT_COAP_TYPE_RESET

Restablecer.

Typedefs

otCoapBlockSzx

enum otCoapBlockSzx otCoapBlockSzx

Exponentes de tamaño de bloque de CoAP.

otCoapBlockwiseReceiveHook

otError(* otCoapBlockwiseReceiveHook)(void *aContext, const uint8_t *aBlock, uint32_t aPosition, uint16_t aBlockLength, bool aMore, uint32_t aTotalLength)

Se llama a este puntero de función cuando se recibe un mensaje de CoAP con una opción de transferencia de bloques.

Esta función está disponible cuando se habilita la configuración OPENThread_CONFIG_COAP_BLOCKWISE_TRANSFER_ENABLE.

Detalles
Parámetros
[in] aContext
Un puntero para el contexto específico de la aplicación.
[in] aBlock
Un puntero para el segmento de bloque.
[in] aPosition
La posición de aBlock en una secuencia en bytes.
[in] aBlockLength
Longitud del segmento del bloque en bytes.
[in] aMore
Marque esta opción si se siguen más segmentos de bloque.
[in] aTotalLength
La longitud total en bytes de la información transferida (indicada por una opción Size1 o Size2).
Valores que se muestran
OT_ERROR_NONE
El segmento de bloque se almacenó correctamente.
OT_ERROR_NO_BUFS
No hay más memoria para almacenar bloques
OT_ERROR_NO_FRAME_RECEIVED
Falta el segmento bloqueado.

otCoapBlockwiseResource

struct otCoapBlockwiseResource otCoapBlockwiseResource

Esta estructura representa un recurso CoAP con una transferencia de bloque.

otCoapBlockwiseTransmitHook

otError(* otCoapBlockwiseTransmitHook)(void *aContext, uint8_t *aBlock, uint32_t aPosition, uint16_t *aBlockLength, bool *aMore)

Se llama a este puntero de función antes de enviar el siguiente bloque de una transferencia en bloque.

Esta función está disponible cuando se habilita la configuración OPENThread_CONFIG_COAP_BLOCKWISE_TRANSFER_ENABLE.

Si se cambia el valor de aBlockLength, se renegocia el tamaño del bloque de todo el intercambio. Se recomienda hacer esto después de recibir el primer bloque, ya que los cambios posteriores podrían causar problemas con otras implementaciones de CoAP.

Detalles
Parámetros
[in] aContext
Un puntero para el contexto específico de la aplicación.
[in,out] aBlock
Un puntero al punto en el que se puede escribir el segmento de bloque.
[in] aPosition
Es la posición en la que se obtiene el segmento de bloque.
[in,out] aBlockLength
En la entrada, es la longitud máxima del segmento de bloque en bytes.
[out] aMore
Un puntero para la marca si siguen más segmentos de bloque.
Valores que se muestran
OT_ERROR_NONE
No se produjo ningún error.
OT_ERROR_INVALID_ARGS
El bloqueo de aPosition no existe.

Código otCoap

enum otCoapCode otCoapCode

Valores de código CoAP.

Opción de otCoap

struct otCoapOption otCoapOption

Esta estructura representa una opción de CoAP.

otCoapOptionContentFormat

enum otCoapOptionContentFormat otCoapOptionContentFormat

Códigos de formato de contenido de CoAP

La lista completa está documentada en https://www.iana.org/assignments/core-parameters/core-parameters.xhtml#content-formats.

otCoapOptionIterator

struct otCoapOptionIterator otCoapOptionIterator

Esta estructura actúa como un iterador para las opciones de CoAP.

Tipo de opción de otCoapOption

enum otCoapOptionType otCoapOptionType

Números de opción de CoAP.

otCoapRequestHandler

void(* otCoapRequestHandler)(void *aContext, otMessage *aMessage, const otMessageInfo *aMessageInfo)

Se llama a este puntero de función cuando se recibe una solicitud CoAP con una ruta URI específica.

Detalles
Parámetros
[in] aContext
Un puntero para información contextual arbitraria
[in] aMessage
Un puntero al mensaje.
[in] aMessageInfo
Un puntero para la información del mensaje para aMessage.

recurso de otCoap

struct otCoapResource otCoapResource

Esta estructura representa un recurso de CoAP.

otCoapResponseHandler

void(* otCoapResponseHandler)(void *aContext, otMessage *aMessage, const otMessageInfo *aMessageInfo, otError aResult)

Se llama a este puntero de función cuando se recibe una respuesta de CoAP o cuando se agota el tiempo de espera de la solicitud.

Detalles
Parámetros
[in] aContext
Un puntero para el contexto específico de la aplicación.
[in] aMessage
Un puntero para el búfer de mensajes que contiene la respuesta. NULL si no se recibió ninguna respuesta.
[in] aMessageInfo
Un puntero para la información del mensaje para aMessage. NULL si no se recibió ninguna respuesta.
[in] aResult
Es el resultado de la transacción de CoAP.
Valores que se muestran
OT_ERROR_NONE
Se recibió correctamente una respuesta.
OT_ERROR_ABORT
Un par restableció una transacción de CoAP.
OT_ERROR_RESPONSE_TIMEOUT
No se recibió ninguna respuesta ni reconocimiento durante el tiempo de espera.

otCoapTxParameters

struct otCoapTxParameters otCoapTxParameters

Esta estructura representa los parámetros de transmisión de CoAP.

Tipo de otCoap

enum otCoapType otCoapType

Valores de tipo CoAP (número entero de 2 bits sin signo).

Functions

otCoapAddBlockWiseResource

void otCoapAddBlockWiseResource(
  otInstance *aInstance,
  otCoapBlockwiseResource *aResource
)

Esta función agrega un recurso a nivel de bloque al servidor de CoAP.

Detalles
Parámetros
[in] aInstance
Un puntero para una instancia de OpenThread.
[in] aResource
Un puntero para el recurso.

OtCoapAddResource

void otCoapAddResource(
  otInstance *aInstance,
  otCoapResource *aResource
)

Esta función agrega un recurso al servidor de CoAP.

Detalles
Parámetros
[in] aInstance
Un puntero para una instancia de OpenThread.
[in] aResource
Un puntero para el recurso.

otCoapBlockSizeFromExponent

uint16_t otCoapBlockSizeFromExponent(
  otCoapBlockSzx aSize
)

Esta función convierte un campo SZX de opción de bloqueo de CoAP en el tamaño real del bloque.

Detalles
Parámetros
[in] aSize
Exponente de tamaño de bloque.
Qué muestra
El valor real del exponente de tamaño.

otCoapMessageAttachBlock1Option

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

Esta función agrega una opción Block1.

Detalles
Parámetros
[in,out] aMessage
Un puntero al mensaje de CoAP.
[in] aNum
Número de bloqueo actual.
[in] aMore
Es un valor booleano que indica que se deben enviar más bloques.
[in] aSize
Exponente de tamaño de bloque.
Valores que se muestran
OT_ERROR_NONE
Se agregó correctamente la opción.
OT_ERROR_INVALID_ARGS
El tipo de opción no es igual o mayor que el último tipo de opción.
OT_ERROR_NO_BUFS
La longitud de la opción supera el tamaño del búfer.

otCoapMessageAttachBlock2Option

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

Esta función agrega una opción Block2.

Detalles
Parámetros
[in,out] aMessage
Un puntero al mensaje de CoAP.
[in] aNum
Número de bloqueo actual.
[in] aMore
Es un valor booleano que indica que se deben enviar más bloques.
[in] aSize
Exponente de tamaño de bloque.
Valores que se muestran
OT_ERROR_NONE
Se agregó correctamente la opción.
OT_ERROR_INVALID_ARGS
El tipo de opción no es igual o mayor que el último tipo de opción.
OT_ERROR_NO_BUFS
La longitud de la opción supera el tamaño del búfer.

otCoapMessageAttachContentFormatOption

otError otCoapMessageAppendContentFormatOption(
  otMessage *aMessage,
  otCoapOptionContentFormat aContentFormat
)

Esta función agrega la opción de CoAP del formato de contenido como se especifica en https://tools.ietf.org/html/rfc7252#page-92.

Se debe llamar a este método antes de configurar otCoapMessageSetPayloadMarker si se incluye una carga útil en el mensaje.

La función es un wrapper práctico alrededor de otCoapMessageAdjuntarUintOption y, si el código de tipo de formato deseado no se encuentra en otCoapOptionContentFormat, se debe usar esta función base.

Detalles
Parámetros
[in,out] aMessage
Un puntero al mensaje de CoAP.
[in] aContentFormat
Uno de los formatos de contenido que se indican en otCoapOptionContentFormat anteriormente.
Valores que se muestran
OT_ERROR_NONE
Se agregó correctamente la opción.
OT_ERROR_INVALID_ARGS
El tipo de opción no es igual o mayor que el último tipo de opción.
OT_ERROR_NO_BUFS
La longitud de la opción supera el tamaño del búfer.

otCoapMessageAttachMaxAgeOption

otError otCoapMessageAppendMaxAgeOption(
  otMessage *aMessage,
  uint32_t aMaxAge
)

Esta función agrega una opción de edad máxima.

Detalles
Parámetros
[in,out] aMessage
Un puntero al mensaje de CoAP.
[in] aMaxAge
Es el valor de max-age.
Valores que se muestran
OT_ERROR_NONE
Se agregó correctamente la opción.
OT_ERROR_INVALID_ARGS
El tipo de opción no es igual o mayor que el último tipo de opción.
OT_ERROR_NO_BUFS
La longitud de la opción supera el tamaño del búfer.

otCoapMessageAdjuntarObserveOption

otError otCoapMessageAppendObserveOption(
  otMessage *aMessage,
  uint32_t aObserve
)

Esta función agrega una opción Observe.

Detalles
Parámetros
[in,out] aMessage
Un puntero al mensaje de CoAP.
[in] aObserve
Observe el valor del campo.
Valores que se muestran
OT_ERROR_NONE
Se agregó correctamente la opción.
OT_ERROR_INVALID_ARGS
El tipo de opción no es igual o mayor que el último tipo de opción.
OT_ERROR_NO_BUFS
La longitud de la opción supera el tamaño del búfer.

otCoapMessageAdjuntarOpción

otError otCoapMessageAppendOption(
  otMessage *aMessage,
  uint16_t aNumber,
  uint16_t aLength,
  const void *aValue
)

Esta función agrega una opción de CoAP en un encabezado.

Detalles
Parámetros
[in,out] aMessage
Un puntero al mensaje de CoAP.
[in] aNumber
Es el número de opción de CoAP.
[in] aLength
Longitud de la opción CoAP.
[in] aValue
Un puntero para el valor de CoAP.
Valores que se muestran
OT_ERROR_NONE
Se agregó correctamente la opción.
OT_ERROR_INVALID_ARGS
El tipo de opción no es igual o mayor que el último tipo de opción.
OT_ERROR_NO_BUFS
La longitud de la opción supera el tamaño del búfer.

otCoapMessageAttachProxyUriOption

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

Esta función agrega una opción Proxy-Uri.

Detalles
Parámetros
[in,out] aMessage
Un puntero al mensaje de CoAP.
[in] aUriPath
Un puntero para una string terminada en NULL.
Valores que se muestran
OT_ERROR_NONE
Se agregó correctamente la opción.
OT_ERROR_INVALID_ARGS
El tipo de opción no es igual o mayor que el último tipo de opción.
OT_ERROR_NO_BUFS
La longitud de la opción supera el tamaño del búfer.

otCoapMessageAdjuntarUintOption

otError otCoapMessageAppendUintOption(
  otMessage *aMessage,
  uint16_t aNumber,
  uint32_t aValue
)

Esta función agrega una opción de CoAP de número entero sin firma como se especifica en https://tools.ietf.org/html/rfc7252#section-3.2.

Detalles
Parámetros
[in,out] aMessage
Un puntero al mensaje de CoAP.
[in] aNumber
Es el número de opción de CoAP.
[in] aValue
El valor de número entero sin firma de la opción CoAP.
Valores que se muestran
OT_ERROR_NONE
Se agregó correctamente la opción.
OT_ERROR_INVALID_ARGS
El tipo de opción no es igual o mayor que el último tipo de opción.
OT_ERROR_NO_BUFS
La longitud de la opción supera el tamaño del búfer.
Consulta también:
otCoapMessageGetOptionUintValue

otCoapMessageAdjuntarUriPathOptions

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

Esta función agrega una opción Uri-Path.

Detalles
Parámetros
[in,out] aMessage
Un puntero al mensaje de CoAP.
[in] aUriPath
Un puntero para una string terminada en NULL.
Valores que se muestran
OT_ERROR_NONE
Se agregó correctamente la opción.
OT_ERROR_INVALID_ARGS
El tipo de opción no es igual o mayor que el último tipo de opción.
OT_ERROR_NO_BUFS
La longitud de la opción supera el tamaño del búfer.

otCoapMessageAdjuntarUriQueryOption

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

Esta función agrega una sola opción de URI.

Detalles
Parámetros
[in,out] aMessage
Un puntero al mensaje de CoAP.
[in] aUriQuery
Un puntero para una string terminada en NULL, que debe contener un solo par clave-valor.
Valores que se muestran
OT_ERROR_NONE
Se agregó correctamente la opción.
OT_ERROR_INVALID_ARGS
El tipo de opción no es igual o mayor que el último tipo de opción.
OT_ERROR_NO_BUFS
La longitud de la opción supera el tamaño del búfer.

otCoapMessageCodeToString

const char * otCoapMessageCodeToString(
  const otMessage *aMessage
)

Este método muestra el código CoAP como una string legible.

@ muestra el código CoAP como una string.

Detalles
Parámetros
[in] aMessage
Un puntero al mensaje de CoAP.

otCoapMessageGenerateToken

void otCoapMessageGenerateToken(
  otMessage *aMessage,
  uint8_t aTokenLength
)

Esta función establece la longitud del token y aleatoriza su valor.

Detalles
Parámetros
[in,out] aMessage
Un puntero al mensaje de CoAP.
[in] aTokenLength
La longitud de un token que se debe configurar.

otCoapMessageGetCode

otCoapCode otCoapMessageGetCode(
  const otMessage *aMessage
)

Esta función muestra el valor del código.

Detalles
Parámetros
[in] aMessage
Un puntero al mensaje de CoAP.
Qué muestra
Es el valor de Code.

otCoapMessageGetMessageId

uint16_t otCoapMessageGetMessageId(
  const otMessage *aMessage
)

Esta función muestra el valor del ID de mensaje.

Detalles
Parámetros
[in] aMessage
Un puntero al mensaje de CoAP.
Qué muestra
Es el valor de ID de mensaje.

oCoCopMessageGetToken

const uint8_t * otCoapMessageGetToken(
  const otMessage *aMessage
)

Esta función muestra un puntero para el valor del token.

Detalles
Parámetros
[in] aMessage
Un puntero al mensaje de CoAP.
Qué muestra
Un puntero para el valor del token.

otCoapMessageGetTokenLength

uint8_t otCoapMessageGetTokenLength(
  const otMessage *aMessage
)

Esta función muestra la longitud del token.

Detalles
Parámetros
[in] aMessage
Un puntero al mensaje de CoAP.
Qué muestra
La longitud del token

OtCoapMessageGetType

otCoapType otCoapMessageGetType(
  const otMessage *aMessage
)

Esta función muestra el valor Type.

Detalles
Parámetros
[in] aMessage
Un puntero al mensaje de CoAP.
Qué muestra
Es el valor de tipo.

otCoapMessageInit

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

Esta función inicializa el encabezado de CoAP.

Detalles
Parámetros
[in,out] aMessage
Un puntero al mensaje de CoAP para inicializar.
[in] aType
Tipo de mensaje CoAP.
[in] aCode
Código de mensaje CoAP.

otCoapMessageInitResponse

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

Esta función inicializa un mensaje de respuesta.

Detalles
Parámetros
[in,out] aResponse
Un puntero para el mensaje de respuesta de CoAP.
[in] aRequest
Un puntero al mensaje de solicitud de CoAP.
[in] aType
Tipo de mensaje CoAP.
[in] aCode
Código de mensaje CoAP.
Valores que se muestran
OT_ERROR_NONE
Se inicializó correctamente el mensaje de respuesta.
OT_ERROR_NO_BUFS
No hay suficientes búferes de mensajes disponibles para inicializar el mensaje de respuesta.

otCoapMessageSetCode

void otCoapMessageSetCode(
  otMessage *aMessage,
  otCoapCode aCode
)

Esta función establece el valor del código.

Detalles
Parámetros
[in,out] aMessage
Un puntero al mensaje de CoAP para inicializar.
[in] aCode
Código de mensaje CoAP.

otCoapMessageSetPayloadMarker

otError otCoapMessageSetPayloadMarker(
  otMessage *aMessage
)

Esta función agrega un marcador de carga útil que indica el comienzo de la carga útil en el encabezado de CoAP.

Detalles
Parámetros
[in,out] aMessage
Un puntero al mensaje de CoAP.
Valores que se muestran
OT_ERROR_NONE
El marcador de carga útil se agregó correctamente.
OT_ERROR_NO_BUFS
El marcador de la carga útil del encabezado supera el tamaño del búfer.

otCoapMessageSetToken

otError otCoapMessageSetToken(
  otMessage *aMessage,
  const uint8_t *aToken,
  uint8_t aTokenLength
)

Esta función establece el valor del token y su longitud en un encabezado.

Detalles
Parámetros
[in,out] aMessage
Un puntero al mensaje de CoAP.
[in] aToken
Un puntero para el valor del token.
[in] aTokenLength
La longitud de aToken
Valores que se muestran
OT_ERROR_NONE
Se configuró correctamente el valor del token.
OT_ERROR_NO_BUFS
No hay búferes suficientes para establecer el valor del token.

otCoapNewMessage

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

Esta función crea un mensaje de CoAP nuevo.

Detalles
Parámetros
[in] aInstance
Un puntero para una instancia de OpenThread.
[in] aSettings
Un puntero para la configuración del mensaje o NULL para establecer la configuración predeterminada.
Qué muestra
Un puntero al búfer de mensajes o NULL si no hay búferes de mensaje disponibles o los parámetros no son válidos.

otCoapOptionIteratorGetFirstOption

const otCoapOption * otCoapOptionIteratorGetFirstOption(
  otCoapOptionIterator *aIterator
)

Esta función muestra un puntero a la primera opción.

Detalles
Parámetros
[in,out] aIterator
Un puntero al iterador de opciones de mensajes de CoAP.
Qué muestra
Un puntero para la primera opción. Si no hay ninguna opción presente, se muestra un puntero NULL.

otCoapOptionIteratorGetFirstOptionMatching

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

Esta función muestra un puntero para la primera opción que coincide con el número de opción especificado.

Detalles
Parámetros
[in] aIterator
Un puntero al iterador de opciones de mensajes de CoAP.
[in] aOption
Se busca el número de opción.
Qué muestra
Un puntero para la primera opción coincidente. Si no hay ninguna opción de coincidencia presente, se muestra un puntero NULL.

otCoapOptionIteratorGetNextOption

const otCoapOption * otCoapOptionIteratorGetNextOption(
  otCoapOptionIterator *aIterator
)

Esta función muestra un puntero para la siguiente opción.

Detalles
Parámetros
[in,out] aIterator
Un puntero al iterador de opciones de mensajes de CoAP.
Qué muestra
Un puntero para la siguiente opción. Si no hay más opciones, se muestra un puntero NULL.

otCoapOptionIteratorGetNextOptionMatching

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

Esta función muestra un puntero para la siguiente opción que coincide con el número de opción especificado.

Detalles
Parámetros
[in] aIterator
Un puntero al iterador de opciones de mensajes de CoAP.
[in] aOption
Se busca el número de opción.
Qué muestra
Un puntero para la siguiente opción de coincidencia. Si no hay más opciones de coincidencia disponibles, se muestra un puntero NULL.

otCoapOptionIteratorGetOptionUintValue

otError otCoapOptionIteratorGetOptionUintValue(
  otCoapOptionIterator *aIterator,
  uint64_t *aValue
)

Esta función completa el valor de la opción actual en aValue, suponiendo que el valor actual es un número entero sin firma codificado según https://tools.ietf.org/html/rfc7252#section-3.2.

Detalles
Parámetros
[in,out] aIterator
Un puntero al iterador de opciones de mensajes de CoAP.
[out] aValue
Un puntero para un número entero sin signo que recibe el valor de la opción.
Valores que se muestran
OT_ERROR_NONE
Se completó correctamente el valor.
OT_ERROR_NOT_FOUND
No hay ninguna opción actual.
OT_ERROR_NO_BUFS
El valor es demasiado largo para caber en un uint64_t.
Consulta también:
otCoapMessageAttachUintOption

otCoapOptionIteratorGetOptionValue

otError otCoapOptionIteratorGetOptionValue(
  otCoapOptionIterator *aIterator,
  void *aValue
)

Esta función rellena el valor de la opción actual en aValue.

Detalles
Parámetros
[in,out] aIterator
Un puntero al iterador de opciones de mensajes de CoAP.
[out] aValue
Un puntero para un búfer a fin de recibir el valor de la opción.
Valores que se muestran
OT_ERROR_NONE
Se completó correctamente el valor.
OT_ERROR_NOT_FOUND
No hay ninguna opción actual.

otCoapOptionIteratorInit

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

Esta función inicializa un iterador para las opciones del mensaje en cuestión.

Detalles
Parámetros
[in,out] aIterator
Un puntero al iterador de opciones de mensajes de CoAP.
[in] aMessage
Un puntero al mensaje de CoAP.
Valores que se muestran
OT_ERROR_NONE
Inicialización correcta
OT_ERROR_PARSE
El estado del mensaje es incoherente.

otCoapRemoveBlockWiseResource

void otCoapRemoveBlockWiseResource(
  otInstance *aInstance,
  otCoapBlockwiseResource *aResource
)

Esta función quita un recurso a nivel de bloque del servidor CoAP.

Detalles
Parámetros
[in] aInstance
Un puntero para una instancia de OpenThread.
[in] aResource
Un puntero para el recurso.

otCoapRemoveResource

void otCoapRemoveResource(
  otInstance *aInstance,
  otCoapResource *aResource
)

Esta función quita un recurso del servidor de CoAP.

Detalles
Parámetros
[in] aInstance
Un puntero para una instancia de OpenThread.
[in] aResource
Un puntero para el recurso.

otCoapSendRequest

otError otCoapSendRequest(
  otInstance *aInstance,
  otMessage *aMessage,
  const otMessageInfo *aMessageInfo,
  otCoapResponseHandler aHandler,
  void *aContext
)

Esta función envía una solicitud de CoAP.

Si se espera una respuesta para una solicitud, se debe proporcionar la información respectiva de la función y el contexto. Si no se espera ninguna respuesta, estos argumentos deben ser punteros NULL.

Detalles
Parámetros
[in] aInstance
Un puntero para una instancia de OpenThread.
[in] aMessage
Un puntero al mensaje que se enviará.
[in] aMessageInfo
Un puntero para la información del mensaje asociada con aMessage.
[in] aHandler
Un puntero de función al que se debe llamar en la recepción o el tiempo de espera de la respuesta.
[in] aContext
Un puntero para información contextual arbitraria Puede ser NULO si no se usa.
Valores que se muestran
OT_ERROR_NONE
El mensaje CoAP se envió correctamente.
OT_ERROR_NO_BUFS
No se pudieron asignar los datos de retransmisión.

otCoapSendRequestBlockWise

otError otCoapSendRequestBlockWise(
  otInstance *aInstance,
  otMessage *aMessage,
  const otMessageInfo *aMessageInfo,
  otCoapResponseHandler aHandler,
  void *aContext,
  otCoapBlockwiseTransmitHook aTransmitHook,
  otCoapBlockwiseReceiveHook aReceiveHook
)

Esta función envía una solicitud CoAP en bloque.

Esta función está disponible cuando se habilita la configuración OPENThread_CONFIG_COAP_BLOCKWISE_TRANSFER_ENABLE.

Si se espera una respuesta para una solicitud, se debe proporcionar la información respectiva de la función y el contexto. Si se espera que la respuesta sea de bloque, se debe proporcionar una función de hook respectiva. Si no se espera ninguna respuesta, estos argumentos deben ser punteros NULL.

Detalles
Parámetros
[in] aInstance
Un puntero para una instancia de OpenThread.
[in] aMessage
Un puntero al mensaje que se enviará.
[in] aMessageInfo
Un puntero para la información del mensaje asociada con aMessage.
[in] aHandler
Un puntero de función al que se debe llamar en la recepción o el tiempo de espera de la respuesta.
[in] aContext
Un puntero para información contextual arbitraria Puede ser NULO si no se usa.
[in] aTransmitHook
Un puntero para una función de hook para realizar transferencias a nivel de bloques.
[in] aReceiveHook
Un puntero para una función de hook para una transferencia entrante a nivel de bloque.
Valores que se muestran
OT_ERROR_NONE
El mensaje CoAP se envió correctamente.
OT_ERROR_NO_BUFS
No se pudieron asignar los datos de retransmisión.

otCoapSendRequestBlockWiseWithParameters

otError otCoapSendRequestBlockWiseWithParameters(
  otInstance *aInstance,
  otMessage *aMessage,
  const otMessageInfo *aMessageInfo,
  otCoapResponseHandler aHandler,
  void *aContext,
  const otCoapTxParameters *aTxParameters,
  otCoapBlockwiseTransmitHook aTransmitHook,
  otCoapBlockwiseReceiveHook aReceiveHook
)

Esta función envía una solicitud CoAP en bloque con parámetros de transmisión personalizados.

Esta función está disponible cuando se habilita la configuración OPENThread_CONFIG_COAP_BLOCKWISE_TRANSFER_ENABLE.

Si se espera una respuesta para una solicitud, se debe proporcionar la información respectiva de la función y el contexto. Si se espera que la respuesta sea de bloque, se debe proporcionar una función de hook respectiva. Si no se espera ninguna respuesta, estos argumentos deben ser punteros NULL.

Detalles
Parámetros
[in] aInstance
Un puntero para una instancia de OpenThread.
[in] aMessage
Un puntero al mensaje que se enviará.
[in] aMessageInfo
Un puntero para la información del mensaje asociada con aMessage.
[in] aHandler
Un puntero de función al que se debe llamar en la recepción o el tiempo de espera de la respuesta.
[in] aContext
Un puntero para información contextual arbitraria Puede ser NULO si no se usa.
[in] aTxParameters
Un puntero para los parámetros de transmisión de esta solicitud. Usa NULL para los valores predeterminados.
[in] aTransmitHook
Un puntero para una función de hook para realizar transferencias a nivel de bloques.
[in] aReceiveHook
Un puntero para una función de hook para una transferencia entrante a nivel de bloque.
Valores que se muestran
OT_ERROR_NONE
El mensaje CoAP se envió correctamente.
OT_ERROR_NO_BUFS
No se pudieron asignar los datos de retransmisión.

otCoapSendRequestWithParameters

otError otCoapSendRequestWithParameters(
  otInstance *aInstance,
  otMessage *aMessage,
  const otMessageInfo *aMessageInfo,
  otCoapResponseHandler aHandler,
  void *aContext,
  const otCoapTxParameters *aTxParameters
)

Esta función envía una solicitud de CoAP con parámetros de transmisión personalizados.

Si se espera una respuesta para una solicitud, se debe proporcionar la información respectiva de la función y el contexto. Si no se espera ninguna respuesta, estos argumentos deben ser punteros NULL.

Detalles
Parámetros
[in] aInstance
Un puntero para una instancia de OpenThread.
[in] aMessage
Un puntero al mensaje que se enviará.
[in] aMessageInfo
Un puntero para la información del mensaje asociada con aMessage.
[in] aHandler
Un puntero de función al que se debe llamar en la recepción o el tiempo de espera de la respuesta.
[in] aContext
Un puntero para información contextual arbitraria Puede ser NULO si no se usa.
[in] aTxParameters
Un puntero para los parámetros de transmisión de esta solicitud. Usa NULL para los valores predeterminados. De lo contrario, los parámetros proporcionados deben cumplir con las siguientes condiciones:
  1. mMaxRetransmit no es mayor que OT_COAP_MAX_RETRANSMIT.
  2. mAckRandomFactorNumerator / mAckRandomFactorDenominator no debe ser inferior a 1.0.
  3. El ciclo de vida del intercambio calculado no debe sobrepasar el valor uint32_t.
Valores que se muestran
OT_ERROR_INVALID_ARGS
aTxParameters no es válido.
OT_ERROR_NONE
El mensaje CoAP se envió correctamente.
OT_ERROR_NO_BUFS
No se pudieron asignar los datos de retransmisión.

otCoapSendResponse

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

Esta función envía una respuesta CoAP desde el servidor.

Detalles
Parámetros
[in] aInstance
Un puntero para una instancia de OpenThread.
[in] aMessage
Un puntero para la respuesta de CoAP para enviar.
[in] aMessageInfo
Un puntero para la información del mensaje asociada con aMessage.
Valores que se muestran
OT_ERROR_NONE
El mensaje de respuesta de CoAP se puso en cola correctamente.
OT_ERROR_NO_BUFS
No hay búferes suficientes para enviar la respuesta de CoAP.

otCoapSendResponseBlockWise

otError otCoapSendResponseBlockWise(
  otInstance *aInstance,
  otMessage *aMessage,
  const otMessageInfo *aMessageInfo,
  void *aContext,
  otCoapBlockwiseTransmitHook aTransmitHook
)

Esta función envía una respuesta de CoAP a nivel de bloque desde el servidor.

Esta función está disponible cuando se habilita la configuración OPENThread_CONFIG_COAP_BLOCKWISE_TRANSFER_ENABLE.

Detalles
Parámetros
[in] aInstance
Un puntero para una instancia de OpenThread.
[in] aMessage
Un puntero para la respuesta de CoAP para enviar.
[in] aMessageInfo
Un puntero para la información del mensaje asociada con aMessage.
[in] aContext
Un puntero para información contextual arbitraria Puede ser NULO si no se usa.
[in] aTransmitHook
Un puntero para una función de hook para realizar transferencias a nivel de bloques.
Valores que se muestran
OT_ERROR_NONE
El mensaje de respuesta de CoAP se puso en cola correctamente.
OT_ERROR_NO_BUFS
No hay búferes suficientes para enviar la respuesta de CoAP.

otCoapSendResponseBlockWiseWithParameters

otError otCoapSendResponseBlockWiseWithParameters(
  otInstance *aInstance,
  otMessage *aMessage,
  const otMessageInfo *aMessageInfo,
  const otCoapTxParameters *aTxParameters,
  void *aContext,
  otCoapBlockwiseTransmitHook aTransmitHook
)

Esta función envía una respuesta de CoAP a nivel de bloque desde el servidor con parámetros de transmisión personalizados.

Esta función está disponible cuando se habilita la configuración OPENThread_CONFIG_COAP_BLOCKWISE_TRANSFER_ENABLE.

Detalles
Parámetros
[in] aInstance
Un puntero para una instancia de OpenThread.
[in] aMessage
Un puntero para la respuesta de CoAP para enviar.
[in] aMessageInfo
Un puntero para la información del mensaje asociada con aMessage.
[in] aTxParameters
Un puntero para los parámetros de transmisión de esta respuesta. Usa NULL para los valores predeterminados.
[in] aContext
Un puntero para información contextual arbitraria Puede ser NULO si no se usa.
[in] aTransmitHook
Un puntero para una función de hook para realizar transferencias a nivel de bloques.
Valores que se muestran
OT_ERROR_NONE
El mensaje de respuesta de CoAP se puso en cola correctamente.
OT_ERROR_NO_BUFS
No hay búferes suficientes para enviar la respuesta de CoAP.

otCoapSendResponseWithParameters

otError otCoapSendResponseWithParameters(
  otInstance *aInstance,
  otMessage *aMessage,
  const otMessageInfo *aMessageInfo,
  const otCoapTxParameters *aTxParameters
)

Esta función envía una respuesta de CoAP desde el servidor con parámetros de transmisión personalizados.

Detalles
Parámetros
[in] aInstance
Un puntero para una instancia de OpenThread.
[in] aMessage
Un puntero para la respuesta de CoAP para enviar.
[in] aMessageInfo
Un puntero para la información del mensaje asociada con aMessage.
[in] aTxParameters
Un puntero para los parámetros de transmisión de esta respuesta. Usa NULL para los valores predeterminados.
Valores que se muestran
OT_ERROR_NONE
El mensaje de respuesta de CoAP se puso en cola correctamente.
OT_ERROR_NO_BUFS
No hay búferes suficientes para enviar la respuesta de CoAP.

otCoapSetDefaultHandler

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

Esta función establece el controlador predeterminado para las solicitudes de CoAP no controladas.

Detalles
Parámetros
[in] aInstance
Un puntero para una instancia de OpenThread.
[in] aHandler
Un puntero de función que se llamará cuando llegue una solicitud no controlada.
[in] aContext
Un puntero para información contextual arbitraria Puede ser NULO si no se usa.

oCoCopStart

otError otCoapStart(
  otInstance *aInstance,
  uint16_t aPort
)

Esta función inicia el servidor de CoAP.

Detalles
Parámetros
[in] aInstance
Un puntero para una instancia de OpenThread.
[in] aPort
El puerto UDP local al cual vincular.
Valores que se muestran
OT_ERROR_NONE
Se inició correctamente el servidor de CoAP.
OT_ERROR_FAILED
No se pudo iniciar el servidor de CoAP.

otCoapStop

otError otCoapStop(
  otInstance *aInstance
)

Esta función detiene el servidor CoAP.

Detalles
Parámetros
[in] aInstance
Un puntero para una instancia de OpenThread.
Valores que se muestran
OT_ERROR_NONE
Se detuvo correctamente el servidor de CoAP.

Macros

OT_COAP_CÓDIGO

 OT_COAP_CODE ((((c)&0x7) << 5) | ((d)&0x1f))

Macro de ayuda para definir los valores del código CoAP.

TS_COAP_DEFAULT_TOKEN_LENGTH

 OT_COAP_DEFAULT_TOKEN_LENGTH 2

Longitud predeterminada del token.

OT_COAP_MAX_RETRANSMIT

 OT_COAP_MAX_RETRANSMIT 20

La cantidad máxima de retransmisión admite OpenThread.

TS_COAP_MAX_TOKEN_LENGTH

 OT_COAP_MAX_TOKEN_LENGTH 8

Longitud máxima del token según se especifica (RFC 7252).

TS_COAP_MIN_ACK_TIMEOUT

 OT_COAP_MIN_ACK_TIMEOUT 1000

Tiempo de espera de ACK mínimo en milisegundos compatible con OpenThread.

TC_DEFAULT_COAP_PORT

 OT_DEFAULT_COAP_PORT 5683

Puerto CoAP predeterminado, como se especifica en RFC 7252

Recursos

Los temas de referencia de la API de OpenThread se originan en el código fuente, disponible en GitHub. Para obtener más información o colaborar con nuestra documentación, consulta Recursos.