ftp_client_transport.h
Go to the documentation of this file.
1 /**
2  * @file ftp_client_transport.h
3  * @brief Transport protocol abstraction layer
4  *
5  * @section License
6  *
7  * SPDX-License-Identifier: GPL-2.0-or-later
8  *
9  * Copyright (C) 2010-2020 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.8
29  **/
30 
31 #ifndef _FTP_CLIENT_TRANSPORT_H
32 #define _FTP_CLIENT_TRANSPORT_H
33 
34 //Dependencies
35 #include "core/net.h"
36 #include "ftp/ftp_client.h"
37 
38 //C++ guard
39 #ifdef __cplusplus
40 extern "C" {
41 #endif
42 
43 //FTP client related functions
45  FtpClientChannel *channel, size_t txBufferSize, size_t rxBufferSize);
46 
48  FtpClientChannel *channel, size_t txBufferSize, size_t rxBufferSize);
49 
51 
53 
55 
57  size_t length, size_t *written, uint_t flags);
58 
60  size_t size, size_t *received, uint_t flags);
61 
62 //C++ guard
63 #ifdef __cplusplus
64 }
65 #endif
66 
67 #endif
uint8_t length
Definition: coap_common.h:190
Control or data channel.
Definition: ftp_client.h:228
uint8_t data[]
Definition: ethernet.h:209
error_t ftpClientOpenSecureChannel(FtpClientContext *context, FtpClientChannel *channel, size_t txBufferSize, size_t rxBufferSize)
Open secure connection.
error_t
Error codes.
Definition: error.h:42
error_t ftpClientWriteChannel(FtpClientChannel *channel, const void *data, size_t length, size_t *written, uint_t flags)
Send data using the relevant transport protocol.
error_t ftpClientReadChannel(FtpClientChannel *channel, void *data, size_t size, size_t *received, uint_t flags)
Receive data using the relevant transport protocol.
void ftpClientCloseChannel(FtpClientChannel *channel)
Close network connection.
uint8_t flags
Definition: tcp.h:314
FTP client (File Transfer Protocol)
error_t ftpClientShutdownChannel(FtpClientChannel *channel)
Shutdown network connection.
#define FtpClientContext
Definition: ftp_client.h:123
unsigned int uint_t
Definition: compiler_port.h:45
TCP/IP stack core.
error_t ftpClientEstablishSecureChannel(FtpClientChannel *channel)
Establish secure connection.
error_t ftpClientOpenChannel(FtpClientContext *context, FtpClientChannel *channel, size_t txBufferSize, size_t rxBufferSize)
Open network connection.