Jump to main content

##

# TCPIP_FTP_MODULE_CONFIG Structure

## C

    typedef struct {
        uint16_t cmdPort;
        uint16_t dataPort;
        uint16_t nConnections;
        uint16_t dataSktTxBuffSize;
        uint16_t dataSktRxBuffSize;
        const char* mountPath;
        char * userName;
        char * password;
    } TCPIP_FTP_MODULE_CONFIG;

## Description

Structure: TCPIP_FTP_MODULE_CONFIG.

FTP server configuration and initialization data. Configuration is part of tcpip_stack_init.c.

## Members

Members | Description
--- | ---
cmdPort | FTP listening command port: TCPIP_FTP_COMMAND_PORT (21, 990, etc.).
dataPort | FTP listening data port: TCPIP_FTP_DATA_PORT (20, 989) etc.
nConnections | Number of simultaneous FTP connections allowed.
dataSkTxBuffSize | Size of data socket TX buffer for the associated socket. Leave 0 for default.
dataSktRxBuffSize | Size of data socket RX buffer for the associated socket. Leave 0 for default. The FTP server will access files located under this top directory. No access is possible above this directory. As a good practive to follow, use something like: "/mnt_point/ftp/" to limit an external user access to this only directory in the file system when accessing files.
userName | FTP login user name. Size should not exceed more than TCPIP_FTP_USER_NAME_LEN.
password | FTP login password. Size should not exceed more than TCPIP_FTP_PASSWD_LEN.

## Remarks

The obsolete authentication members will be eventually removed from the FTP server module configuration data. New projects should use the run time authentication.