Difference between revisions of "TFtpServer"
Jump to navigation
Jump to search
(→Events) |
|||
| (3 intermediate revisions by 2 users not shown) | |||
| Line 2: | Line 2: | ||
== Overview == | == Overview == | ||
| − | *'''unit''' | + | *'''unit''' [[OverbyteIcsFtpSrv.pas]] |
| − | *'''inheritance''' TFtpServer | + | *'''inheritance''' TIcsWndControl -> TFtpServer |
TFtpServer component is implementing the server side FTP protocol described in RFC [http://rfc.net/rfc959.html 959]. FTP protocol is the standard protocol for transfering files. | TFtpServer component is implementing the server side FTP protocol described in RFC [http://rfc.net/rfc959.html 959]. FTP protocol is the standard protocol for transfering files. | ||
| Line 18: | Line 18: | ||
| valign="top" | [[TFtpServer.UserData | UserData]] |||| Data passed to each client instance. | | valign="top" | [[TFtpServer.UserData | UserData]] |||| Data passed to each client instance. | ||
|- | |- | ||
| − | | valign="top" | [[TFtpServer. | + | | valign="top" | [[TFtpServer.MaxClients | MaxClients]] |||| Maximum number of simultaneous clients to be accepted. |
|- | |- | ||
| valign="top" | [[TFtpServer.PasvIpAddr | PasvIpAddr]] |||| IP address used for passive mode. | | valign="top" | [[TFtpServer.PasvIpAddr | PasvIpAddr]] |||| IP address used for passive mode. | ||
| Line 28: | Line 28: | ||
| valign="top" | [[TFtpServer.Options | Options]] |||| Options set to change component behaviour. | | valign="top" | [[TFtpServer.Options | Options]] |||| Options set to change component behaviour. | ||
|- | |- | ||
| − | | valign="top" | [[TFtpClient.ClientCount | ClientCount]] |||| | + | | valign="top" | [[TFtpClient.ClientCount | ClientCount]] |||| Current number of connected clients. Runtime only. |
|- | |- | ||
| valign="top" | [[TFtpClient.Client | Client]] |||| Array of connected clients. Runtime only. | | valign="top" | [[TFtpClient.Client | Client]] |||| Array of connected clients. Runtime only. | ||
| Line 34: | Line 34: | ||
| valign="top" | [[TFtpClient.Active | Active]] |||| Set/Get server state. Runtime only. | | valign="top" | [[TFtpClient.Active | Active]] |||| Set/Get server state. Runtime only. | ||
|- | |- | ||
| − | | valign="top" | [[TFtpClient.Handle | Handle]] |||| Handle for | + | | valign="top" | [[TFtpClient.Handle | Handle]] |||| Handle for underlying hidden window. Runtime only. |
|- | |- | ||
| − | | valign="top" | [[TFtpClient.ServSocket | ServSocket]] |||| | + | | valign="top" | [[TFtpClient.ServSocket | ServSocket]] |||| Underlying listening socket. Runtime only. |
|} | |} | ||
| Line 59: | Line 59: | ||
|- | |- | ||
| valign="top" | [[TFtpServer.OnStop | OnStop]] |||| OnStop. | | valign="top" | [[TFtpServer.OnStop | OnStop]] |||| OnStop. | ||
| + | |- | ||
| + | | valign="top" | [[TFtpServer.OnClientConnect | OnClientConnect]] |||| OnClientConnect. | ||
|- | |- | ||
| valign="top" | [[TFtpServer.OnAuthenticate | OnAuthenticate]] |||| OnAuthenticate. | | valign="top" | [[TFtpServer.OnAuthenticate | OnAuthenticate]] |||| OnAuthenticate. | ||
|- | |- | ||
| valign="top" | [[TFtpServer.OnClientDisconnect | OnClientDisconnect]] |||| OnClientDisconnect. | | valign="top" | [[TFtpServer.OnClientDisconnect | OnClientDisconnect]] |||| OnClientDisconnect. | ||
| − | |||
| − | |||
|- | |- | ||
| valign="top" | [[TFtpServer.OnClientCommand | OnClientCommand]] |||| OnClientCommand. | | valign="top" | [[TFtpServer.OnClientCommand | OnClientCommand]] |||| OnClientCommand. | ||
| Line 79: | Line 79: | ||
|- | |- | ||
| valign="top" | [[TFtpServer.OnStorSessionConnected | OnStorSessionConnected]] |||| OnStorSessionConnected. | | valign="top" | [[TFtpServer.OnStorSessionConnected | OnStorSessionConnected]] |||| OnStorSessionConnected. | ||
| + | |- | ||
| + | | valign="top" | [[TFtpServer.OnStorSessionClosed | OnStorSessionClosed]] |||| OnStorSessionClosed. | ||
|- | |- | ||
| valign="top" | [[TFtpServer.OnRetrSessionConnected | OnRetrSessionConnected]] |||| OnRetrSessionConnected. | | valign="top" | [[TFtpServer.OnRetrSessionConnected | OnRetrSessionConnected]] |||| OnRetrSessionConnected. | ||
| Line 102: | Line 104: | ||
| valign="top" | [[TFtpServer.OnStorDataAvailable | OnStorDataAvailable]] |||| OnStorDataAvailable. | | valign="top" | [[TFtpServer.OnStorDataAvailable | OnStorDataAvailable]] |||| OnStorDataAvailable. | ||
|- | |- | ||
| − | | valign="top" | [[TFtpServer.OnGetUniqueFileName | OnGetUniqueFileName]] |||| OnGetUniqueFileName. | + | | valign="top" | [[TFtpServer.OnGetUniqueFileName | OnGetUniqueFileName]] |||| OnGetUniqueFileName (STOU). |
|- | |- | ||
| valign="top" | [[TFtpServer.OnGetProcessing | OnGetProcessing]] |||| OnGetProcessing. | | valign="top" | [[TFtpServer.OnGetProcessing | OnGetProcessing]] |||| OnGetProcessing. | ||
| Line 108: | Line 110: | ||
| valign="top" | [[TFtpServer.OnBuildFilePath | OnBuildFilePath]] |||| OnBuildFilePath. | | valign="top" | [[TFtpServer.OnBuildFilePath | OnBuildFilePath]] |||| OnBuildFilePath. | ||
|- | |- | ||
| − | | valign="top" | [[TFtpServer.OnValidateMfmt | OnValidateMfmt]] |||| OnValidateMfmt. | + | | valign="top" | [[TFtpServer.OnValidateMfmt | OnValidateMfmt]] |||| OnValidateMfmt (MFMT - modify file modification time). |
|- | |- | ||
| valign="top" | [[TFtpServer.OnCalculateMd5 | OnCalculateMd5]] |||| OnCalculateMd5. | | valign="top" | [[TFtpServer.OnCalculateMd5 | OnCalculateMd5]] |||| OnCalculateMd5. | ||
Latest revision as of 20:18, 17 January 2016
Main page -> ICS components reference -> TFtpServer
Contents
Overview
- unit OverbyteIcsFtpSrv.pas
- inheritance TIcsWndControl -> TFtpServer
TFtpServer component is implementing the server side FTP protocol described in RFC 959. FTP protocol is the standard protocol for transfering files.
Properties
| Addr | IP address of the interface to listen on. Use 0.0.0.0 to listen on all interfaces. | |
| Port | TCP port to listen to. | |
| Banner | Welcome message sent to client. | |
| UserData | Data passed to each client instance. | |
| MaxClients | Maximum number of simultaneous clients to be accepted. | |
| PasvIpAddr | IP address used for passive mode. | |
| PasvPortRangeStart | TCP port range start to be used for passive mode. | |
| PasvPortRangeSize | TCP port range size to be used for passive mode. | |
| Options | Options set to change component behaviour. | |
| ClientCount | Current number of connected clients. Runtime only. | |
| Client | Array of connected clients. Runtime only. | |
| Active | Set/Get server state. Runtime only. | |
| Handle | Handle for underlying hidden window. Runtime only. | |
| ServSocket | Underlying listening socket. Runtime only. |
Methods
| Start | Make the server listening for clients. | |
| Stop | Make the server stop listening for client. Doesn't disconnect connected clients. | |
| Disconnect | Disconnect a single client. | |
| DisconnectAll | Disconnect all clients. | |
| IsClient | Check if an object is actual a client. |
Events
| OnStart | OnStart. | |
| OnStop | OnStop. | |
| OnClientConnect | OnClientConnect. | |
| OnAuthenticate | OnAuthenticate. | |
| OnClientDisconnect | OnClientDisconnect. | |
| OnClientCommand | OnClientCommand. | |
| OnAnswerToClient | OnAnswerToClient. | |
| OnChangeDirectory | OnChangeDirectory. | |
| OnMakeDirectory | OnMakeDirectory. | |
| OnBuildDirectory | OnBuildDirectory. | |
| OnAlterDirectory | OnAlterDirectory. | |
| OnStorSessionConnected | OnStorSessionConnected. | |
| OnStorSessionClosed | OnStorSessionClosed. | |
| OnRetrSessionConnected | OnRetrSessionConnected. | |
| OnRetrSessionClosed | OnRetrSessionClosed. | |
| OnRetrDataSent | OnRetrDataSent. | |
| OnValidatePut | OnValidatePut. | |
| OnValidateSize | OnValidateSize. | |
| OnValidateDele | OnValidateDele. | |
| OnValidateRmd | OnValidateRmd. | |
| OnValidateRnfr | OnValidateRnFr. | |
| OnValidateRnTo | OnValidateRnTo. | |
| OnValidateGet | OnValidateGet. | |
| OnStorDataAvailable | OnStorDataAvailable. | |
| OnGetUniqueFileName | OnGetUniqueFileName (STOU). | |
| OnGetProcessing | OnGetProcessing. | |
| OnBuildFilePath | OnBuildFilePath. | |
| OnValidateMfmt | OnValidateMfmt (MFMT - modify file modification time). | |
| OnCalculateMd5 | OnCalculateMd5. |
