Contiki-NG
coap-callback-api.h
Go to the documentation of this file.
1 /*
2  * Copyright (c) 2016, SICS Swedish ICT
3  * All rights reserved.
4  *
5  * Redistribution and use in source and binary forms, with or without
6  * modification, are permitted provided that the following conditions
7  * are met:
8  * 1. Redistributions of source code must retain the above copyright
9  * notice, this list of conditions and the following disclaimer.
10  * 2. Redistributions in binary form must reproduce the above copyright
11  * notice, this list of conditions and the following disclaimer in the
12  * documentation and/or other materials provided with the distribution.
13  * 3. Neither the name of the Institute nor the names of its contributors
14  * may be used to endorse or promote products derived from this software
15  * without specific prior written permission.
16  *
17  * THIS SOFTWARE IS PROVIDED BY THE INSTITUTE AND CONTRIBUTORS ``AS IS'' AND
18  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
19  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
20  * ARE DISCLAIMED. IN NO EVENT SHALL THE INSTITUTE OR CONTRIBUTORS BE LIABLE
21  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
22  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
23  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
24  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
25  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
26  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
27  * SUCH DAMAGE.
28  *
29  *
30  */
31 
32 /**
33  * \file
34  * Callback API for doing CoAP requests
35  * Adapted from the blocking API
36  * \author
37  * Joakim Eriksson, joakime@sics.se
38  */
39 
40 /**
41  * \addtogroup coap
42  * @{
43  */
44 
45 #ifndef COAP_CALLBACK_API_H_
46 #define COAP_CALLBACK_API_H_
47 
48 #include "coap-engine.h"
49 #include "coap-transactions.h"
50 #include "sys/cc.h"
51 
52 /*---------------------------------------------------------------------------*/
53 /*- Client Part -------------------------------------------------------------*/
54 /*---------------------------------------------------------------------------*/
55 typedef struct coap_request_state coap_request_state_t;
56 
57 struct coap_request_state {
58  coap_transaction_t *transaction;
59  coap_message_t *response;
60  coap_message_t *request;
61  coap_endpoint_t *remote_endpoint;
62  uint32_t block_num;
63  void *user_data;
64  coap_timer_t coap_timer;
65  void (*callback)(coap_request_state_t *state);
66 };
67 
68 /**
69  * \brief Send a CoAP request to a remote endpoint
70  * \param state The state to handle the CoAP request
71  * \param endpoint The destination endpoint
72  * \param request The request to be sent
73  * \param callback callback to execute when the response arrives or the timeout expires
74  * \return 1 if there is a transaction available to send, 0 otherwise
75  */
76 int coap_send_request(coap_request_state_t *state, coap_endpoint_t *endpoint,
77  coap_message_t *request,
78  void (*callback)(coap_request_state_t *state));
79 
80 #endif /* COAP_CALLBACK_API_H_ */
81 /** @} */
CoAP engine implementation.
int coap_send_request(coap_request_state_t *state, coap_endpoint_t *endpoint, coap_message_t *request, void(*callback)(coap_request_state_t *state))
Send a CoAP request to a remote endpoint.
CoAP module for reliable transport
Default definitions of C compiler quirk work-arounds.