ftp_client_misc.h
Go to the documentation of this file.
1 /**
2  * @file ftp_client_misc.h
3  * @brief Helper functions for FTP client
4  *
5  * @section License
6  *
7  * SPDX-License-Identifier: GPL-2.0-or-later
8  *
9  * Copyright (C) 2010-2019 Oryx Embedded SARL. All rights reserved.
10  *
11  * This file is part of CycloneTCP Open.
12  *
13  * This program is free software; you can redistribute it and/or
14  * modify it under the terms of the GNU General Public License
15  * as published by the Free Software Foundation; either version 2
16  * of the License, or (at your option) any later version.
17  *
18  * This program is distributed in the hope that it will be useful,
19  * but WITHOUT ANY WARRANTY; without even the implied warranty of
20  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
21  * GNU General Public License for more details.
22  *
23  * You should have received a copy of the GNU General Public License
24  * along with this program; if not, write to the Free Software Foundation,
25  * Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
26  *
27  * @author Oryx Embedded SARL (www.oryx-embedded.com)
28  * @version 1.9.6
29  **/
30 
31 #ifndef _FTP_CLIENT_MISC_H
32 #define _FTP_CLIENT_MISC_H
33 
34 //Dependencies
35 #include "core/net.h"
36 #include "ftp_client.h"
37 
38 //C++ guard
39 #ifdef __cplusplus
40 extern "C" {
41 #endif
42 
43 //FTP client related functions
45 
47 
49  const char_t *command, const char_t *argument);
50 
52  const IpAddr *ipAddr, uint16_t port);
53 
56 
58  size_t maxLen);
59 
61 
64 
66 
67 //C++ guard
68 #ifdef __cplusplus
69 }
70 #endif
71 
72 #endif
int bool_t
Definition: compiler_port.h:49
IP network address.
Definition: ip.h:71
void ftpClientChangeState(FtpClientContext *context, FtpClientState newState)
Update FTP client state.
FtpClientState
FTP client states.
Definition: ftp_client.h:188
error_t ftpClientCheckTimeout(FtpClientContext *context)
Determine whether a timeout error has occurred.
error_t
Error codes.
Definition: error.h:42
error_t ftpClientFormatPasvCommand(FtpClientContext *context)
Format PASV or EPSV command.
error_t ftpClientFormatPortCommand(FtpClientContext *context, const IpAddr *ipAddr, uint16_t port)
Format PORT or EPRT command.
error_t ftpClientFormatCommand(FtpClientContext *context, const char_t *command, const char_t *argument)
Format FTP command.
uint16_t port
Definition: dns_common.h:223
FTP client (File Transfer Protocol)
char char_t
Definition: compiler_port.h:43
error_t ftpClientParsePwdReply(FtpClientContext *context, char_t *path, size_t maxLen)
Parse PWD response.
#define FtpClientContext
Definition: ftp_client.h:123
error_t ftpClientParsePasvReply(FtpClientContext *context, uint16_t *port)
Parse PASV or EPSV response.
error_t ftpClientInitDataTransfer(FtpClientContext *context, bool_t direction)
Initiate data transfer.
Directory entry.
Definition: ftp_client.h:268
TCP/IP stack core.
uint8_t ipAddr[4]
Definition: mib_common.h:187
error_t ftpClientParseDirEntry(char_t *line, FtpDirEntry *dirEntry)
Parse directory entry.
error_t ftpClientTerminateDataTransfer(FtpClientContext *context)
Terminate data transfer.
error_t ftpClientSendCommand(FtpClientContext *context)
Send FTP command and wait for a reply.