ftp_client_transport.c File Reference

Transport protocol abstraction layer. More...

#include "core/net.h"
#include "ftp/ftp_client.h"
#include "ftp/ftp_client_transport.h"
#include "debug.h"

Go to the source code of this file.

Macros

#define TRACE_LEVEL   FTP_TRACE_LEVEL
 

Functions

error_t ftpClientOpenConnection (FtpClientContext *context, FtpClientSocket *connection, size_t txBufferSize, size_t rxBufferSize)
 Open network connection. More...
 
error_t ftpClientOpenSecureConnection (FtpClientContext *context, FtpClientSocket *connection, size_t txBufferSize, size_t rxBufferSize)
 Open secure connection. More...
 
error_t ftpClientEstablishSecureConnection (FtpClientSocket *connection)
 Establish secure connection. More...
 
error_t ftpClientShutdownConnection (FtpClientSocket *connection)
 Shutdown network connection. More...
 
void ftpClientCloseConnection (FtpClientSocket *connection)
 Close network connection. More...
 
error_t ftpClientSendData (FtpClientSocket *connection, const void *data, size_t length, size_t *written, uint_t flags)
 Send data using the relevant transport protocol. More...
 
error_t ftpClientReceiveData (FtpClientSocket *connection, void *data, size_t size, size_t *received, uint_t flags)
 Receive data using the relevant transport protocol. More...
 

Detailed Description

Transport protocol abstraction layer.

License

Copyright (C) 2010-2018 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.9.0

Definition in file ftp_client_transport.c.

Macro Definition Documentation

◆ TRACE_LEVEL

#define TRACE_LEVEL   FTP_TRACE_LEVEL

Definition at line 30 of file ftp_client_transport.c.

Function Documentation

◆ ftpClientCloseConnection()

void ftpClientCloseConnection ( FtpClientSocket connection)

Close network connection.

Parameters
[in]connectionControl or data connection

Definition at line 229 of file ftp_client_transport.c.

◆ ftpClientEstablishSecureConnection()

error_t ftpClientEstablishSecureConnection ( FtpClientSocket connection)

Establish secure connection.

Parameters
[in]connectionControl or data connection
Returns
Error code

Definition at line 174 of file ftp_client_transport.c.

◆ ftpClientOpenConnection()

error_t ftpClientOpenConnection ( FtpClientContext context,
FtpClientSocket connection,
size_t  txBufferSize,
size_t  rxBufferSize 
)

Open network connection.

Parameters
[in]contextPointer to the FTP client context
[in]connectionControl or data connection
[in]txBufferSizeTX buffer size
[in]rxBufferSizeRX buffer size
Returns
Error code

Definition at line 51 of file ftp_client_transport.c.

◆ ftpClientOpenSecureConnection()

error_t ftpClientOpenSecureConnection ( FtpClientContext context,
FtpClientSocket connection,
size_t  txBufferSize,
size_t  rxBufferSize 
)

Open secure connection.

Parameters
[in]contextPointer to the FTP client context
[in]connectionControl or data connection
[in]txBufferSizeTX buffer size
[in]rxBufferSizeRX buffer size
Returns
Error code

Definition at line 100 of file ftp_client_transport.c.

◆ ftpClientReceiveData()

error_t ftpClientReceiveData ( FtpClientSocket connection,
void *  data,
size_t  size,
size_t *  received,
uint_t  flags 
)

Receive data using the relevant transport protocol.

Parameters
[in]connectionControl or data connection
[out]dataBuffer into which received data will be placed
[in]sizeMaximum number of bytes that can be received
[out]receivedNumber of bytes that have been received
[in]flagsSet of flags that influences the behavior of this function
Returns
Error code

Definition at line 293 of file ftp_client_transport.c.

◆ ftpClientSendData()

error_t ftpClientSendData ( FtpClientSocket connection,
const void *  data,
size_t  length,
size_t *  written,
uint_t  flags 
)

Send data using the relevant transport protocol.

Parameters
[in]connectionControl or data connection
[in]dataPointer to a buffer containing the data to be transmitted
[in]lengthNumber of bytes to be transmitted
[out]writtenActual number of bytes written (optional parameter)
[in]flagsSet of flags that influences the behavior of this function
Returns
Error code

Definition at line 259 of file ftp_client_transport.c.

◆ ftpClientShutdownConnection()

error_t ftpClientShutdownConnection ( FtpClientSocket connection)

Shutdown network connection.

Parameters
[in]connectionControl or data connection
Returns
Error code

Definition at line 192 of file ftp_client_transport.c.