Sergey Pastor / 1

Dependents:   Nucleo

Embed: (wiki syntax)

« Back to documentation index

ftp_server.h File Reference
Data Structures | Typedefs | Enumerations | Functions

ftp_server.h File Reference

FTP server (File Transfer Protocol) More...

Go to the source code of this file.

Data Structures

struct  FtpClientConnection
 FTP client connection. More...
struct  FtpServerSettings
 FTP server settings. More...
struct  FtpServerContext
 FTP server context. More...

Typedefs

typedef uint_t(* FtpCheckUserCallback )(FtpClientConnection *connection, const char_t *user)
 User verification callback function.
typedef uint_t(* FtpCheckPasswordCallback )(FtpClientConnection *connection, const char_t *user, const char_t *password)
 Password verification callback function.
typedef uint_t(* FtpGetFilePermCallback )(FtpClientConnection *connection, const char_t *user, const char_t *path)
 Callback used to retrieve file permissions.
typedef error_t(* FtpUnknownCommandCallback )(FtpClientConnection *connection, const char_t *command, const char_t *param)
 Unknown command callback function.

Enumerations

enum  FtpControlConnState
 

Control connection state.

More...
enum  FtpDataConnState
 

Data connection state.

More...
enum  FtpAccessStatus
 

FTP server access status.

More...
enum  FtpFilePerm
 

File permissions.

More...

Functions

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

Detailed Description

FTP server (File Transfer Protocol)

License

Copyright (C) 2010-2017 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:
1.7.6

Definition in file ftp_server.h.

Typedef Documentation

typedef uint_t(* FtpCheckPasswordCallback)(FtpClientConnection *connection, const char_t *user, const char_t *password)

Password verification callback function.

Definition at line 272 of file ftp_server.h.

typedef uint_t(* FtpCheckUserCallback)(FtpClientConnection *connection, const char_t *user)

User verification callback function.

Definition at line 264 of file ftp_server.h.

typedef uint_t(* FtpGetFilePermCallback)(FtpClientConnection *connection, const char_t *user, const char_t *path)

Callback used to retrieve file permissions.

Definition at line 280 of file ftp_server.h.

typedef error_t(* FtpUnknownCommandCallback)(FtpClientConnection *connection, const char_t *command, const char_t *param)

Unknown command callback function.

Definition at line 288 of file ftp_server.h.

Enumeration Type Documentation

enum FtpAccessStatus

FTP server access status.

Definition at line 207 of file ftp_server.h.

enum FtpControlConnState

Control connection state.

Definition at line 169 of file ftp_server.h.

enum FtpDataConnState

Data connection state.

Definition at line 190 of file ftp_server.h.

enum FtpFilePerm

File permissions.

Definition at line 219 of file ftp_server.h.

Function Documentation

void ftpServerGetDefaultSettings ( FtpServerSettings *  settings )

Initialize settings with default values.

Parameters:
[out]settingsStructure that contains FTP server settings

Definition at line 60 of file ftp_server.c.

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

FTP server initialization.

Parameters:
[in]contextPointer to the FTP server context
[in]settingsFTP server specific settings
Returns:
Error code

Definition at line 92 of file ftp_server.c.

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

Set home directory.

Parameters:
[in]connectionPointer to the client connection
[in]homeDirNULL-terminated string specifying the home directory
Returns:
Error code

Definition at line 230 of file ftp_server.c.

error_t ftpServerStart ( FtpServerContext *  context )

Start FTP server.

Parameters:
[in]contextPointer to the FTP server context
Returns:
Error code

Definition at line 199 of file ftp_server.c.

void ftpServerTask ( FtpServerContext *  context )

FTP server task.

Parameters:
[in]contextPointer to the FTP server context

Definition at line 255 of file ftp_server.c.

Generated on Tue Jul 12 2022 17:10:20 by  doxygen 1.7.2