libcoap  4.3.0
async.h
Go to the documentation of this file.
1 /*
2  * async.h -- state management for asynchronous messages
3  *
4  * Copyright (C) 2010-2011 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 
17 #ifndef COAP_ASYNC_H_
18 #define COAP_ASYNC_H_
19 
20 #include "net.h"
21 
35 int coap_async_is_supported(void);
36 
55 coap_async_t *
56 coap_register_async(coap_session_t *session,
57  const coap_pdu_t *request,
58  coap_tick_t delay);
59 
70 void
71 coap_async_set_delay(coap_async_t *async, coap_tick_t delay);
72 
80 void
81 coap_free_async(coap_session_t *session, coap_async_t *async);
82 
94 coap_async_t *coap_find_async(coap_session_t *session, coap_bin_const_t token);
95 
103 void coap_async_set_app_data(coap_async_t *async, void *app_data);
104 
112 void *coap_async_get_app_data(const coap_async_t *async);
113 
116 #endif /* COAP_ASYNC_H_ */
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:122
coap_free_async
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: async.c:134
coap_register_async
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: async.c:38
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: async.c:154
coap_async_set_delay
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: async.c:91
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: async.c:149
coap_async_is_supported
int coap_async_is_supported(void)
Returns 1 if libcoap was built with separate messages enabled, 0 otherwise.
Definition: async.c:33
coap_find_async
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: async.c:109
coap_async_t
Definition: coap_async_internal.h:33
coap_bin_const_t
CoAP binary data definition with const data.
Definition: str.h:58
coap_pdu_t
structure for CoAP PDUs token, if any, follows the fixed size header, then options until payload mark...
Definition: coap_pdu_internal.h:94
coap_session_t
Abstraction of virtual session that can be attached to coap_context_t (client) or coap_endpoint_t (se...
Definition: cov_session_reference_model.c:5