Contiki-NG
coap-request-state.h
Go to the documentation of this file.
1/*
2 * Copyright (c) 2018, RISE SICS AB.
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 copyright holder nor the names of its
14 * contributors may be used to endorse or promote products derived
15 * from this software without specific prior written permission.
16 *
17 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDER AND CONTRIBUTORS
18 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
19 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS
20 * FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE
21 * COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT,
22 * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
23 * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
24 * SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
25 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
26 * STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
27 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED
28 * OF THE POSSIBILITY OF SUCH DAMAGE.
29 */
30
31/**
32 * \addtogroup coap
33 * @{
34 */
35
36/**
37 * \file
38 * Common request state for all the APIs
39 * \author
40 * Carlos Gonzalo Peces <carlosgp143@gmail.com>
41 */
42#ifndef COAP_REQUEST_STATE_H_
43#define COAP_REQUEST_STATE_H_
44
45typedef enum {
46 COAP_REQUEST_STATUS_RESPONSE, /* Response received and no more blocks */
47 COAP_REQUEST_STATUS_MORE, /* Response received and there are more blocks */
48 COAP_REQUEST_STATUS_FINISHED, /* Request finished */
49 COAP_REQUEST_STATUS_TIMEOUT, /* Request Timeout after all retransmissions */
50 COAP_REQUEST_STATUS_BLOCK_ERROR /* Blocks in wrong order */
51} coap_request_status_t;
52
53
54typedef struct coap_request_state {
55 coap_transaction_t *transaction;
56 coap_message_t *response;
57 coap_message_t *request;
58 coap_endpoint_t *remote_endpoint;
59 uint32_t block_num;
60 uint32_t res_block;
61 uint8_t more;
62 uint8_t block_error;
63 void *user_data;
64 coap_request_status_t status;
65} coap_request_state_t;
66
67
68#endif /* COAP_REQUEST_STATE_H_ */
69/** @} */