FTP server context. More...
#include <ftp_server.h>
Data Fields | |
| NetInterface * | interface |
| Underlying network interface. More... | |
| uint16_t | port |
| FTP command port number. More... | |
| uint16_t | dataPort |
| FTP data port number. More... | |
| uint16_t | passivePortMin |
| Passive port range (lower value) More... | |
| uint16_t | passivePortMax |
| Passive port range (upper value) More... | |
| Ipv4Addr | publicIpv4Addr |
| Public IPv4 address to be used in PASV replies. More... | |
| uint_t | mode |
| Security modes. More... | |
| uint_t | maxConnections |
| Maximum number of client connections. More... | |
| FtpClientConnection * | connections |
| Client connections. More... | |
| char_t | rootDir [FTP_SERVER_MAX_ROOT_DIR_LEN+1] |
| Root directory. More... | |
| FtpServerConnectCallback | connectCallback |
| Connection callback function. More... | |
| FtpServerDisconnectCallback | disconnectCallback |
| Disconnection callback function. More... | |
| FtpServerTlsInitCallback | tlsInitCallback |
| TLS initialization callback function. More... | |
| FtpServerCheckUserCallback | checkUserCallback |
| User verification callback function. More... | |
| FtpServerCheckPasswordCallback | checkPasswordCallback |
| Password verification callback function. More... | |
| FtpServerGetFilePermCallback | getFilePermCallback |
| Callback used to retrieve file permissions. More... | |
| FtpServerUnknownCommandCallback | unknownCommandCallback |
| Unknown command callback function. More... | |
| bool_t | running |
| Operational state of the FTP server. More... | |
| bool_t | stop |
| Stop request. More... | |
| OsEvent | event |
| Event object used to poll the sockets. More... | |
| OsTaskParameters | taskParams |
| Task parameters. More... | |
| OsTaskId | taskId |
| Task identifier. More... | |
| Socket * | socket |
| Listening socket. More... | |
| uint16_t | passivePort |
| Current passive port number. More... | |
| SocketEventDesc | eventDesc [2 *FTP_SERVER_MAX_CONNECTIONS+1] |
| The events the application is interested in. More... | |
| TlsTicketContext | tlsTicketContext |
| TLS ticket encryption context. More... | |
Detailed Description
FTP server context.
Definition at line 418 of file ftp_server.h.
Field Documentation
◆ checkPasswordCallback
| FtpServerCheckPasswordCallback checkPasswordCallback |
Password verification callback function.
Definition at line 436 of file ftp_server.h.
◆ checkUserCallback
| FtpServerCheckUserCallback checkUserCallback |
User verification callback function.
Definition at line 435 of file ftp_server.h.
◆ connectCallback
| FtpServerConnectCallback connectCallback |
Connection callback function.
Definition at line 430 of file ftp_server.h.
◆ connections
| FtpClientConnection* connections |
Client connections.
Definition at line 428 of file ftp_server.h.
◆ dataPort
| uint16_t dataPort |
FTP data port number.
Definition at line 422 of file ftp_server.h.
◆ disconnectCallback
| FtpServerDisconnectCallback disconnectCallback |
Disconnection callback function.
Definition at line 431 of file ftp_server.h.
◆ event
| OsEvent event |
Event object used to poll the sockets.
Definition at line 441 of file ftp_server.h.
◆ eventDesc
| SocketEventDesc eventDesc[2 *FTP_SERVER_MAX_CONNECTIONS+1] |
The events the application is interested in.
Definition at line 446 of file ftp_server.h.
◆ getFilePermCallback
| FtpServerGetFilePermCallback getFilePermCallback |
Callback used to retrieve file permissions.
Definition at line 437 of file ftp_server.h.
◆ interface
| NetInterface* interface |
Underlying network interface.
Definition at line 420 of file ftp_server.h.
◆ maxConnections
| uint_t maxConnections |
Maximum number of client connections.
Definition at line 427 of file ftp_server.h.
◆ mode
| uint_t mode |
Security modes.
Definition at line 426 of file ftp_server.h.
◆ passivePort
| uint16_t passivePort |
Current passive port number.
Definition at line 445 of file ftp_server.h.
◆ passivePortMax
| uint16_t passivePortMax |
Passive port range (upper value)
Definition at line 424 of file ftp_server.h.
◆ passivePortMin
| uint16_t passivePortMin |
Passive port range (lower value)
Definition at line 423 of file ftp_server.h.
◆ port
| uint16_t port |
FTP command port number.
Definition at line 421 of file ftp_server.h.
◆ publicIpv4Addr
| Ipv4Addr publicIpv4Addr |
Public IPv4 address to be used in PASV replies.
Definition at line 425 of file ftp_server.h.
◆ rootDir
| char_t rootDir[FTP_SERVER_MAX_ROOT_DIR_LEN+1] |
Root directory.
Definition at line 429 of file ftp_server.h.
◆ running
| bool_t running |
Operational state of the FTP server.
Definition at line 439 of file ftp_server.h.
◆ socket
| Socket* socket |
Listening socket.
Definition at line 444 of file ftp_server.h.
◆ stop
| bool_t stop |
Stop request.
Definition at line 440 of file ftp_server.h.
◆ taskId
| OsTaskId taskId |
Task identifier.
Definition at line 443 of file ftp_server.h.
◆ taskParams
| OsTaskParameters taskParams |
Task parameters.
Definition at line 442 of file ftp_server.h.
◆ tlsInitCallback
| FtpServerTlsInitCallback tlsInitCallback |
TLS initialization callback function.
Definition at line 433 of file ftp_server.h.
◆ tlsTicketContext
| TlsTicketContext tlsTicketContext |
TLS ticket encryption context.
Definition at line 448 of file ftp_server.h.
◆ unknownCommandCallback
| FtpServerUnknownCommandCallback unknownCommandCallback |
Unknown command callback function.
Definition at line 438 of file ftp_server.h.
The documentation for this struct was generated from the following file:
- cyclone_tcp/ftp/ftp_server.h