ftp_server_misc.h
Go to the documentation of this file.
1 /**
2  * @file ftp_server_misc.h
3  * @brief Helper functions for FTP server
4  *
5  * @section License
6  *
7  * Copyright (C) 2010-2018 Oryx Embedded SARL. All rights reserved.
8  *
9  * This file is part of CycloneTCP Open.
10  *
11  * This program is free software; you can redistribute it and/or
12  * modify it under the terms of the GNU General Public License
13  * as published by the Free Software Foundation; either version 2
14  * of the License, or (at your option) any later version.
15  *
16  * This program is distributed in the hope that it will be useful,
17  * but WITHOUT ANY WARRANTY; without even the implied warranty of
18  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
19  * GNU General Public License for more details.
20  *
21  * You should have received a copy of the GNU General Public License
22  * along with this program; if not, write to the Free Software Foundation,
23  * Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
24  *
25  * @author Oryx Embedded SARL (www.oryx-embedded.com)
26  * @version 1.9.0
27  **/
28 
29 #ifndef _FTP_SERVER_MISC_H
30 #define _FTP_SERVER_MISC_H
31 
32 //Dependencies
33 #include "ftp/ftp_server.h"
34 
35 //C++ guard
36 #ifdef __cplusplus
37  extern "C" {
38 #endif
39 
40 //FTP server related functions
41 uint16_t ftpServerGetPassivePort(FtpServerContext *context);
42 
44  FtpClientConnection *connection);
45 
48 
50  FtpClientConnection *connection);
51 
54 
56  const char_t *inputPath, char_t *outputPath, size_t maxLen);
57 
59  FtpClientConnection *connection, const char_t *path);
60 
61 const char_t *ftpServerStripRootDir(FtpServerContext *context, const char_t *path);
62 const char_t *ftpServerStripHomeDir(FtpClientConnection *connection, const char_t *path);
63 
64 //C++ guard
65 #ifdef __cplusplus
66  }
67 #endif
68 
69 #endif
uint16_t ftpServerGetPassivePort(FtpServerContext *context)
Get a passive port number.
const char_t * ftpServerStripHomeDir(FtpClientConnection *connection, const char_t *path)
Strip home directory from specified pathname.
char char_t
Definition: compiler_port.h:41
error_t ftpServerOpenDataConnection(FtpServerContext *context, FtpClientConnection *connection)
Open data connection.
error_t ftpServerGetPath(FtpClientConnection *connection, const char_t *inputPath, char_t *outputPath, size_t maxLen)
Retrieve the full pathname.
FTP server context.
Definition: ftp_server.h:321
void ftpServerAcceptDataConnection(FtpClientConnection *connection)
Accept data connection.
void ftpServerCloseControlConnection(FtpClientConnection *connection)
Close control connection.
void ftpServerCloseDataConnection(FtpClientConnection *connection)
Close data connection.
uint_t ftpServerGetFilePermissions(FtpServerContext *context, FtpClientConnection *connection, const char_t *path)
Get permissions for the specified file or directory.
error_t
Error codes.
Definition: error.h:40
unsigned int uint_t
Definition: compiler_port.h:43
const char_t * ftpServerStripRootDir(FtpServerContext *context, const char_t *path)
Strip root dir from specified pathname.
void ftpServerCloseConnection(FtpServerContext *context, FtpClientConnection *connection)
Close client connection properly.
FtpClientConnection * ftpServerAcceptControlConnection(FtpServerContext *context)
Accept control connection.
FTP server (File Transfer Protocol)
FTP client connection.
Definition: ftp_server.h:236