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.
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 (* Este puntero de función se llama cuando se recibe un mensaje CoAP con una opción de transferencia por bloques. |
otCoapBlockwiseResource | typedefstruct 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) | typedefotError (* Este puntero de función se llama antes de que se envíe el siguiente bloque en una transferencia por bloques. |
otCoapCode | typedefenum otCoapCode Valores del código 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(* Este puntero de función se llama cuando se recibe una solicitud de CoAP con un Uri-Path determinado. |
otCoapResource | typedefstruct otCoapResource Esta estructura representa un recurso de CoAP. |
otCoapResponseHandler )(void *aContext, otMessage *aMessage, const otMessageInfo *aMessageInfo, otError aResult) | typedefvoid(* 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 | typedefstruct otCoapTxParameters Esta estructura representa los parámetros de transmisión de CoAP. |
otCoapType | typedefenum 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) | 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 CoAP de 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 Max-Age. |
otCoapMessageAppendObserveOption ( otMessage *aMessage, uint32_t aObserve) | Esta función agrega una opción Observar. |
otCoapMessageAppendOption ( otMessage *aMessage, uint16_t aNumber, uint16_t aLength, const void *aValue) | Esta función agrega una opción 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 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 ú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) | 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) | 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) | Esta función inicializa un mensaje de respuesta. |
otCoapMessageSetPayloadMarker ( otMessage *aMessage) | 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) | 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 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) | 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) | Esta función llena el valor de la opción actual en aValue . |
otCoapOptionIteratorInit ( otCoapOptionIterator *aIterator, const otMessage *aMessage) | 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) | Esta función envía una solicitud 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 por bloques. |
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 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 CoAP en 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 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 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) | Esta función inicia el servidor CoAP. |
otCoapStop ( otInstance *aInstance) | 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.
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
otCoapOptionType
otCoapOptionType
Números de opción de CoAP.
otCoapType
otCoapType
Typedefs
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 |
| ||||||||||||
Valores devueltos |
|
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 |
| ||||||||||
Valores devueltos |
|
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)
Este puntero de función se llama cuando se recibe una solicitud de CoAP con un Uri-Path determinado.
Detalles | |||||||
---|---|---|---|---|---|---|---|
Parámetros |
|
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 |
| ||||||||
Valores devueltos |
|
otCoapTxParameters
struct otCoapTxParameters otCoapTxParameters
Esta estructura representa los parámetros de transmisión de CoAP.
Funciones
otCoapAddBlockWiseResource
void otCoapAddBlockWiseResource( otInstance *aInstance, otCoapBlockwiseResource *aResource )
Esta función agrega un recurso por bloques al servidor CoAP.
Detalles | |||||
---|---|---|---|---|---|
Parámetros |
|
otCoapAddResource
void otCoapAddResource( otInstance *aInstance, otCoapResource *aResource )
Esta función agrega un recurso al servidor CoAP.
Detalles | |||||
---|---|---|---|---|---|
Parámetros |
|
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 |
| ||
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 |
| ||||||||
Valores devueltos |
|
otCoapMessageAppendBlock2Option
otError otCoapMessageAppendBlock2Option( otMessage *aMessage, uint32_t aNum, bool aMore, otCoapBlockSzx aSize )
Esta función agrega una opción Block2.
Detalles | |||||||||
---|---|---|---|---|---|---|---|---|---|
Parámetros |
| ||||||||
Valores devueltos |
|
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 |
| ||||||
Valores devueltos |
|
otCoapMessageAppendMaxAgeOption
otError otCoapMessageAppendMaxAgeOption( otMessage *aMessage, uint32_t aMaxAge )
Esta función agrega una opción de Max-Age.
Detalles | |||||||
---|---|---|---|---|---|---|---|
Parámetros |
| ||||||
Valores devueltos |
|
otCoapMessageAppendObserveOption
otError otCoapMessageAppendObserveOption( otMessage *aMessage, uint32_t aObserve )
Esta función agrega una opción Observar.
Detalles | |||||||
---|---|---|---|---|---|---|---|
Parámetros |
| ||||||
Valores devueltos |
|
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 |
| ||||||||
Valores devueltos |
|
otCoapMessageAppendProxyUriOption
otError otCoapMessageAppendProxyUriOption( otMessage *aMessage, const char *aUriPath )
Esta función agrega una opción Proxy-Uri.
Detalles | |||||||
---|---|---|---|---|---|---|---|
Parámetros |
| ||||||
Valores devueltos |
|
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 |
| ||||||
Valores devueltos |
|
otCoapMessageGetOptionUintValue
otCoapMessageAppendUriPathOptions
otError otCoapMessageAppendUriPathOptions( otMessage *aMessage, const char *aUriPath )
Esta función agrega una opción Uri-Path.
Detalles | |||||||
---|---|---|---|---|---|---|---|
Parámetros |
| ||||||
Valores devueltos |
|
otCoapMessageAppendUriQueryOption
otError otCoapMessageAppendUriQueryOption( otMessage *aMessage, const char *aUriQuery )
Esta función agrega una única opción de Uri-Query.
Detalles | |||||||
---|---|---|---|---|---|---|---|
Parámetros |
| ||||||
Valores devueltos |
|
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 |
|
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 devuelve el valor del código.
Detalles | |||
---|---|---|---|
Parámetros |
| ||
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 |
| ||
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 |
| ||
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 |
| ||
Devoluciones | La longitud del Token. |
otCoapMessageGetType
otCoapType otCoapMessageGetType( const otMessage *aMessage )
Esta función devuelve el valor de Tipo.
Detalles | |||
---|---|---|---|
Parámetros |
| ||
Devoluciones | El valor de Tipo. |
otCoapMessageInit
void otCoapMessageInit( otMessage *aMessage, otCoapType aType, otCoapCode aCode )
Esta función inicializa el encabezado 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 devueltos |
|
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 |
| ||||
Valores devueltos |
|
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 devueltos |
|
otCoapNewMessage
otMessage * otCoapNewMessage( otInstance *aInstance, const otMessageSettings *aSettings )
Esta función crea un nuevo mensaje CoAP.
Detalles | |||||
---|---|---|---|---|---|
Parámetros |
| ||||
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 |
| ||
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 |
| ||||
Devoluciones | Un puntero a la primera opción de coincidencia. Si no hay una opción coincidente presente, 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 |
| ||
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 |
| ||||
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 |
| ||||||
Valores devueltos |
|
otCoapMessageAppendUintOption
otCoapOptionIteratorGetOptionValue
otError otCoapOptionIteratorGetOptionValue( otCoapOptionIterator *aIterator, void *aValue )
Esta función llena el valor de la opción actual en aValue
.
Detalles | |||||
---|---|---|---|---|---|
Parámetros |
| ||||
Valores devueltos |
|
otCoapOptionIteratorInit
otError otCoapOptionIteratorInit( otCoapOptionIterator *aIterator, const otMessage *aMessage )
Esta función inicializa un iterador para las opciones en el mensaje dado.
Detalles | |||||
---|---|---|---|---|---|
Parámetros |
| ||||
Valores devueltos |
|
otCoapRemoveBlockWiseResource
void otCoapRemoveBlockWiseResource( otInstance *aInstance, otCoapBlockwiseResource *aResource )
Esta función elimina un recurso por bloques del servidor CoAP.
Detalles | |||||
---|---|---|---|---|---|
Parámetros |
|
otCoapRemoveResource
void otCoapRemoveResource( otInstance *aInstance, otCoapResource *aResource )
Esta función elimina un recurso del servidor 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 CoAP.
Si se espera una respuesta para 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 |
| ||||||||||
Valores devueltos |
|
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 |
| ||||||||||||||
Valores devueltos |
|
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.
Si se espera una respuesta para 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 |
| ||||||||||||||||
Valores devueltos |
|
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 |
| ||||||||||||
Valores devueltos |
|
otCoapSendResponse
otError otCoapSendResponse( otInstance *aInstance, otMessage *aMessage, const otMessageInfo *aMessageInfo )
Esta función envía una respuesta CoAP desde el servidor.
Detalles | |||||||
---|---|---|---|---|---|---|---|
Parámetros |
| ||||||
Valores devueltos |
|
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 |
| ||||||||||
Valores devueltos |
|
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 |
| ||||||||||||
Valores devueltos |
|
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 |
| ||||||||
Valores devueltos |
|
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 |
|
otCoapStart
otError otCoapStart( otInstance *aInstance, uint16_t aPort )
Esta función inicia el servidor CoAP.
Detalles | |||||
---|---|---|---|---|---|
Parámetros |
| ||||
Valores devueltos |
|
otCoapStop
otError otCoapStop( otInstance *aInstance )
Esta función detiene el servidor CoAP.
Detalles | |||
---|---|---|---|
Parámetros |
| ||
Valores devueltos |
|
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.