coap_client_block.h File Reference

CoAP block-wise transfer. More...

#include "core/net.h"
#include "coap/coap_client.h"

Go to the source code of this file.

Functions

error_t coapClientSetTxBlockSize (CoapClientRequest *request, uint_t blockSize)
 Set preferred block for transmission path. More...
 
error_t coapClientSetRxBlockSize (CoapClientRequest *request, uint_t blockSize)
 Set preferred block for reception path. More...
 
error_t coapClientWriteBody (CoapClientRequest *request, const void *data, size_t length, size_t *written, bool_t last)
 Write resource body using block-wise mode. More...
 
error_t coapClientReadBody (CoapClientRequest *request, void *data, size_t size, size_t *received)
 Read resource body using block-wise mode. More...
 
CoapBlockSize coapClientGetMaxBlockSize (void)
 Get maximum block size. More...
 

Detailed Description

CoAP block-wise transfer.

License

Copyright (C) 2010-2018 Oryx Embedded SARL. All rights reserved.

This file is part of CycloneTCP Open.

This program is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation; either version 2 of the License, or (at your option) any later version.

This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.

You should have received a copy of the GNU General Public License along with this program; if not, write to the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.

Author
Oryx Embedded SARL (www.oryx-embedded.com)
Version
1.9.0

Definition in file coap_client_block.h.

Function Documentation

◆ coapClientGetMaxBlockSize()

CoapBlockSize coapClientGetMaxBlockSize ( void  )

Get maximum block size.

Returns
Block size

Definition at line 551 of file coap_client_block.c.

◆ coapClientReadBody()

error_t coapClientReadBody ( CoapClientRequest request,
void *  data,
size_t  size,
size_t *  received 
)

Read resource body using block-wise mode.

Parameters
[in]requestCoAP request handle
[out]dataBuffer into which received data will be placed
[in]sizeMaximum number of bytes that can be received
[out]receivedNumber of bytes that have been received
Returns
Error code

Definition at line 357 of file coap_client_block.c.

◆ coapClientSetRxBlockSize()

error_t coapClientSetRxBlockSize ( CoapClientRequest request,
uint_t  blockSize 
)

Set preferred block for reception path.

Parameters
[in]requestCoAP request handle
[in]blockSizePreferred block size, in bytes
Returns
Error code

Definition at line 95 of file coap_client_block.c.

◆ coapClientSetTxBlockSize()

error_t coapClientSetTxBlockSize ( CoapClientRequest request,
uint_t  blockSize 
)

Set preferred block for transmission path.

Parameters
[in]requestCoAP request handle
[in]blockSizePreferred block size, in bytes
Returns
Error code

Definition at line 51 of file coap_client_block.c.

◆ coapClientWriteBody()

error_t coapClientWriteBody ( CoapClientRequest request,
const void *  data,
size_t  length,
size_t *  written,
bool_t  last 
)

Write resource body using block-wise mode.

Parameters
[in]requestCoAP request handle
[in]dataPointer to a buffer containing the data to be transmitted
[in]lengthNumber of bytes to be transmitted
[out]writtenActual number of bytes written (optional parameter)
[in]lastFlag indicating whether this message fragment is the last
Returns
Error code

Definition at line 142 of file coap_client_block.c.