modbus_client_transport.h File Reference

Transport protocol abstraction layer. More...

#include "core/net.h"
#include "modbus/modbus_client.h"

Go to the source code of this file.

Functions
error_t	modbusClientOpenConnection (ModbusClientContext *context)
	Open network connection. More...
error_t	modbusClientEstablishConnection (ModbusClientContext *context, const IpAddr *serverIpAddr, uint16_t serverPort)
	Establish network connection. More...
error_t	modbusClientShutdownConnection (ModbusClientContext *context)
	Shutdown network connection. More...
void	modbusClientCloseConnection (ModbusClientContext *context)
	Close network connection. More...
error_t	modbusClientSendData (ModbusClientContext *context, const void *data, size_t length, size_t *written, uint_t flags)
	Send data using the relevant transport protocol. More...
error_t	modbusClientReceiveData (ModbusClientContext *context, void *data, size_t size, size_t *received, uint_t flags)
	Receive data using the relevant transport protocol. More...

Detailed Description

Transport protocol abstraction layer.

License

SPDX-License-Identifier: GPL-2.0-or-later

Copyright (C) 2010-2024 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

2.4.4

Definition in file modbus_client_transport.h.

Function Documentation

modbusClientCloseConnection()

void modbusClientCloseConnection

(

ModbusClientContext *

context

)

Close network connection.

Parameters

[in]

context

Pointer to the Modbus/TCP client context

Definition at line 206 of file modbus_client_transport.c.

modbusClientEstablishConnection()

error_t modbusClientEstablishConnection	(	ModbusClientContext *	context,
		const IpAddr *	serverIpAddr,
		uint16_t	serverPort
	)

Establish network connection.

Parameters

[in]	context	Pointer to the Modbus/TCP client context
[in]	serverIpAddr	IP address of the Modbus/TCP server to connect to
[in]	serverPort	TCP port number that will be used to establish the connection

Returns

Error code

Definition at line 129 of file modbus_client_transport.c.

modbusClientOpenConnection()

error_t modbusClientOpenConnection

(

ModbusClientContext *

context

)

Open network connection.

Parameters

[in]

context

Pointer to the Modbus/TCP client context

Returns

Error code

Definition at line 50 of file modbus_client_transport.c.

modbusClientReceiveData()

error_t modbusClientReceiveData	(	ModbusClientContext *	context,
		void *	data,
		size_t	size,
		size_t *	received,
		uint_t	flags
	)

Receive data using the relevant transport protocol.

Parameters

[in]	context	Pointer to the Modbus/TCP client context
[out]	data	Buffer into which received data will be placed
[in]	size	Maximum number of bytes that can be received
[out]	received	Number of bytes that have been received
[in]	flags	Set of flags that influences the behavior of this function

Returns

Error code

Definition at line 270 of file modbus_client_transport.c.

modbusClientSendData()

error_t modbusClientSendData	(	ModbusClientContext *	context,
		const void *	data,
		size_t	length,
		size_t *	written,
		uint_t	flags
	)

Send data using the relevant transport protocol.

Parameters

[in]	context	Pointer to the Modbus/TCP client context
[in]	data	Pointer to a buffer containing the data to be transmitted
[in]	length	Number of bytes to be transmitted
[out]	written	Actual number of bytes written (optional parameter)
[in]	flags	Set of flags that influences the behavior of this function

Returns

Error code

Definition at line 236 of file modbus_client_transport.c.

modbusClientShutdownConnection()

error_t modbusClientShutdownConnection

(

ModbusClientContext *

context

)

Shutdown network connection.

Parameters

[in]

context

Pointer to the Modbus/TCP client context

Returns

Error code

Definition at line 169 of file modbus_client_transport.c.