mirror of
https://github.com/obgm/libcoap.git
synced 2026-11-14 20:29:43 +03:00
Jon Shallow
91d8fad663
Update the Public API equivalent of the libcoap functions that need to be called when locked with a name suffix of _lkd. Move matching Public API functions out of coap_threadsafe.c to be coded just ahead of the newly renamed _lkd function. Properly define the _lkd function in the appropriate _internal.h file for documentation, removing the #defines from coap_threadsafe_internal.h. Tag all the Public API functions that have a _lkd function with COAP_API. COAP_API can then be defined as to what should be done for that function. Check libcoap library does not call the original Public API function when it should be calling the _lkd function by marking the Public API not _lkd functions as deprecated during the libcoap library build. [Done by the new COAP_API being defined as __attribute__((deprecated)).] Work in progress for all the functions that need to be multi-thread safe.
125 lines
3.8 KiB
C
125 lines
3.8 KiB
C
/*
|
|
* coap_async.h -- state management for asynchronous messages
|
|
*
|
|
* Copyright (C) 2010-2024 Olaf Bergmann <bergmann@tzi.org>
|
|
*
|
|
* SPDX-License-Identifier: BSD-2-Clause
|
|
*
|
|
* This file is part of the CoAP library libcoap. Please see README for terms
|
|
* of use.
|
|
*/
|
|
|
|
/**
|
|
* @file coap_async.h
|
|
* @brief State management for asynchronous messages
|
|
*/
|
|
|
|
#ifndef COAP_ASYNC_H_
|
|
#define COAP_ASYNC_H_
|
|
|
|
#include "coap_net.h"
|
|
|
|
/**
|
|
* @ingroup application_api
|
|
* @defgroup coap_async Asynchronous Messaging
|
|
* @{
|
|
* API for delayed "separate" messages.
|
|
* A coap_context_t object holds a list of coap_async_t objects that can
|
|
* be used to generate a separate response in the case a result of a request
|
|
* cannot be delivered immediately.
|
|
*/
|
|
|
|
/**
|
|
* Returns @c 1 if libcoap was built with separate messages enabled,
|
|
* @c 0 otherwise.
|
|
*/
|
|
int coap_async_is_supported(void);
|
|
|
|
/**
|
|
* Allocates a new coap_async_t object and fills its fields according to
|
|
* the given @p request. This function returns a pointer to the registered
|
|
* coap_async_t object or @c NULL on error. Note that this function will
|
|
* return @c NULL in case that an object with the same identifier is already
|
|
* registered.
|
|
*
|
|
* When the delay expires, a copy of the @p request will get sent to the
|
|
* appropriate request handler.
|
|
*
|
|
* @param session The session that is used for asynchronous transmissions.
|
|
* @param request The request that is handled asynchronously.
|
|
* @param delay The amount of time to delay before sending response, 0 means
|
|
* wait forever.
|
|
*
|
|
* @return A pointer to the registered coap_async_t object or @c
|
|
* NULL in case of an error.
|
|
*/
|
|
COAP_API coap_async_t *coap_register_async(coap_session_t *session,
|
|
const coap_pdu_t *request,
|
|
coap_tick_t delay);
|
|
|
|
/**
|
|
* Update the delay timeout, so changing when the registered @p async triggers.
|
|
*
|
|
* When the new delay expires, a copy of the original request will get sent to
|
|
* the appropriate request handler.
|
|
*
|
|
* @param async The object to update.
|
|
* @param delay The amount of time to delay before sending response, 0 means
|
|
* wait forever.
|
|
*/
|
|
COAP_API void coap_async_set_delay(coap_async_t *async, coap_tick_t delay);
|
|
|
|
/**
|
|
* Trigger the registered @p async.
|
|
*
|
|
* A copy of the original request will get sent to the appropriate request
|
|
* handler.
|
|
*
|
|
* @param async The async object to trigger.
|
|
*/
|
|
COAP_API void coap_async_trigger(coap_async_t *async);
|
|
|
|
/**
|
|
* Releases the memory that was allocated by coap_register_async() for the
|
|
* object @p async.
|
|
*
|
|
* @param session The session to use.
|
|
* @param async The object to delete.
|
|
*/
|
|
void coap_free_async(coap_session_t *session, coap_async_t *async);
|
|
|
|
/**
|
|
* Retrieves the object identified by @p token from the list of asynchronous
|
|
* transactions that are registered with @p context. This function returns a
|
|
* pointer to that object or @c NULL if not found.
|
|
*
|
|
* @param session The session that is used for asynchronous transmissions.
|
|
* @param token The PDU's token of the object to retrieve.
|
|
*
|
|
* @return A pointer to the object identified by @p token or @c NULL if
|
|
* not found.
|
|
*/
|
|
COAP_API coap_async_t *coap_find_async(coap_session_t *session, coap_bin_const_t token);
|
|
|
|
/**
|
|
* Set the application data pointer held in @p async. This overwrites any
|
|
* existing data pointer.
|
|
*
|
|
* @param async The async state object.
|
|
* @param app_data The pointer to the data.
|
|
*/
|
|
void coap_async_set_app_data(coap_async_t *async, void *app_data);
|
|
|
|
/**
|
|
* Gets the application data pointer held in @p async.
|
|
*
|
|
* @param async The async state object.
|
|
*
|
|
* @return The applicaton data pointer.
|
|
*/
|
|
void *coap_async_get_app_data(const coap_async_t *async);
|
|
|
|
/** @} */
|
|
|
|
#endif /* COAP_ASYNC_H_ */
|