Se usó la API de Cloud Translation para traducir esta página.

CoAP

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

Resumen

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

Enumeraciones
`otCoapBlockSzx`	enumeración 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)) }	enumeración Valores del 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 }	enumeración 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 }	enumeración 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 }`	enumeración Valores de tipo CoAP (entero sin signo de 2 bits).

Typedefs
`otCoapBlockSzx`	typedef `enum otCoapBlockSzx` 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 `otError (*` Este puntero de función se llama cuando se recibe un mensaje CoAP con una opción de transferencia por bloques.
`otCoapBlockwiseResource`	typedef `struct otCoapBlockwiseResource` Esta estructura representa un recurso CoAP con transferencia por bloques.
`otCoapBlockwiseTransmitHook )(void aContext, uint8_t aBlock, uint32_t aPosition, uint16_t aBlockLength, bool aMore)`	typedef `otError (*` Este puntero de función se llama antes de que se envíe el siguiente bloque en una transferencia por bloques.
`otCoapCode`	typedef `enum otCoapCode` Valores del código CoAP.
`otCoapOption`	typedef `struct otCoapOption` Esta estructura representa una opción de CoAP.
`otCoapOptionContentFormat`	typedef `enum otCoapOptionContentFormat` Códigos de formato de contenido de CoAP.
`otCoapOptionIterator`	typedef `struct otCoapOptionIterator` Esta estructura actúa como un iterador para las opciones de CoAP.
`otCoapOptionType`	typedef `enum otCoapOptionType` Números de opción de CoAP.
`otCoapRequestHandler )(void aContext, otMessage aMessage, const otMessageInfo *aMessageInfo)`	typedef `void(*` Este puntero de función se llama cuando se recibe una solicitud de CoAP con un Uri-Path determinado.
`otCoapResource`	typedef `struct otCoapResource` Esta estructura representa un recurso CoAP.
`otCoapResponseHandler )(void aContext, otMessage aMessage, const otMessageInfo *aMessageInfo, otError aResult)`	typedef `void(*` Este puntero de función se llama cuando se recibe una respuesta de CoAP o cuando se agota el tiempo de espera de la solicitud.
`otCoapTxParameters`	typedef `struct otCoapTxParameters` Esta estructura representa los parámetros de transmisión de CoAP.
`otCoapType`	typedef `enum otCoapType` Valores de tipo CoAP (entero sin signo de 2 bits).

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

Estructuras
otCoapBlockwiseResource	Esta estructura representa un recurso CoAP con transferencia por bloques.
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.

otCoapCode

 otCoapCode

Valores del código CoAP.

Propiedades
`OT_COAP_CODE_BAD_GATEWAY`	Puerta de enlace incorrecta.
`OT_COAP_CODE_BAD_OPTION`	Mala opción.
`OT_COAP_CODE_BAD_REQUEST`	Solicitud incorrecta.
`OT_COAP_CODE_CHANGED`	Cambió.
`OT_COAP_CODE_CONTENT`	Contenido.
`OT_COAP_CODE_CONTINUE`	RFC7959 Continuar.
`OT_COAP_CODE_CREATED`	Creado.
`OT_COAP_CODE_DELETE`	Borrar.
`OT_COAP_CODE_DELETED`	Eliminado.
`OT_COAP_CODE_EMPTY`	Código de mensaje vacío.
`OT_COAP_CODE_FORBIDDEN`	Prohibido.
`OT_COAP_CODE_GATEWAY_TIMEOUT`	Tiempo de espera de puerta de enlace.
`OT_COAP_CODE_GET`	Obtener.
`OT_COAP_CODE_INTERNAL_ERROR`	Error de servidor interno.
`OT_COAP_CODE_METHOD_NOT_ALLOWED`	Método no permitido.
`OT_COAP_CODE_NOT_ACCEPTABLE`	Inaceptable.
`OT_COAP_CODE_NOT_FOUND`	Extraviado.
`OT_COAP_CODE_NOT_IMPLEMENTED`	No se ha implementado.
`OT_COAP_CODE_POST`	Correo.
`OT_COAP_CODE_PRECONDITION_FAILED`	Condición previa Falló.
`OT_COAP_CODE_PROXY_NOT_SUPPORTED`	No se admite el uso de proxy.
`OT_COAP_CODE_PUT`	Poner.
`OT_COAP_CODE_REQUEST_INCOMPLETE`	RFC7959 Solicitud de entidad incompleta.
`OT_COAP_CODE_REQUEST_TOO_LARGE`	Solicitar entidad 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`	Formato de contenido no admitido.
`OT_COAP_CODE_VALID`	Válido.

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

Propiedades
`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`	application / cose; cose-type = "cose-encrypt": [RFC8152]
`OT_COAP_OPTION_CONTENT_FORMAT_COSE_ENCRYPT0`	application / cose; cose-type = "cose-encrypt0": [RFC8152]
`OT_COAP_OPTION_CONTENT_FORMAT_COSE_KEY`	application / cose-key: [RFC8152]
`OT_COAP_OPTION_CONTENT_FORMAT_COSE_KEY_SET`	application / cose-key-set: [RFC8152]
`OT_COAP_OPTION_CONTENT_FORMAT_COSE_MAC`	application / cose; cose-type = "cose-mac": [RFC8152]
`OT_COAP_OPTION_CONTENT_FORMAT_COSE_MAC0`	application / cose; cose-type = "cose-mac0": [RFC8152]
`OT_COAP_OPTION_CONTENT_FORMAT_COSE_SIGN`	application / cose; cose-type = "cose-sign": [RFC8152]
`OT_COAP_OPTION_CONTENT_FORMAT_COSE_SIGN1`	application / cose; cose-type = "cose-sign1": [RFC8152]
`OT_COAP_OPTION_CONTENT_FORMAT_CWT`	aplicación / cwt: [RFC8392]
`OT_COAP_OPTION_CONTENT_FORMAT_EXI`	application / exi: ["Efficient XML Interchange (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`	aplicación / json-patch + json: [RFC6902]
`OT_COAP_OPTION_CONTENT_FORMAT_LINK_FORMAT`	aplicación / formato de enlace: [RFC6690]
`OT_COAP_OPTION_CONTENT_FORMAT_MERGE_PATCH_JSON`	application / merge-patch + json: [RFC7396]
`OT_COAP_OPTION_CONTENT_FORMAT_OCTET_STREAM`	aplicación / secuencia de octetos: [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`	aplicación / senml + json: [RFC8428]
`OT_COAP_OPTION_CONTENT_FORMAT_SENML_XML`	aplicación / 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`	aplicación / 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]

otCoapOptionType

 otCoapOptionType

Números de opción de CoAP.

Propiedades
`OT_COAP_OPTION_ACCEPT`	Aceptar.
`OT_COAP_OPTION_BLOCK1`	Bloque1 (RFC7959)
`OT_COAP_OPTION_BLOCK2`	Bloque 2 (RFC7959)
`OT_COAP_OPTION_CONTENT_FORMAT`	Formato de 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áxima.
`OT_COAP_OPTION_OBSERVE`	Observe [RFC7641].
`OT_COAP_OPTION_PROXY_SCHEME`	Proxy-Scheme.
`OT_COAP_OPTION_PROXY_URI`	Proxy-Uri.
`OT_COAP_OPTION_SIZE1`	Tamaño 1.
`OT_COAP_OPTION_SIZE2`	Tamaño2 (RFC7959)
`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 de tipo CoAP (entero sin signo de 2 bits).

Propiedades
`OT_COAP_TYPE_ACKNOWLEDGMENT`	Reconocimiento.
`OT_COAP_TYPE_CONFIRMABLE`	Confirmable.
`OT_COAP_TYPE_NON_CONFIRMABLE`	No confirmable.
`OT_COAP_TYPE_RESET`	Reiniciar.

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)

Este puntero de función se llama cuando se recibe un mensaje CoAP con una opción de transferencia por bloques.

Esta función está disponible cuando la configuración OPENTHREAD_CONFIG_COAP_BLOCKWISE_TRANSFER_ENABLE está habilitada.

Detalles

Parámetros

`[in] aContext`	Un puntero al contexto específico de la aplicación.
`[in] aBlock`	Un puntero al segmento de bloque.
`[in] aPosition`	La posición de `aBlock` en una secuencia en bytes.
`[in] aBlockLength`	La longitud del segmento de bloque en bytes.
`[in] aMore`	Marcar si le 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 devueltos

`OT_ERROR_NONE`	El segmento de bloque se almacenó correctamente.
`OT_ERROR_NO_BUFS`	No más memoria para almacenar bloques.
`OT_ERROR_NO_FRAME_RECEIVED`	Falta un segmento de bloque.

otCoapBlockwiseResource

struct otCoapBlockwiseResource otCoapBlockwiseResource

Esta estructura representa un recurso CoAP con transferencia por bloques.

otCoapBlockwiseTransmitHook

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

Este puntero de función se llama antes de que se envíe el siguiente bloque en una transferencia por bloques.

Esta función está disponible cuando la configuración OPENTHREAD_CONFIG_COAP_BLOCKWISE_TRANSFER_ENABLE está habilitada.

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

Detalles

Parámetros

`[in] aContext`	Un puntero al contexto específico de la aplicación.
`[in,out] aBlock`	Un puntero al lugar donde se puede escribir el segmento de bloque.
`[in] aPosition`	La posición en una secuencia de la que se obtiene el segmento de bloque.
`[in,out] aBlockLength`	En la entrada, la longitud máxima del segmento de bloque en bytes.
`[out] aMore`	Un puntero a la bandera si seguirán más segmentos de bloque.

Valores devueltos

`OT_ERROR_NONE`	No ocurrió ningún error.
`OT_ERROR_INVALID_ARGS`	Block at `aPosition` no existe.

otCoapCode

enum otCoapCode otCoapCode

Valores del código CoAP.

otCoapOption

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.

otCoapOptionType

enum otCoapOptionType otCoapOptionType

Números de opción de CoAP.

otCoapRequestHandler

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

Este puntero de función se llama cuando se recibe una solicitud de CoAP con un Uri-Path determinado.

Detalles

Parámetros

`[in] aContext`	Un puntero a información de contexto arbitraria.
`[in] aMessage`	Un puntero al mensaje.
`[in] aMessageInfo`	Un puntero a la información del mensaje para `aMessage` .

otCoapResource

struct otCoapResource otCoapResource

Esta estructura representa un recurso de CoAP.

otCoapResponseHandler

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

Este puntero de función se llama 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 al contexto específico de la aplicación.
`[in] aMessage`	Un puntero al búfer de mensajes que contiene la respuesta. NULL si no se recibió respuesta.
`[in] aMessageInfo`	Un puntero a la información del mensaje para `aMessage` . NULL si no se recibió respuesta.
`[in] aResult`	Resultado de la transacción CoAP.

Valores devueltos

`OT_ERROR_NONE`	Se recibió una respuesta con éxito.
`OT_ERROR_ABORT`	Una transacción CoAP fue restablecida por un par.
`OT_ERROR_RESPONSE_TIMEOUT`	No se recibió respuesta o acuse de recibo durante el período de tiempo de espera.

otCoapTxParameters

struct otCoapTxParameters otCoapTxParameters

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

otCoapType

enum otCoapType otCoapType

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

Funciones

otCoapAddBlockWiseResource

void otCoapAddBlockWiseResource(
  otInstance *aInstance,
  otCoapBlockwiseResource *aResource
)

Esta función agrega un recurso por bloques al servidor CoAP.

Detalles

Parámetros

`[in] aInstance`	Un puntero a una instancia de OpenThread.
`[in] aResource`	Un puntero al recurso.

otCoapAddResource

void otCoapAddResource(
  otInstance *aInstance,
  otCoapResource *aResource
)

Esta función agrega un recurso al servidor CoAP.

Detalles

Parámetros

`[in] aInstance`	Un puntero a una instancia de OpenThread.
`[in] aResource`	Un puntero al recurso.

otCoapBlockSizeFromExponent

uint16_t otCoapBlockSizeFromExponent(
  otCoapBlockSzx aSize
)

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

Detalles

Parámetros

[in] aSize

Exponente de tamaño de bloque.

Devoluciones

El valor del exponente del tamaño real.

otCoapMessageAppendBlock1Option

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 CoAP.
`[in] aNum`	Número de bloque actual.
`[in] aMore`	Booleano para indicar que se enviarán más bloques.
`[in] aSize`	Exponente de tamaño de bloque.

Valores devueltos

`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 excede el tamaño del búfer.

otCoapMessageAppendBlock2Option

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 CoAP.
`[in] aNum`	Número de bloque actual.
`[in] aMore`	Booleano para indicar que se enviarán más bloques.
`[in] aSize`	Exponente de tamaño de bloque.

Valores devueltos

`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 excede el tamaño del búfer.

otCoapMessageAppendContentFormatOption

otError otCoapMessageAppendContentFormatOption(
  otMessage *aMessage,
  otCoapOptionContentFormat aContentFormat
)

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

Esto se debe llamar antes de configurar otCoapMessageSetPayloadMarker si se va a incluir una carga útil en el mensaje.

La función es una envoltura conveniente alrededor de otCoapMessageAppendUintOption, y si el código de tipo de formato deseado no aparece en otCoapOptionContentFormat, esta función base debe usarse en su lugar.

Detalles

Parámetros

`[in,out] aMessage`	Un puntero al mensaje CoAP.
`[in] aContentFormat`	Uno de los formatos de contenido enumerados en otCoapOptionContentFormat arriba.

Valores devueltos

`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 excede el tamaño del búfer.

otCoapMessageAppendMaxAgeOption

otError otCoapMessageAppendMaxAgeOption(
  otMessage *aMessage,
  uint32_t aMaxAge
)

Esta función agrega una opción de Max-Age.

Detalles

Parámetros

`[in,out] aMessage`	Un puntero al mensaje CoAP.
`[in] aMaxAge`	El valor de Max-Age.

Valores devueltos

`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 excede el tamaño del búfer.

otCoapMessageAppendObserveOption

otError otCoapMessageAppendObserveOption(
  otMessage *aMessage,
  uint32_t aObserve
)

Esta función agrega una opción Observar.

Detalles

Parámetros

`[in,out] aMessage`	Un puntero al mensaje CoAP.
`[in] aObserve`	Observe el valor del campo.

Valores devueltos

`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 excede el tamaño del búfer.

otCoapMessageAppendOption

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

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

Detalles

Parámetros

`[in,out] aMessage`	Un puntero al mensaje CoAP.
`[in] aNumber`	El número de la opción CoAP.
`[in] aLength`	La duración de la opción CoAP.
`[in] aValue`	Un puntero al valor de CoAP.

Valores devueltos

`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 excede el tamaño del búfer.

otCoapMessageAppendProxyUriOption

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 CoAP.
`[in] aUriPath`	Un puntero a una cadena terminada en NULL.

Valores devueltos

`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 excede el tamaño del búfer.

otCoapMessageAppendUintOption

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

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

Detalles

Parámetros

`[in,out] aMessage`	Un puntero al mensaje CoAP.
`[in] aNumber`	El número de la opción CoAP.
`[in] aValue`	El valor entero sin signo de la opción CoAP.

Valores devueltos

`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 excede el tamaño del búfer.

Ver también:
otCoapMessageGetOptionUintValue

otCoapMessageAppendUriPathOptions

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 CoAP.
`[in] aUriPath`	Un puntero a una cadena terminada en NULL.

Valores devueltos

`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 excede el tamaño del búfer.

otCoapMessageAppendUriQueryOption

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

Esta función agrega una única opción de Uri-Query.

Detalles

Parámetros

`[in,out] aMessage`	Un puntero al mensaje CoAP.
`[in] aUriQuery`	Un puntero a una cadena terminada en NULL, que debe contener un solo par clave = valor.

Valores devueltos

`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 excede el tamaño del búfer.

otCoapMessageCodeToString

const char * otCoapMessageCodeToString(
  const otMessage *aMessage
)

Este método devuelve el código CoAP como una cadena legible por humanos.

@ devuelve el código CoAP como una cadena.

Detalles

Parámetros

[in] aMessage

Un puntero al mensaje 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 CoAP.
`[in] aTokenLength`	La longitud de un token que se va a establecer.

otCoapMessageGetCode

otCoapCode otCoapMessageGetCode(
  const otMessage *aMessage
)

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

Detalles

Parámetros

[in] aMessage

Un puntero al mensaje CoAP.

Devoluciones

El valor del código.

otCoapMessageGetMessageId

uint16_t otCoapMessageGetMessageId(
  const otMessage *aMessage
)

Esta función devuelve el valor de ID de mensaje.

Detalles

Parámetros

[in] aMessage

Un puntero al mensaje CoAP.

Devoluciones

El valor de ID de mensaje.

otCoapMessageGetToken

const uint8_t * otCoapMessageGetToken(
  const otMessage *aMessage
)

Esta función devuelve un puntero al valor del Token.

Detalles

Parámetros

[in] aMessage

Un puntero al mensaje CoAP.

Devoluciones

Un puntero al valor del token.

otCoapMessageGetTokenLength

uint8_t otCoapMessageGetTokenLength(
  const otMessage *aMessage
)

Esta función devuelve la longitud del Token.

Detalles

Parámetros

[in] aMessage

Un puntero al mensaje CoAP.

Devoluciones

La longitud del Token.

otCoapMessageGetType

otCoapType otCoapMessageGetType(
  const otMessage *aMessage
)

Esta función devuelve el valor de Tipo.

Detalles

Parámetros

[in] aMessage

Un puntero al mensaje CoAP.

Devoluciones

El valor de Tipo.

otCoapMessageInit

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

Esta función inicializa el encabezado CoAP.

Detalles

Parámetros

`[in,out] aMessage`	Un puntero al mensaje 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.

Nota: Tanto el ID de mensaje como el token se configuran de acuerdo con una aRequest .

Detalles

Parámetros

`[in,out] aResponse`	Un puntero al 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 devueltos

`OT_ERROR_NONE`	Inicializó con éxito el mensaje de respuesta.
`OT_ERROR_NO_BUFS`	Buffers de mensajes insuficientes disponibles para inicializar el mensaje de respuesta.

otCoapMessageSetPayloadMarker

otError otCoapMessageSetPayloadMarker(
  otMessage *aMessage
)

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

Detalles

Parámetros

[in,out] aMessage

Un puntero al mensaje CoAP.

Valores devueltos

`OT_ERROR_NONE`	El marcador de carga útil se agregó correctamente.
`OT_ERROR_NO_BUFS`	El marcador de 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 y la longitud del Token en un encabezado.

Detalles

Parámetros

`[in,out] aMessage`	Un puntero al mensaje CoAP.
`[in] aToken`	Un puntero al valor del token.
`[in] aTokenLength`	La longitud de una `aToken` .

Valores devueltos

`OT_ERROR_NONE`	Estableció correctamente el valor del token.
`OT_ERROR_NO_BUFS`	Búferes insuficientes para establecer el valor del token.

otCoapNewMessage

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

Esta función crea un nuevo mensaje CoAP.

Nota: Si una aSettings es 'NULL', la seguridad de la capa de enlace está habilitada y la prioridad del mensaje se establece en OT_MESSAGE_PRIORITY_NORMAL de forma predeterminada.

Detalles

Parámetros

`[in] aInstance`	Un puntero a una instancia de OpenThread.
`[in] aSettings`	Un puntero a la configuración del mensaje o NULL para establecer la configuración predeterminada.

Devoluciones

Un puntero al búfer de mensajes o NULL si no hay búfer de mensajes disponibles o los parámetros no son válidos.

otCoapOptionIteratorGetFirstOption

const otCoapOption * otCoapOptionIteratorGetFirstOption(
  otCoapOptionIterator *aIterator
)

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

Detalles

Parámetros

[in,out] aIterator

Un puntero al iterador de opciones de mensajes CoAP.

Devoluciones

Un puntero a la primera opción. Si no hay ninguna opción presente, se devuelve un puntero NULL.

otCoapOptionIteratorGetFirstOptionMatching

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

Esta función devuelve un puntero a 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 CoAP.
`[in] aOption`	El número de opción buscado.

Devoluciones

Un puntero a la primera opción de coincidencia. Si no hay una opción coincidente, se devuelve un puntero NULL.

otCoapOptionIteratorGetNextOption

const otCoapOption * otCoapOptionIteratorGetNextOption(
  otCoapOptionIterator *aIterator
)

Esta función devuelve un puntero a la siguiente opción.

Detalles

Parámetros

[in,out] aIterator

Un puntero al iterador de opciones de mensajes CoAP.

Devoluciones

Un puntero a la siguiente opción. Si no hay más opciones presentes, se devuelve el puntero NULL.

otCoapOptionIteratorGetNextOptionMatching

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

Esta función devuelve un puntero a 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 CoAP.
`[in] aOption`	El número de opción buscado.

Devoluciones

Un puntero a la siguiente opción de coincidencia. Si no hay más opciones de coincidencia, se devuelve un puntero NULL.

otCoapOptionIteratorGetOptionUintValue

otError otCoapOptionIteratorGetOptionUintValue(
  otCoapOptionIterator *aIterator,
  uint64_t *aValue
)

Esta función completa el valor de la opción actual en aValue asumiendo que el valor actual es un entero sin signo codificado de acuerdo con https://tools.ietf.org/html/rfc7252#section-3.2 .

Detalles

Parámetros

`[in,out] aIterator`	Un puntero al iterador de opciones de mensajes CoAP.
`[out] aValue`	Un puntero a un entero sin signo para recibir el valor de la opción.

Valores devueltos

`OT_ERROR_NONE`	Valor completado con éxito.
`OT_ERROR_NOT_FOUND`	Sin opción actual.
`OT_ERROR_NO_BUFS`	El valor es demasiado largo para caber en un uint64_t.

Ver también:
otCoapMessageAppendUintOption

otCoapOptionIteratorGetOptionValue

otError otCoapOptionIteratorGetOptionValue(
  otCoapOptionIterator *aIterator,
  void *aValue
)

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

Detalles

Parámetros

`[in,out] aIterator`	Un puntero al iterador de opciones de mensajes CoAP.
`[out] aValue`	Un puntero a un búfer para recibir el valor de la opción.

Valores devueltos

`OT_ERROR_NONE`	Valor completado con éxito.
`OT_ERROR_NOT_FOUND`	Sin opción actual.

otCoapOptionIteratorInit

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

Esta función inicializa un iterador para las opciones en el mensaje dado.

Detalles

Parámetros

`[in,out] aIterator`	Un puntero al iterador de opciones de mensajes CoAP.
`[in] aMessage`	Un puntero al mensaje CoAP.

Valores devueltos

`OT_ERROR_NONE`	Inicializado con éxito.
`OT_ERROR_PARSE`	El estado del mensaje es inconsistente.

otCoapRemoveBlockWiseResource

void otCoapRemoveBlockWiseResource(
  otInstance *aInstance,
  otCoapBlockwiseResource *aResource
)

Esta función elimina un recurso por bloques del servidor CoAP.

Detalles

Parámetros

`[in] aInstance`	Un puntero a una instancia de OpenThread.
`[in] aResource`	Un puntero al recurso.

otCoapRemoveResource

void otCoapRemoveResource(
  otInstance *aInstance,
  otCoapResource *aResource
)

Esta función elimina un recurso del servidor CoAP.

Detalles

Parámetros

`[in] aInstance`	Un puntero a una instancia de OpenThread.
`[in] aResource`	Un puntero al 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 a una solicitud, se debe proporcionar la función respectiva y la información de contexto. Si no se espera respuesta, estos argumentos deben ser punteros NULL.

Detalles

Parámetros

`[in] aInstance`	Un puntero a una instancia de OpenThread.
`[in] aMessage`	Un puntero al mensaje a enviar.
`[in] aMessageInfo`	Un puntero a la información del mensaje asociada con `aMessage` .
`[in] aHandler`	Puntero de función que se llamará en la recepción de respuesta o en el tiempo de espera.
`[in] aContext`	Un puntero a información de contexto arbitraria. Puede ser NULO si no se usa.

Valores devueltos

`OT_ERROR_NONE`	Mensaje CoAP enviado con éxito.
`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 por bloques.

Esta función está disponible cuando la configuración OPENTHREAD_CONFIG_COAP_BLOCKWISE_TRANSFER_ENABLE está habilitada.

Si se espera una respuesta a una solicitud, se debe proporcionar la función respectiva y la información de contexto. Si se espera que la respuesta sea por bloques, se debe proporcionar una función de gancho respectiva. Si no se espera respuesta, estos argumentos deben ser punteros NULL.

Detalles

Parámetros

`[in] aInstance`	Un puntero a una instancia de OpenThread.
`[in] aMessage`	Un puntero al mensaje a enviar.
`[in] aMessageInfo`	Un puntero a la información del mensaje asociada con `aMessage` .
`[in] aHandler`	Un puntero de función que se llamará en la recepción de respuesta o en el tiempo de espera.
`[in] aContext`	Un puntero a información de contexto arbitraria. Puede ser NULO si no se usa.
`[in] aTransmitHook`	Un puntero a una función de enlace para la transferencia saliente por bloques.
`[in] aReceiveHook`	Un puntero a una función de gancho para la transferencia entrante por bloques.

Valores devueltos

`OT_ERROR_NONE`	Mensaje CoAP enviado con éxito.
`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 la configuración OPENTHREAD_CONFIG_COAP_BLOCKWISE_TRANSFER_ENABLE está habilitada.

Detalles

Parámetros

`[in] aInstance`	Un puntero a una instancia de OpenThread.
`[in] aMessage`	Un puntero al mensaje a enviar.
`[in] aMessageInfo`	Un puntero a la información del mensaje asociada con `aMessage` .
`[in] aHandler`	Un puntero de función que se llamará en la recepción de respuesta o en el tiempo de espera.
`[in] aContext`	Un puntero a información de contexto arbitraria. Puede ser NULO si no se usa.
`[in] aTxParameters`	Un puntero a los parámetros de transmisión para esta solicitud. Utilice NULL para los valores predeterminados.
`[in] aTransmitHook`	Un puntero a una función de enlace para la transferencia saliente por bloques.
`[in] aReceiveHook`	Un puntero a una función de gancho para la transferencia entrante por bloques.

Valores devueltos

`OT_ERROR_NONE`	Mensaje CoAP enviado con éxito.
`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 CoAP con parámetros de transmisión personalizados.

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

Detalles

Parámetros

`[in] aInstance`	Un puntero a una instancia de OpenThread.
`[in] aMessage`	Un puntero al mensaje a enviar.
`[in] aMessageInfo`	Un puntero a la información del mensaje asociada con `aMessage` .
`[in] aHandler`	Un puntero de función que se llamará en la recepción de respuesta o en el tiempo de espera.
`[in] aContext`	Un puntero a información de contexto arbitraria. Puede ser NULO si no se usa.
`[in] aTxParameters`	Un puntero a los parámetros de transmisión para esta solicitud. Utilice NULL para los valores predeterminados. De lo contrario, los parámetros dados deben cumplir las siguientes condiciones: mMaxRetransmit no es más que OT_COAP_MAX_RETRANSMIT. mAckRandomFactorNumerator / mAckRandomFactorDenominator no debe estar por debajo de 1.0. La vida útil calculada del intercambio no debe sobrepasar uint32_t.

Valores devueltos

`OT_ERROR_INVALID_ARGS`	`aTxParameters` no es válido.
`OT_ERROR_NONE`	Mensaje CoAP enviado con éxito.
`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 a una instancia de OpenThread.
`[in] aMessage`	Un puntero a la respuesta de CoAP para enviar.
`[in] aMessageInfo`	Un puntero a la información del mensaje asociada con `aMessage` .

Valores devueltos

`OT_ERROR_NONE`	Se puso en cola con éxito el mensaje de respuesta de CoAP.
`OT_ERROR_NO_BUFS`	Buffers insuficientes disponibles para enviar la respuesta CoAP.

otCoapSendResponseBlockWise

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

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

Esta función está disponible cuando la configuración OPENTHREAD_CONFIG_COAP_BLOCKWISE_TRANSFER_ENABLE está habilitada.

Detalles

Parámetros

`[in] aInstance`	Un puntero a una instancia de OpenThread.
`[in] aMessage`	Un puntero a la respuesta de CoAP para enviar.
`[in] aMessageInfo`	Un puntero a la información del mensaje asociada con `aMessage` .
`[in] aContext`	Un puntero a información de contexto arbitraria. Puede ser NULO si no se usa.
`[in] aTransmitHook`	Un puntero a una función de enlace para la transferencia saliente por bloques.

Valores devueltos

`OT_ERROR_NONE`	Se puso en cola con éxito el mensaje de respuesta de CoAP.
`OT_ERROR_NO_BUFS`	Buffers insuficientes disponibles para enviar la respuesta 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 CoAP en bloque desde el servidor con parámetros de transmisión personalizados.

Esta función está disponible cuando la configuración OPENTHREAD_CONFIG_COAP_BLOCKWISE_TRANSFER_ENABLE está habilitada.

Detalles

Parámetros

`[in] aInstance`	Un puntero a una instancia de OpenThread.
`[in] aMessage`	Un puntero a la respuesta de CoAP para enviar.
`[in] aMessageInfo`	Un puntero a la información del mensaje asociada con `aMessage` .
`[in] aTxParameters`	Un puntero a los parámetros de transmisión para esta respuesta. Utilice NULL para los valores predeterminados.
`[in] aContext`	Un puntero a información de contexto arbitraria. Puede ser NULO si no se usa.
`[in] aTransmitHook`	Un puntero a una función de enlace para la transferencia saliente por bloques.

Valores devueltos

`OT_ERROR_NONE`	Se puso en cola con éxito el mensaje de respuesta de CoAP.
`OT_ERROR_NO_BUFS`	Buffers insuficientes disponibles para enviar la respuesta CoAP.

otCoapSendResponseWithParameters

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

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

Detalles

Parámetros

`[in] aInstance`	Un puntero a una instancia de OpenThread.
`[in] aMessage`	Un puntero a la respuesta de CoAP para enviar.
`[in] aMessageInfo`	Un puntero a la información del mensaje asociada con `aMessage` .
`[in] aTxParameters`	Un puntero a los parámetros de transmisión para esta respuesta. Utilice NULL para los valores predeterminados.

Valores devueltos

`OT_ERROR_NONE`	Se puso en cola con éxito el mensaje de respuesta de CoAP.
`OT_ERROR_NO_BUFS`	Búferes insuficientes disponibles para enviar la respuesta CoAP.

otCoapSetDefaultHandler

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

Esta función establece el manejador predeterminado para las solicitudes CoAP no manejadas.

Detalles

Parámetros

`[in] aInstance`	Un puntero a una instancia de OpenThread.
`[in] aHandler`	Un puntero de función que se llamará cuando llegue una solicitud no manejada.
`[in] aContext`	Un puntero a información de contexto arbitraria. Puede ser NULO si no se usa.

otCoapStart

otError otCoapStart(
  otInstance *aInstance,
  uint16_t aPort
)

Esta función inicia el servidor CoAP.

Detalles

Parámetros

`[in] aInstance`	Un puntero a una instancia de OpenThread.
`[in] aPort`	El puerto UDP local al que enlazar.

Valores devueltos

`OT_ERROR_NONE`	Se inició correctamente el servidor CoAP.
`OT_ERROR_FAILED`	No se pudo iniciar el servidor CoAP.

otCoapStop

otError otCoapStop(
  otInstance *aInstance
)

Esta función detiene el servidor CoAP.

Detalles

Parámetros

[in] aInstance

Un puntero a una instancia de OpenThread.

Valores devueltos

OT_ERROR_NONE

Detuvo correctamente el servidor CoAP.

Macros

OT_COAP_CODE

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

Macro auxiliar para definir valores de código CoAP.

OT_COAP_DEFAULT_TOKEN_LENGTH

 OT_COAP_DEFAULT_TOKEN_LENGTH 2

Longitud de token predeterminada.

OT_COAP_MAX_RETRANSMIT

 OT_COAP_MAX_RETRANSMIT 20

Retransmisión máxima admitida por OpenThread.

OT_COAP_MAX_TOKEN_LENGTH

 OT_COAP_MAX_TOKEN_LENGTH 8

Longitud máxima del token según lo especificado (RFC 7252).

OT_COAP_MIN_ACK_TIMEOUT

 OT_COAP_MIN_ACK_TIMEOUT 1000

Tiempo de espera mínimo de ACK en milisegundos admitido por OpenThread.

OT_DEFAULT_COAP_PORT

 OT_DEFAULT_COAP_PORT 5683

Puerto CoAP predeterminado, como se especifica en RFC 7252.

CoAP

Resumen

Enumeraciones

Typedefs

Funciones

Estructuras

Enumeraciones

otCoapBlockSzx

otCoapCode

otCoapOptionContentFormat

otCoapOptionType

otCoapType

Typedefs

otCoapBlockSzx

otCoapBlockwiseReceiveHook

otCoapBlockwiseResource

otCoapBlockwiseTransmitHook

otCoapCode

otCoapOption

otCoapOptionContentFormat

otCoapOptionIterator

otCoapOptionType

otCoapRequestHandler

otCoapResource

otCoapResponseHandler

otCoapTxParameters

otCoapType

Funciones

otCoapAddBlockWiseResource

otCoapAddResource

otCoapBlockSizeFromExponent

otCoapMessageAppendBlock1Option

otCoapMessageAppendBlock2Option

otCoapMessageAppendContentFormatOption

otCoapMessageAppendMaxAgeOption

otCoapMessageAppendObserveOption

otCoapMessageAppendOption

otCoapMessageAppendProxyUriOption

otCoapMessageAppendUintOption

otCoapMessageAppendUriPathOptions

otCoapMessageAppendUriQueryOption

otCoapMessageCodeToString

otCoapMessageGenerateToken

otCoapMessageGetCode

otCoapMessageGetMessageId

otCoapMessageGetToken

otCoapMessageGetTokenLength

otCoapMessageGetType

otCoapMessageInit

otCoapMessageInitResponse

otCoapMessageSetPayloadMarker

otCoapMessageSetToken

otCoapNewMessage

otCoapOptionIteratorGetFirstOption

otCoapOptionIteratorGetFirstOptionMatching

otCoapOptionIteratorGetNextOption

otCoapOptionIteratorGetNextOptionMatching

otCoapOptionIteratorGetOptionUintValue

otCoapOptionIteratorGetOptionValue

otCoapOptionIteratorInit

otCoapRemoveBlockWiseResource

otCoapRemoveResource

otCoapSendRequest

otCoapSendRequestBlockWise

otCoapSendRequestBlockWiseWithParameters

otCoapSendRequestWithParameters

otCoapSendResponse

otCoapSendResponseBlockWise

otCoapSendResponseBlockWiseWithParameters

otCoapSendResponseWithParameters

otCoapSetDefaultHandler

otCoapStart

otCoapStop

Macros

OT_COAP_CODE

OT_COAP_DEFAULT_TOKEN_LENGTH

OT_COAP_MAX_RETRANSMIT

OT_COAP_MAX_TOKEN_LENGTH

OT_COAP_MIN_ACK_TIMEOUT

OT_DEFAULT_COAP_PORT