Contiki-NG
Loading...
Searching...
No Matches
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 "coap-request-state.h"
51#include "sys/cc.h"
52
53/*---------------------------------------------------------------------------*/
54/*- Client Part -------------------------------------------------------------*/
55/*---------------------------------------------------------------------------*/
56typedef struct coap_callback_request_state coap_callback_request_state_t;
57
58struct coap_callback_request_state {
59 coap_request_state_t state;
60 void (*callback)(coap_callback_request_state_t *state);
61};
62
63/**
64 * \brief Send a CoAP request to a remote endpoint.
65 * \param callback_state The callback state to handle the CoAP request.
66 * \param endpoint The destination endpoint.
67 * \param request The request to be sent.
68 * \param callback callback to execute when the response arrives or the timeout expires.
69 * \return 1 if there is a transaction available to send, 0 otherwise.
70 */
71int coap_send_request(coap_callback_request_state_t *callback_state, coap_endpoint_t *endpoint,
72 coap_message_t *request,
73 void (*callback)(coap_callback_request_state_t *callback_state));
74
75#endif /* COAP_CALLBACK_API_H_ */
76/** @} */
cc.h
Default definitions of C compiler quirk work-arounds.
coap-engine.h
CoAP engine implementation.
coap-request-state.h
Common request state for all the APIs.
coap-transactions.h
CoAP module for reliable transport.
coap_send_request
int coap_send_request(coap_callback_request_state_t *callback_state, coap_endpoint_t *endpoint, coap_message_t *request, void(*callback)(coap_callback_request_state_t *callback_state))
Send a CoAP request to a remote endpoint.
Definition coap-callback-api.c:149