mqtt_sn_client_transport.h
Go to the documentation of this file.
1 /**
2  * @file mqtt_sn_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-2024 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 2.4.4
29  **/
30 
31 #ifndef _MQTT_SN_CLIENT_TRANSPORT_H
32 #define _MQTT_SN_CLIENT_TRANSPORT_H
33 
34 //Dependencies
35 #include "core/net.h"
36 #include "mqtt_sn/mqtt_sn_client.h"
37 
38 //C++ guard
39 #ifdef __cplusplus
40 extern "C" {
41 #endif
42 
43 //MQTT-SN related functions
48 
50  const IpAddr *destIpAddr, uint16_t destPort, const void *data,
51  size_t length);
52 
54  const void *data, size_t length);
55 
57  IpAddr *srcIpAddr, uint16_t *srcPort, void *data, size_t size,
58  size_t *received, systime_t timeout);
59 
60 //C++ guard
61 #ifdef __cplusplus
62 }
63 #endif
64 
65 #endif
error_t mqttSnClientSendDatagram(MqttSnClientContext *context, const void *data, size_t length)
Send a datagram.
int bool_t
Definition: compiler_port.h:53
IP network address.
Definition: ip.h:90
#define MqttSnClientContext
uint8_t data[]
Definition: ethernet.h:222
void mqttSnClientCloseConnection(MqttSnClientContext *context)
Close network connection.
error_t mqttSnClientOpenConnection(MqttSnClientContext *context, bool_t secure)
Open network connection.
uint16_t destPort
Definition: tcp.h:340
Ipv4Addr srcIpAddr
Definition: ipcp.h:79
error_t
Error codes.
Definition: error.h:43
uint8_t length
Definition: tcp.h:368
error_t mqttSnClientShutdownConnection(MqttSnClientContext *context)
Shutdown network connection.
uint32_t systime_t
System time.
error_t mqttSnClientEstablishConnection(MqttSnClientContext *context)
Establish network connection.
error_t mqttSnClientReceiveDatagram(MqttSnClientContext *context, IpAddr *srcIpAddr, uint16_t *srcPort, void *data, size_t size, size_t *received, systime_t timeout)
Receive a datagram.
MQTT-SN client.
TCP/IP stack core.
error_t mqttSnClientBroadcastDatagram(MqttSnClientContext *context, const IpAddr *destIpAddr, uint16_t destPort, const void *data, size_t length)
Broadcast a datagram.
Ipv4Addr destIpAddr
Definition: ipcp.h:80