libcoap 4.3.5
Loading...
Searching...
No Matches
coap_async.h
Go to the documentation of this file.
1/*
2 * coap_async.h -- state management for asynchronous messages
3 *
4 * Copyright (C) 2010-2024 Olaf Bergmann <bergmann@tzi.org>
5 *
6 * SPDX-License-Identifier: BSD-2-Clause
7 *
8 * This file is part of the CoAP library libcoap. Please see README for terms
9 * of use.
10 */
11
16
17#ifndef COAP_ASYNC_H_
18#define COAP_ASYNC_H_
19
20#include "coap_net.h"
21
31
50COAP_API coap_async_t *coap_register_async(coap_session_t *session,
51 const coap_pdu_t *request,
52 coap_tick_t delay);
53
64COAP_API void coap_async_set_delay(coap_async_t *async, coap_tick_t delay);
65
74COAP_API void coap_async_trigger(coap_async_t *async);
75
83COAP_API void coap_free_async(coap_session_t *session, coap_async_t *async);
84
96COAP_API coap_async_t *coap_find_async(coap_session_t *session, coap_bin_const_t token);
97
105void coap_async_set_app_data(coap_async_t *async, void *app_data);
106
114void *coap_async_get_app_data(const coap_async_t *async);
115
117
118#endif /* COAP_ASYNC_H_ */
coap_async_t
struct coap_async_t coap_async_t
Async Entry information.
Definition coap_forward_decls.h:43
COAP_API
#define COAP_API
Definition coap_libcoap_build.h:41
coap_net.h
CoAP context interface.
coap_tick_t
uint64_t coap_tick_t
This data type represents internal timer ticks with COAP_TICKS_PER_SECOND resolution.
Definition coap_time.h:143
coap_free_async
COAP_API void coap_free_async(coap_session_t *session, coap_async_t *async)
Releases the memory that was allocated by coap_register_async() for the object async.
Definition coap_async.c:252
coap_find_async
COAP_API coap_async_t * coap_find_async(coap_session_t *session, coap_bin_const_t token)
Retrieves the object identified by token from the list of asynchronous transactions that are register...
Definition coap_async.c:258
coap_async_get_app_data
void * coap_async_get_app_data(const coap_async_t *async)
Gets the application data pointer held in async.
Definition coap_async.c:272
coap_async_set_app_data
void coap_async_set_app_data(coap_async_t *async, void *app_data)
Set the application data pointer held in async.
Definition coap_async.c:266
coap_async_trigger
COAP_API void coap_async_trigger(coap_async_t *async)
Trigger the registered async.
coap_register_async
COAP_API coap_async_t * coap_register_async(coap_session_t *session, const coap_pdu_t *request, coap_tick_t delay)
Allocates a new coap_async_t object and fills its fields according to the given request.
Definition coap_async.c:236
coap_async_set_delay
COAP_API void coap_async_set_delay(coap_async_t *async, coap_tick_t delay)
Update the delay timeout, so changing when the registered async triggers.
Definition coap_async.c:246
coap_bin_const_t
CoAP binary data definition with const data.
Definition coap_str.h:64
coap_pdu_t
structure for CoAP PDUs
Definition coap_pdu_internal.h:135
coap_session_t
Abstraction of virtual session that can be attached to coap_context_t (client) or coap_endpoint_t (se...
Definition coap_session_internal.h:68