ftp_server.c File Reference

FTP server (File Transfer Protocol) More...

#include "ftp/ftp_server.h"
#include "ftp/ftp_server_control.h"
#include "ftp/ftp_server_data.h"
#include "ftp/ftp_server_misc.h"
#include "path.h"
#include "debug.h"

Go to the source code of this file.

Macros
#define	TRACE_LEVEL   FTP_TRACE_LEVEL

Functions
void	ftpServerGetDefaultSettings (FtpServerSettings *settings)
	Initialize settings with default values. More...
error_t	ftpServerInit (FtpServerContext *context, const FtpServerSettings *settings)
	FTP server initialization. More...
error_t	ftpServerStart (FtpServerContext *context)
	Start FTP server. More...
error_t	ftpServerStop (FtpServerContext *context)
	Stop FTP server. More...
error_t	ftpServerSetHomeDir (FtpClientConnection *connection, const char_t *homeDir)
	Set home directory. More...
void	ftpServerTask (FtpServerContext *context)
	FTP server task. More...
void	ftpServerDeinit (FtpServerContext *context)
	Release FTP server context. More...

Detailed Description

FTP server (File Transfer Protocol)

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.

Description

File Transfer Protocol (FTP) is a standard network protocol used to transfer files from one host to another host over a TCP-based network. Refer to the following RFCs for complete details:

• RFC 959: File Transfer Protocol (FTP)
• RFC 3659: Extensions to FTP
• RFC 2428: FTP Extensions for IPv6 and NATs

Author

Oryx Embedded SARL (www.oryx-embedded.com)

Version

2.4.0

Definition in file ftp_server.c.

Macro Definition Documentation

TRACE_LEVEL

#define TRACE_LEVEL   FTP_TRACE_LEVEL

Definition at line 41 of file ftp_server.c.

Function Documentation

ftpServerDeinit()

void ftpServerDeinit

(

FtpServerContext *

context

)

Release FTP server context.

Parameters

[in]

context

Pointer to the FTP server context

Definition at line 539 of file ftp_server.c.

ftpServerGetDefaultSettings()

void ftpServerGetDefaultSettings

(

FtpServerSettings *

settings

)

Initialize settings with default values.

Parameters

[out]

settings

Structure that contains FTP server settings

Definition at line 60 of file ftp_server.c.

ftpServerInit()

error_t ftpServerInit	(	FtpServerContext *	context,
		const FtpServerSettings *	settings
	)

FTP server initialization.

Parameters

[in]	context	Pointer to the FTP server context
[in]	settings	FTP server specific settings

Returns

Error code

Definition at line 120 of file ftp_server.c.

ftpServerSetHomeDir()

error_t ftpServerSetHomeDir	(	FtpClientConnection *	connection,
		const char_t *	homeDir
	)

Set home directory.

Parameters

[in]	connection	Pointer to the client connection
[in]	homeDir	NULL-terminated string specifying the home directory

Returns

Error code

Definition at line 368 of file ftp_server.c.

ftpServerStart()

error_t ftpServerStart

(

FtpServerContext *

context

)

Start FTP server.

Parameters

[in]

context

Pointer to the FTP server context

Returns

Error code

Definition at line 210 of file ftp_server.c.

ftpServerStop()

error_t ftpServerStop

(

FtpServerContext *

context

)

Stop FTP server.

Parameters

[in]

context

Pointer to the FTP server context

Returns

Error code

Definition at line 319 of file ftp_server.c.

ftpServerTask()

void ftpServerTask

(

FtpServerContext *

context

)

FTP server task.

Parameters

[in]

context

Pointer to the FTP server context

Definition at line 395 of file ftp_server.c.