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 la API de CoAP (OPENTHREAD_CONFIG_COAP_API_ENABLE
) está habilitada.
Typedefs |
|
---|---|
otCoapBlockSzx
|
typedefenum 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)
|
typedefotError(*
Se llama a este puntero de función cuando se recibe un mensaje de CoAP con una opción de transferencia a nivel de bloque. |
otCoapBlockwiseResource
|
typedefstruct otCoapBlockwiseResource
Esta estructura representa un recurso de CoAP con la transferencia en bloques. |
otCoapBlockwiseTransmitHook)(void *aContext, uint8_t *aBlock, uint32_t aPosition, uint16_t *aBlockLength, bool *aMore)
|
typedefotError(*
Se llama a este puntero de función antes de que se envíe el siguiente bloque de una transferencia a nivel de bloque. |
otCoapCode
|
typedefenum otCoapCode
Valores de CoAP. |
otCoapOption
|
typedefstruct otCoapOption
Esta estructura representa una opción de CoAP. |
otCoapOptionContentFormat
|
typedef Códigos de formato de contenido de CoAP. |
otCoapOptionIterator
|
typedefstruct otCoapOptionIterator
Esta estructura actúa como un iterador para las opciones de CoAP. |
otCoapOptionType
|
typedefenum otCoapOptionType
Números de opción de CoAP. |
otCoapRequestHandler)(void *aContext, otMessage *aMessage, const otMessageInfo *aMessageInfo)
|
typedefvoid(*
Se llama a este puntero de función cuando se recibe una solicitud CoAP con una Uri-Path determinada. |
otCoapResource
|
typedefstruct otCoapResource
Esta estructura representa un recurso CoAP. |
otCoapResponseHandler)(void *aContext, otMessage *aMessage, const otMessageInfo *aMessageInfo, otError aResult)
|
typedefvoid(*
Se llama a este puntero de función cuando se recibe una respuesta de CoAP o en el tiempo de espera de la solicitud. |
otCoapTxParameters
|
typedefstruct otCoapTxParameters
Esta estructura representa los parámetros de transmisión de CoAP. |
otCoapType
|
typedefenum otCoapType
Valores de tipo CoAP (número entero de 2 bits sin firmar). |
Funciones |
|
---|---|
otCoapAddBlockWiseResource(otInstance *aInstance, otCoapBlockwiseResource *aResource)
|
void
Esta función agrega un recurso de bloques 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 la opción Bloquear 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 de Block1.
|
otCoapMessageAppendBlock2Option(otMessage *aMessage, uint32_t aNum, bool aMore, otCoapBlockSzx aSize)
|
Esta función agrega una opción de Block2.
|
otCoapMessageAppendContentFormatOption(otMessage *aMessage, otCoapOptionContentFormat aContentFormat)
|
Esta función anexa 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 de observación.
|
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 CoAP de número entero sin firmar, 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 Uri-Query.
|
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 Tipo.
|
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 Código.
|
otCoapMessageSetPayloadMarker(otMessage *aMessage)
|
Esta función agrega un marcador de carga útil que indica el comienzo de la carga útil al encabezado de CoAP.
|
otCoapMessageSetToken(otMessage *aMessage, const uint8_t *aToken, uint8_t aTokenLength)
|
Esta función establece el valor y la longitud del token en un encabezado.
|
otCoapNewMessage(otInstance *aInstance, const otMessageSettings *aSettings)
|
Esta función crea un mensaje 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 a 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 a la siguiente opción.
|
otCoapOptionIteratorGetNextOptionMatching(otCoapOptionIterator *aIterator, uint16_t aOption)
|
const otCoapOption *
Esta función muestra un puntero a la siguiente opción que coincide con el número de opción especificado.
|
otCoapOptionIteratorGetOptionUintValue(otCoapOptionIterator *aIterator, uint64_t *aValue)
|
Esta función llena 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 dado.
|
otCoapRemoveBlockWiseResource(otInstance *aInstance, otCoapBlockwiseResource *aResource)
|
void
Esta función quita un recurso de bloques 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 de 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 de 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 de 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 en 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 de CoAP con la transferencia en bloques. |
otCoapOption. |
Esta estructura representa una opción de CoAP. |
otCoapOptionIterator |
Esta estructura actúa como un iterador para las opciones de CoAP. |
Recurso otCoap |
Esta estructura representa un recurso CoAP. |
Parámetros de otCoapTx |
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 CoAP.
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
|
application/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
|
aplicación/octet-stream: [RFC2045][RFC2046] |
OT_COAP_OPTION_CONTENT_FORMAT_SENML_CBOR
|
application/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 otCoap
otCoapOptionType
Números de opción de CoAP.
Propiedades | |
---|---|
OT_COAP_OPTION_ACCEPT
|
Aceptar |
OT_COAP_OPTION_BLOCK1
|
Block1 (RFC7959) |
OT_COAP_OPTION_BLOCK2
|
Block2 (RFC7959) |
OT_COAP_OPTION_CONTENT_FORMAT
|
Formato de contenido. |
OT_COAP_OPTION_E_TAG
|
ETag. |
OT_COAP_OPTION_IF_MATCH
|
Si coincide. |
OT_COAP_OPTION_IF_NONE_MATCH
|
Si no coincide ninguno. |
OT_COAP_OPTION_LOCATION_PATH
|
Ruta de ubicación. |
OT_COAP_OPTION_LOCATION_QUERY
|
Ubicación y consulta. |
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
|
Proxy-Uri. |
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
|
URI-Ruta. |
OT_COAP_OPTION_URI_PORT
|
Uri-Port |
OT_COAP_OPTION_URI_QUERY
|
Uri-Query |
Tipo de otCoap
otCoapType
Valores de tipo CoAP (número entero de 2 bits sin firmar).
Propiedades | |
---|---|
OT_COAP_TYPE_ACKNOWLEDGMENT
|
Confirmación. |
OT_COAP_TYPE_CONFIRMABLE
|
Confirmable. |
OT_COAP_TYPE_NON_CONFIRMABLE
|
No se puede confirmar. |
OT_COAP_TYPE_RESET
|
Restablecer. |
Typedefs
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 a nivel de bloque.
Esta función está disponible cuando se habilita la configuración de OPENTHREAD_CONFIG_COAP_BLOCKWISE_TRANSFER_ENABLE.
Detalles | |||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|
Parámetros |
|
||||||||||||
Valores de retorno |
|
otCoapBlockwiseResource
struct otCoapBlockwiseResource otCoapBlockwiseResource
Esta estructura representa un recurso de CoAP con la transferencia en bloques.
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 que se envíe el siguiente bloque de una transferencia a nivel de bloque.
Esta función está disponible cuando se habilita la configuración de OPENTHREAD_CONFIG_COAP_BLOCKWISE_TRANSFER_ENABLE.
Cuando se cambia el valor de aBlockLength, se renegocia el tamaño de 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 del CoAP.
Detalles | |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
Parámetros |
|
||||||||||
Valores de retorno |
|
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.
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 Uri-Path determinada.
Detalles | |||||||
---|---|---|---|---|---|---|---|
Parámetros |
|
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 en el tiempo de espera de la solicitud.
Detalles | |||||||||
---|---|---|---|---|---|---|---|---|---|
Parámetros |
|
||||||||
Valores de retorno |
|
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 firmar).
Funciones
otCoapAddBlockWiseResource
void otCoapAddBlockWiseResource( otInstance *aInstance, otCoapBlockwiseResource *aResource )
Esta función agrega un recurso de bloques al servidor de CoAP.
Detalles | |||||
---|---|---|---|---|---|
Parámetros |
|
otCoapAddResource
void otCoapAddResource( otInstance *aInstance, otCoapResource *aResource )
Esta función agrega un recurso al servidor de CoAP.
Detalles | |||||
---|---|---|---|---|---|
Parámetros |
|
otCoapBlockSizeFromExponent
uint16_t otCoapBlockSizeFromExponent( otCoapBlockSzx aSize )
Esta función convierte un campo SZX de la opción Bloquear CoAP en el tamaño real del bloque.
Detalles | |||
---|---|---|---|
Parámetros |
|
||
Qué muestra |
El valor real del exponente de tamaño.
|
otCoapMessageAppendBlock1Option
otError otCoapMessageAppendBlock1Option( otMessage *aMessage, uint32_t aNum, bool aMore, otCoapBlockSzx aSize )
Esta función agrega una opción de Block1.
Detalles | |||||||||
---|---|---|---|---|---|---|---|---|---|
Parámetros |
|
||||||||
Valores de retorno |
|
otCoapMessageAppendBlock2Option
otError otCoapMessageAppendBlock2Option( otMessage *aMessage, uint32_t aNum, bool aMore, otCoapBlockSzx aSize )
Esta función agrega una opción de Block2.
Detalles | |||||||||
---|---|---|---|---|---|---|---|---|---|
Parámetros |
|
||||||||
Valores de retorno |
|
otCoapMessageAppendContentFormatOption
otError otCoapMessageAppendContentFormatOption( otMessage *aMessage, otCoapOptionContentFormat aContentFormat )
Esta función anexa 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 va a incluir una carga útil en el mensaje.
La función es un wrapper de conveniencia alrededor de otCoapMessageAppendUintOption y, si el código de tipo de formato deseado no se encuentra en otCoapOptionContentFormat, se debe usar en su lugar.
Detalles | |||||||
---|---|---|---|---|---|---|---|
Parámetros |
|
||||||
Valores de retorno |
|
otCoapMessageAppendMaxAgeOption
otError otCoapMessageAppendMaxAgeOption( otMessage *aMessage, uint32_t aMaxAge )
Esta función agrega una opción de edad máxima.
Detalles | |||||||
---|---|---|---|---|---|---|---|
Parámetros |
|
||||||
Valores de retorno |
|
otCoapMessageAppendObserveOption
otError otCoapMessageAppendObserveOption( otMessage *aMessage, uint32_t aObserve )
Esta función agrega una opción de observación.
Detalles | |||||||
---|---|---|---|---|---|---|---|
Parámetros |
|
||||||
Valores de retorno |
|
otCoapMessageAppendOption
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 |
|
||||||||
Valores de retorno |
|
otCoapMessageAppendProxyUriOption
otError otCoapMessageAppendProxyUriOption( otMessage *aMessage, const char *aUriPath )
Esta función agrega una opción Proxy-Uri.
Detalles | |||||||
---|---|---|---|---|---|---|---|
Parámetros |
|
||||||
Valores de retorno |
|
otCoapMessageAppendUintOption
otError otCoapMessageAppendUintOption( otMessage *aMessage, uint16_t aNumber, uint32_t aValue )
Esta función agrega una opción CoAP de número entero sin firmar, como se especifica en https://tools.ietf.org/html/rfc7252#section-3.2.
Detalles | |||||||
---|---|---|---|---|---|---|---|
Parámetros |
|
||||||
Valores de retorno |
|
otCoapMessageGetOptionUintValue
otCoapMessageAppendUriPathOptions
otError otCoapMessageAppendUriPathOptions( otMessage *aMessage, const char *aUriPath )
Esta función agrega una opción Uri-Path.
Detalles | |||||||
---|---|---|---|---|---|---|---|
Parámetros |
|
||||||
Valores de retorno |
|
otCoapMessageAppendUriQueryOption
otError otCoapMessageAppendUriQueryOption( otMessage *aMessage, const char *aUriQuery )
Esta función agrega una sola opción Uri-Query.
Detalles | |||||||
---|---|---|---|---|---|---|---|
Parámetros |
|
||||||
Valores de retorno |
|
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 |
|
otCoapMessageGenerateToken
void otCoapMessageGenerateToken( otMessage *aMessage, uint8_t aTokenLength )
Esta función establece la longitud del token y aleatoriza su valor.
Detalles | |||||
---|---|---|---|---|---|
Parámetros |
|
otCoapMessageGetCode
otCoapCode otCoapMessageGetCode( const otMessage *aMessage )
Esta función muestra el valor del código.
Detalles | |||
---|---|---|---|
Parámetros |
|
||
Qué muestra |
El valor del código.
|
otCoapMessageGetMessageId
uint16_t otCoapMessageGetMessageId( const otMessage *aMessage )
Esta función muestra el valor del ID de mensaje.
Detalles | |||
---|---|---|---|
Parámetros |
|
||
Qué muestra |
El valor del ID de mensaje.
|
otCoapMessageGetToken
const uint8_t * otCoapMessageGetToken( const otMessage *aMessage )
Esta función muestra un puntero para el valor del token.
Detalles | |||
---|---|---|---|
Parámetros |
|
||
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 |
|
||
Qué muestra |
La longitud del token.
|
otCoapMessageGetType
otCoapType otCoapMessageGetType( const otMessage *aMessage )
Esta función muestra el valor Tipo.
Detalles | |||
---|---|---|---|
Parámetros |
|
||
Qué muestra |
El valor Tipo.
|
otCoapMessageInit
void otCoapMessageInit( otMessage *aMessage, otCoapType aType, otCoapCode aCode )
Esta función inicializa el encabezado de CoAP.
Detalles | |||||||
---|---|---|---|---|---|---|---|
Parámetros |
|
otCoapMessageInitResponse
otError otCoapMessageInitResponse( otMessage *aResponse, const otMessage *aRequest, otCoapType aType, otCoapCode aCode )
Esta función inicializa un mensaje de respuesta.
Detalles | |||||||||
---|---|---|---|---|---|---|---|---|---|
Parámetros |
|
||||||||
Valores de retorno |
|
otCoapMessageSetCode
void otCoapMessageSetCode( otMessage *aMessage, otCoapCode aCode )
Esta función establece el valor Código.
Detalles | |||||
---|---|---|---|---|---|
Parámetros |
|
otCoapMessageSetPayloadMarker
otError otCoapMessageSetPayloadMarker( otMessage *aMessage )
Esta función agrega un marcador de carga útil que indica el comienzo de la carga útil al encabezado de CoAP.
Detalles | |||||
---|---|---|---|---|---|
Parámetros |
|
||||
Valores de retorno |
|
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 |
|
||||||
Valores de retorno |
|
Nuevo mensaje de OtCoap
otMessage * otCoapNewMessage( otInstance *aInstance, const otMessageSettings *aSettings )
Esta función crea un mensaje CoAP nuevo.
Detalles | |||||
---|---|---|---|---|---|
Parámetros |
|
||||
Qué muestra |
Un puntero al búfer de mensajes o NULL si no hay búferes de mensajes disponibles o si 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 |
|
||
Qué muestra |
Un puntero para la primera opción. Si no hay ninguna opción, se muestra un puntero NULL.
|
otCoapOptionIteratorGetFirstOptionMatching
const otCoapOption * otCoapOptionIteratorGetFirstOptionMatching( otCoapOptionIterator *aIterator, uint16_t aOption )
Esta función muestra un puntero a la primera opción que coincide con el número de opción especificado.
Detalles | |||||
---|---|---|---|---|---|
Parámetros |
|
||||
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 a la siguiente opción.
Detalles | |||
---|---|---|---|
Parámetros |
|
||
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 a la siguiente opción que coincide con el número de opción especificado.
Detalles | |||||
---|---|---|---|---|---|
Parámetros |
|
||||
Qué muestra |
Un puntero para la siguiente opción coincidente. Si no aparece ninguna otra opción de coincidencia, se muestra un puntero NULL.
|
otCoapOptionIteratorGetOptionUintValue
otError otCoapOptionIteratorGetOptionUintValue( otCoapOptionIterator *aIterator, uint64_t *aValue )
Esta función llena 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 |
|
||||||
Valores de retorno |
|
otCoapMessageAppendUintOption
otCoapOptionIteratorGetOptionValue
otError otCoapOptionIteratorGetOptionValue( otCoapOptionIterator *aIterator, void *aValue )
Esta función rellena el valor de la opción actual en aValue
.
Detalles | |||||
---|---|---|---|---|---|
Parámetros |
|
||||
Valores de retorno |
|
otCoapOptionIteratorInit
otError otCoapOptionIteratorInit( otCoapOptionIterator *aIterator, const otMessage *aMessage )
Esta función inicializa un iterador para las opciones del mensaje dado.
Detalles | |||||
---|---|---|---|---|---|
Parámetros |
|
||||
Valores de retorno |
|
otCoapRemoveBlockWiseResource
void otCoapRemoveBlockWiseResource( otInstance *aInstance, otCoapBlockwiseResource *aResource )
Esta función quita un recurso de bloques del servidor CoAP.
Detalles | |||||
---|---|---|---|---|---|
Parámetros |
|
otCoapRemoveResource
void otCoapRemoveResource( otInstance *aInstance, otCoapResource *aResource )
Esta función quita un recurso del servidor de CoAP.
Detalles | |||||
---|---|---|---|---|---|
Parámetros |
|
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 información respectiva de función y contexto. Si no se espera una respuesta, estos argumentos deben ser punteros NULL.
Detalles | |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
Parámetros |
|
||||||||||
Valores de retorno |
|
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 de CoAP en bloque.
Esta función está disponible cuando se habilita la configuración de OPENTHREAD_CONFIG_COAP_BLOCKWISE_TRANSFER_ENABLE.
Si se espera una respuesta a una solicitud, se debe proporcionar la información respectiva de función y contexto. Si se espera que la respuesta sea en forma de bloque, se debe proporcionar una función de enlace respectiva. Si no se espera una respuesta, estos argumentos deben ser punteros NULL.
Detalles | |||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
Parámetros |
|
||||||||||||||
Valores de retorno |
|
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 de CoAP en bloque con parámetros de transmisión personalizados.
Esta función está disponible cuando se habilita la configuración de OPENTHREAD_CONFIG_COAP_BLOCKWISE_TRANSFER_ENABLE.
Si se espera una respuesta a una solicitud, se debe proporcionar la información respectiva de función y contexto. Si se espera que la respuesta sea en forma de bloque, se debe proporcionar una función de enlace respectiva. Si no se espera una respuesta, estos argumentos deben ser punteros NULL.
Detalles | |||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
Parámetros |
|
||||||||||||||||
Valores de retorno |
|
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 a una solicitud, se debe proporcionar la información respectiva de función y contexto. Si no se espera una respuesta, estos argumentos deben ser punteros NULL.
Detalles | |||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|
Parámetros |
|
||||||||||||
Valores de retorno |
|
otCoapSendResponse
otError otCoapSendResponse( otInstance *aInstance, otMessage *aMessage, const otMessageInfo *aMessageInfo )
Esta función envía una respuesta de CoAP desde el servidor.
Detalles | |||||||
---|---|---|---|---|---|---|---|
Parámetros |
|
||||||
Valores de retorno |
|
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 de OPENTHREAD_CONFIG_COAP_BLOCKWISE_TRANSFER_ENABLE.
Detalles | |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
Parámetros |
|
||||||||||
Valores de retorno |
|
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 en bloque desde el servidor con parámetros de transmisión personalizados.
Esta función está disponible cuando se habilita la configuración de OPENTHREAD_CONFIG_COAP_BLOCKWISE_TRANSFER_ENABLE.
Detalles | |||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|
Parámetros |
|
||||||||||||
Valores de retorno |
|
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 |
|
||||||||
Valores de retorno |
|
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 |
|
otCoapStart
otError otCoapStart( otInstance *aInstance, uint16_t aPort )
Esta función inicia el servidor de CoAP.
Detalles | |||||
---|---|---|---|---|---|
Parámetros |
|
||||
Valores de retorno |
|
otCoapStop
otError otCoapStop( otInstance *aInstance )
Esta función detiene el servidor CoAP.
Detalles | |||
---|---|---|---|
Parámetros |
|
||
Valores de retorno |
|
Macros
TC_COAP_CODE
OT_COAP_CODE ((((c)&0x7) << 5) | ((d)&0x1f))
Macro auxiliar para definir los valores del código CoAP.
TS_COAP_DEFAULT_TOKEN_LENGTH
OT_COAP_DEFAULT_TOKEN_LENGTH 2
Longitud predeterminada del token.
TS_COAP_MAX_RETRANSMIT
OT_COAP_MAX_RETRANSMIT 20
La retransmisión máxima es compatible con OpenThread.
TS_COAP_MAX_TOKEN_LENGTH
OT_COAP_MAX_TOKEN_LENGTH 8
Longitud máxima de token especificada (RFC 7252).
TS_COAP_MIN_ACK_TIMEOUT
OT_COAP_MIN_ACK_TIMEOUT 1000
Tiempo de espera ACK mínimo en milisegundos compatible con OpenThread.
TS_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 a partir del código fuente, disponible en GitHub. Para obtener más información o contribuir con nuestra documentación, consulta Recursos.