IPWorks SFTP 2020 Delphi Edition

Questions / Feedback?

SFTPConnection Type

A currently connected client.

Remarks

This type describes the connection of a client which is currently connected to the component. You may use the different fields of this type to manage the connection.

Fields

Connected
Boolean

Used to disconnect individual connections and/or show their status.

The Connected is used to close connections.

Connected also shows the status of a particular connection (connected/disconnected).

How and when the connection is closed is controlled by the Linger property. Please refer to its description for more information.

ConnectionId
String

An id generated by the component to identify each connection. This id is unique to this connection.

ErrorMessage
String

ErrorMessage is used together with status codes returned from events to send informative errors back to the SFTP client through the SSH_FXP_STATUS message. If left blank, the component will set a default message based on the returned status code.

FileData
String

The FileData should be set or read when processing read/write file events.

FileDataB
TBytes

The FileData should be set or read when processing read/write file events.

LocalAddress
String

This property shows the IP address of the interface through which the connection is passing.

LocalAddress is important for multihomed hosts where it can be used to find which particular network interface an individual connection is going through.

ProtocolVersion
Integer

The ProtocolVersion shows the SFTP protocol version negotiated with the client when the SFTP connection was established.

RemoteHost
String

The RemoteHost shows the IP address of the remote host through which the connection is coming.

The connection must be valid or an error will be fired.

If the component is configured to use a SOCKS firewall, the value assigned to this property may be preceded with an "*". If this is the case, the host name is passed to the firewall unresolved and the firewall performs the DNS resolution.

RemotePort
Integer

The RemotePort shows the TCP port on the remote host through which the connection is coming.

The connection must be valid or an error will be fired.

Timeout
Integer

A timeout for the component.

If the Timeout property is set to 0, all operations return immediately, potentially failing with an 'WOULDBLOCK' error if data can't be sent or received immediately.

If Timeout is set to a positive value, the component will automatically retry each operation that would otherwise result in a 'WOULDBLOCK' error for a maximum of Timeout seconds.

The component will use DoEvents to enter an efficient wait loop during any potential waiting period, making sure that all system events are processed immediately as they arrive. This ensures that the host application does not "freeze" and remains responsive.

If Timeout expires, and the operation is not yet complete, the component raises an exception.

Please note that by default, all timeouts are inactivity timeouts, i.e. the timeout period is extended by Timeout seconds when any amount of data is successfully sent or received.

The default value for the Timeout property is 0 (asynchronous operation).

Constructors

constructor Create();

Copyright (c) 2022 /n software inc. - All rights reserved.
IPWorks SFTP 2020 Delphi Edition - Version 20.0 [Build 8263]