coap_client_transport.h
Go to the documentation of this file.
1 /**
2  * @file coap_client_transport.h
3  * @brief Transport protocol abstraction layer
4  *
5  * @section License
6  *
7  * SPDX-License-Identifier: GPL-2.0-or-later
8  *
9  * Copyright (C) 2010-2019 Oryx Embedded SARL. All rights reserved.
10  *
11  * This file is part of CycloneTCP Open.
12  *
13  * This program is free software; you can redistribute it and/or
14  * modify it under the terms of the GNU General Public License
15  * as published by the Free Software Foundation; either version 2
16  * of the License, or (at your option) any later version.
17  *
18  * This program is distributed in the hope that it will be useful,
19  * but WITHOUT ANY WARRANTY; without even the implied warranty of
20  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
21  * GNU General Public License for more details.
22  *
23  * You should have received a copy of the GNU General Public License
24  * along with this program; if not, write to the Free Software Foundation,
25  * Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
26  *
27  * @author Oryx Embedded SARL (www.oryx-embedded.com)
28  * @version 1.9.6
29  **/
30 
31 #ifndef _COAP_CLIENT_TRANSPORT_H
32 #define _COAP_CLIENT_TRANSPORT_H
33 
34 //Dependencies
35 #include "core/net.h"
36 #include "coap/coap_client.h"
37 
38 //C++ guard
39 #ifdef __cplusplus
40 extern "C" {
41 #endif
42 
43 //CoAP client related functions
45 
47  const IpAddr *serverIpAddr, uint16_t serverPort);
48 
50 
52 
54  const void *data, size_t length);
55 
57  void *data, size_t size, size_t *received);
58 
60  systime_t timeout);
61 
62 //C++ guard
63 #ifdef __cplusplus
64 }
65 #endif
66 
67 #endif
uint8_t length
Definition: dtls_misc.h:149
IP network address.
Definition: ip.h:71
error_t coapClientEstablishConnection(CoapClientContext *context, const IpAddr *serverIpAddr, uint16_t serverPort)
Establish network connection.
#define CoapClientContext
Definition: coap_client.h:139
error_t
Error codes.
Definition: error.h:42
CoAP client.
error_t coapClientSendDatagram(CoapClientContext *context, const void *data, size_t length)
Send a datagram.
error_t coapClientWaitForDatagram(CoapClientContext *context, systime_t timeout)
Wait for incoming datagrams.
error_t coapClientReceiveDatagram(CoapClientContext *context, void *data, size_t size, size_t *received)
Receive a datagram.
error_t coapClientOpenConnection(CoapClientContext *context)
Open network connection.
void coapClientCloseConnection(CoapClientContext *context)
Close network connection.
TCP/IP stack core.
uint8_t data[]
Definition: dtls_misc.h:176
uint32_t systime_t
Definition: compiler_port.h:46
error_t coapClientShutdownConnection(CoapClientContext *context)
Shutdown network connection.