coap_client_block.h
Go to the documentation of this file.
1 /**
2  * @file coap_client_block.h
3  * @brief CoAP block-wise transfer
4  *
5  * @section License
6  *
7  * Copyright (C) 2010-2018 Oryx Embedded SARL. All rights reserved.
8  *
9  * This file is part of CycloneTCP Open.
10  *
11  * This program is free software; you can redistribute it and/or
12  * modify it under the terms of the GNU General Public License
13  * as published by the Free Software Foundation; either version 2
14  * of the License, or (at your option) any later version.
15  *
16  * This program is distributed in the hope that it will be useful,
17  * but WITHOUT ANY WARRANTY; without even the implied warranty of
18  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
19  * GNU General Public License for more details.
20  *
21  * You should have received a copy of the GNU General Public License
22  * along with this program; if not, write to the Free Software Foundation,
23  * Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
24  *
25  * @author Oryx Embedded SARL (www.oryx-embedded.com)
26  * @version 1.9.0
27  **/
28 
29 #ifndef _COAP_CLIENT_BLOCK_H
30 #define _COAP_CLIENT_BLOCK_H
31 
32 //Dependencies
33 #include "core/net.h"
34 #include "coap/coap_client.h"
35 
36 //C++ guard
37 #ifdef __cplusplus
38  extern "C" {
39 #endif
40 
41 //CoAP client related functions
44 
46  size_t length, size_t *written, bool_t last);
47 
49  size_t size, size_t *received);
50 
52 
53 //C++ guard
54 #ifdef __cplusplus
55  }
56 #endif
57 
58 #endif
TCP/IP stack core.
CoapBlockSize
Block size parameter.
Definition: coap_option.h:156
error_t coapClientReadBody(CoapClientRequest *request, void *data, size_t size, size_t *received)
Read resource body using block-wise mode.
error_t coapClientSetTxBlockSize(CoapClientRequest *request, uint_t blockSize)
Set preferred block for transmission path.
error_t coapClientSetRxBlockSize(CoapClientRequest *request, uint_t blockSize)
Set preferred block for reception path.
uint16_t last
Definition: ipv4_frag.h:94
CoapBlockSize coapClientGetMaxBlockSize(void)
Get maximum block size.
error_t
Error codes.
Definition: error.h:40
unsigned int uint_t
Definition: compiler_port.h:43
uint8_t data[]
Definition: dtls_misc.h:167
CoAP client.
uint8_t length
Definition: dtls_misc.h:140
#define CoapClientRequest
Definition: coap_client.h:141
int bool_t
Definition: compiler_port.h:47
error_t coapClientWriteBody(CoapClientRequest *request, const void *data, size_t length, size_t *written, bool_t last)
Write resource body using block-wise mode.