modbus_server_transport.h File Reference

Transport protocol abstraction layer. More...

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

Go to the source code of this file.

Functions
void	modbusServerAcceptConnection (ModbusServerContext *context)
	Accept connection request. More...
error_t	modbusServerShutdownConnection (ModbusClientConnection *connection)
	Shutdown network connection. More...
void	modbusServerCloseConnection (ModbusClientConnection *connection)
	Close network connection. More...
error_t	modbusServerSendData (ModbusClientConnection *connection, const void *data, size_t length, size_t *written, uint_t flags)
	Send data using the relevant transport protocol. More...
error_t	modbusServerReceiveData (ModbusClientConnection *connection, 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_server_transport.h.

Function Documentation

modbusServerAcceptConnection()

void modbusServerAcceptConnection

(

ModbusServerContext *

context

)

Accept connection request.

Parameters

[in]

context

Pointer to the Modbus/TCP server context

Definition at line 50 of file modbus_server_transport.c.

modbusServerCloseConnection()

void modbusServerCloseConnection

(

ModbusClientConnection *

connection

)

Close network connection.

Parameters

[in]

connection

Pointer to the client connection

Definition at line 236 of file modbus_server_transport.c.

modbusServerReceiveData()

error_t modbusServerReceiveData	(	ModbusClientConnection *	connection,
		void *	data,
		size_t	size,
		size_t *	received,
		uint_t	flags
	)

Receive data using the relevant transport protocol.

Parameters

[in]	connection	Pointer to the client connection
[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 318 of file modbus_server_transport.c.

modbusServerSendData()

error_t modbusServerSendData	(	ModbusClientConnection *	connection,
		const void *	data,
		size_t	length,
		size_t *	written,
		uint_t	flags
	)

Send data using the relevant transport protocol.

Parameters

[in]	connection	Pointer to the client connection
[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 284 of file modbus_server_transport.c.

modbusServerShutdownConnection()

error_t modbusServerShutdownConnection

(

ModbusClientConnection *

connection

)

Shutdown network connection.

Parameters

[in]

connection

Pointer to the client connection

Returns

Error code

Definition at line 168 of file modbus_server_transport.c.