modbus_client_misc.h
Go to the documentation of this file.
1 /**
2  * @file modbus_client_misc.h
3  * @brief Helper functions for Modbus/TCP client
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 _MODBUS_CLIENT_MISC_H
32 #define _MODBUS_CLIENT_MISC_H
33 
34 //Dependencies
35 #include "core/net.h"
36 #include "modbus/modbus_client.h"
37 
38 //C++ guard
39 #ifdef __cplusplus
40 extern "C" {
41 #endif
42 
43 //Modbus/TCP client related functions
46 
48  size_t length);
49 
51 
54 
56 
57 //C++ guard
58 #ifdef __cplusplus
59 }
60 #endif
61 
62 #endif
Modbus/TCP client.
uint8_t length
Definition: dtls_misc.h:149
void * modbusClientGetRequestPdu(ModbusClientContext *context)
Retrieve request PDU.
error_t modbusClientFormatMbapHeader(ModbusClientContext *context, size_t length)
Format MBAP header.
#define ModbusClientContext
Definition: modbus_client.h:81
error_t
Error codes.
Definition: error.h:42
error_t modbusClientCheckResp(ModbusClientContext *context)
Check whether the received response matches the request.
error_t modbusClientParseMbapHeader(ModbusClientContext *context)
Parse MBAP header.
error_t modbusClientTransaction(ModbusClientContext *context)
Perform Modbus transaction.
error_t modbusClientCheckTimeout(ModbusClientContext *context)
Determine whether a timeout error has occurred.
TCP/IP stack core.
void * modbusClientGetResponsePdu(ModbusClientContext *context, size_t *length)
Retrieve response PDU.