ftp_client_transport.h File Reference

Transport protocol abstraction layer. More...

#include "core/net.h"
#include "ftp/ftp_client.h"

Go to the source code of this file.

Functions
error_t	ftpClientOpenChannel (FtpClientContext *context, FtpClientChannel *channel, size_t txBufferSize, size_t rxBufferSize)
	Open network connection. More...
error_t	ftpClientOpenSecureChannel (FtpClientContext *context, FtpClientChannel *channel, size_t txBufferSize, size_t rxBufferSize)
	Open secure connection. More...
error_t	ftpClientEstablishSecureChannel (FtpClientChannel *channel)
	Establish secure connection. More...
error_t	ftpClientShutdownChannel (FtpClientChannel *channel)
	Shutdown network connection. More...
void	ftpClientCloseChannel (FtpClientChannel *channel)
	Close network connection. More...
error_t	ftpClientWriteChannel (FtpClientChannel *channel, const void *data, size_t length, size_t *written, uint_t flags)
	Send data using the relevant transport protocol. More...
error_t	ftpClientReadChannel (FtpClientChannel *channel, 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 ftp_client_transport.h.

Function Documentation

ftpClientCloseChannel()

void ftpClientCloseChannel

(

FtpClientChannel *

channel

)

Close network connection.

Parameters

[in]

channel

Control or data channel

Definition at line 229 of file ftp_client_transport.c.

ftpClientEstablishSecureChannel()

error_t ftpClientEstablishSecureChannel

(

FtpClientChannel *

channel

)

Establish secure connection.

Parameters

[in]

channel

Control or data channel

Returns

Error code

Definition at line 174 of file ftp_client_transport.c.

ftpClientOpenChannel()

error_t ftpClientOpenChannel	(	FtpClientContext *	context,
		FtpClientChannel *	channel,
		size_t	txBufferSize,
		size_t	rxBufferSize
	)

Open network connection.

Parameters

[in]	context	Pointer to the FTP client context
[in]	channel	Control or data channel
[in]	txBufferSize	TX buffer size
[in]	rxBufferSize	RX buffer size

Returns

Error code

Definition at line 53 of file ftp_client_transport.c.

ftpClientOpenSecureChannel()

error_t ftpClientOpenSecureChannel	(	FtpClientContext *	context,
		FtpClientChannel *	channel,
		size_t	txBufferSize,
		size_t	rxBufferSize
	)

Open secure connection.

Parameters

[in]	context	Pointer to the FTP client context
[in]	channel	Control or data channel
[in]	txBufferSize	TX buffer size
[in]	rxBufferSize	RX buffer size

Returns

Error code

Definition at line 102 of file ftp_client_transport.c.

ftpClientReadChannel()

error_t ftpClientReadChannel	(	FtpClientChannel *	channel,
		void *	data,
		size_t	size,
		size_t *	received,
		uint_t	flags
	)

Receive data using the relevant transport protocol.

Parameters

[in]	channel	Control or data channel
[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 293 of file ftp_client_transport.c.

ftpClientShutdownChannel()

error_t ftpClientShutdownChannel

(

FtpClientChannel *

channel

)

Shutdown network connection.

Parameters

[in]

channel

Control or data channel

Returns

Error code

Definition at line 192 of file ftp_client_transport.c.

ftpClientWriteChannel()

error_t ftpClientWriteChannel	(	FtpClientChannel *	channel,
		const void *	data,
		size_t	length,
		size_t *	written,
		uint_t	flags
	)

Send data using the relevant transport protocol.

Parameters

[in]	channel	Control or data channel
[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 259 of file ftp_client_transport.c.