LumiSoft Net Help
FTP_Client Class
NamespacesLumiSoft.Net.FTP.ClientFTP_Client
This class implements FTP client. Defined in RFC 959.
Declaration Syntax
C#Visual BasicVisual C++F#
public class FTP_Client : TCP_Client
Public Class FTP_Client
	Inherits TCP_Client
public ref class FTP_Client : public TCP_Client
type FTP_Client =  
    class
        inherit TCP_Client
    end
Members
All MembersConstructorsMethodsProperties



IconMemberDescription
FTP_Client()()()()
Default connection.

Abort()()()()
Aborts an active file transfer.

AppendToFile(String, Stream)
Appends specified data to the existing file. If existing file doesn't exist, it will be created.

Authenticate(String, String)
Authenticates user. Authenticate method chooses strongest possible authentication method supported by server.

AuthenticatedUserIdentity
Gets session authenticated user identity, returns null if not authenticated.
(Overrides TCP_Session.AuthenticatedUserIdentity.)
BeginConnect(String, Int32, AsyncCallback, Object) Obsolete.
Starts connection to the specified host.
(Inherited from TCP_Client.)
BeginConnect(String, Int32, Boolean, AsyncCallback, Object) Obsolete.
Starts connection to the specified host.
(Inherited from TCP_Client.)
BeginConnect(IPEndPoint, Boolean, AsyncCallback, Object) Obsolete.
Starts connection to the specified remote end point.
(Inherited from TCP_Client.)
BeginConnect(IPEndPoint, IPEndPoint, Boolean, AsyncCallback, Object) Obsolete.
Starts connection to the specified remote end point.
(Inherited from TCP_Client.)
BeginDisconnect(AsyncCallback, Object)
Starts disconnecting connection.
(Inherited from TCP_Client.)
Connect(String, Int32)
Connects to the specified host. If the hostname resolves to more than one IP address, all IP addresses will be tried for connection, until one of them connects.
(Inherited from TCP_Client.)
Connect(String, Int32, Boolean)
Connects to the specified host. If the hostname resolves to more than one IP address, all IP addresses will be tried for connection, until one of them connects.
(Inherited from TCP_Client.)
Connect(IPEndPoint, Boolean)
Connects to the specified remote end point.
(Inherited from TCP_Client.)
Connect(IPEndPoint, IPEndPoint, Boolean)
Connects to the specified remote end point.
(Inherited from TCP_Client.)
Connect(IPEndPoint, IPEndPoint, Boolean, RemoteCertificateValidationCallback)
Connects to the specified remote end point.
(Inherited from TCP_Client.)
ConnectAsync(TCP_Client..::..ConnectAsyncOP)
Starts connecting to remote end point.
(Inherited from TCP_Client.)
ConnectTime
Gets the time when session was connected.
(Inherited from TCP_Client.)
CreateDirectory(String)
Creates a directory on the FTP server.

DataIP
Gets or sets local IP address to use for data connection. Value null means that system will allocate it.

DataPortRange
Gets or sets ports what data connection may use. Value null means that system will allocate it.

DeleteDirectory(String)
Deletes specified directory from FTP server.

DeleteFile(String)
Deletes specified file from ftp server.

Disconnect()()()()
Closes connection to FTP server.
(Overrides TCP_Client.Disconnect()()()().)
Dispose()()()()
Clean up any resources being used. This method is thread-safe.
(Overrides TCP_Client.Dispose()()()().)
EndConnect(IAsyncResult) Obsolete.
Ends a pending asynchronous connection request.
(Inherited from TCP_Client.)
EndDisconnect(IAsyncResult)
Ends a pending asynchronous disconnect request.
(Inherited from TCP_Client.)
Equals(Object)
Determines whether the specified Object is equal to the current Object.
(Inherited from Object.)
ExtenededCapabilities
Gets FTP exteneded capabilities supported by FTP server.

Finalize()()()()
Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection.
(Inherited from Object.)
GetCurrentDir()()()()
Gets current working directory in the sFTP server.

GetFile(String, String)
Gets specified file from FTP server.

GetFile(String, Stream)
Gets specified file from FTP server.

GetHashCode()()()()
Serves as a hash function for a particular type.
(Inherited from Object.)
GetList()()()()
Gets files and directories in the current server directory.

GetList(String)
Gets files and directories in the current server directory.

GetType()()()()
Gets the Type of the current instance.
(Inherited from Object.)
GreetingText
Gets greeting text which was sent by FTP server.

ID
Gets session ID.
(Inherited from TCP_Client.)
IsAuthenticated
Gets if this session is authenticated.
(Inherited from TCP_Session.)
IsConnected
Gets if TCP client is connected.
(Inherited from TCP_Client.)
IsDisposed
Gets if this object is disposed.
(Inherited from TCP_Client.)
IsSecureConnection
Gets if this session TCP connection is secure connection.
(Inherited from TCP_Client.)
LastActivity
Gets the last time when data was sent or received.
(Inherited from TCP_Client.)
LocalEndPoint
Gets session local IP end point.
(Inherited from TCP_Client.)
LogAddException(String, Exception)
Logs exception.
(Inherited from TCP_Client.)
LogAddRead(Int64, String)
Logs read operation.
(Inherited from TCP_Client.)
LogAddText(String)
Logs free text entry.
(Inherited from TCP_Client.)
LogAddWrite(Int64, String)
Logs write operation.
(Inherited from TCP_Client.)
Logger
Gets or sets TCP client logger. Value null means no logging.
(Inherited from TCP_Client.)
MemberwiseClone()()()()
Creates a shallow copy of the current Object.
(Inherited from Object.)
Noop()()()()
Send NOOP command to server. This method can be used for keeping connection alive(not timing out).

OnConnected()()()()
This method is called after TCP client has sucessfully connected.
(Overrides TCP_Client.OnConnected()()()().)
OnConnected(TCP_Client..::..CompleteConnectCallback)
This method is called when TCP client has sucessfully connected.
(Inherited from TCP_Client.)
OnError(Exception) Obsolete.
This must be called when unexpected error happens. When inheriting TCP_Client class, be sure that you call OnError method for each unexpected error.
(Inherited from TCP_Client.)
ReadLine()()()()
Reads and logs specified line from connected host.
(Inherited from TCP_Client.)
Reinitialize()()()()
Terminates the user and flushes all state information on the server. The connection is left open.

RemoteEndPoint
Gets session remote IP end point.
(Inherited from TCP_Client.)
Rename(String, String)
Renames file or directory to the new specified name.

SetCurrentDir(String)
Changes the current working directory on the server.

StoreFile(String, String)
Stores specified file to FTP server.

StoreFile(String, Stream)
Stores specified file to FTP server.

SwitchToSecure()()()()
Switches session to secure connection.
(Inherited from TCP_Client.)
SwitchToSecureAsync(TCP_Client..::..SwitchToSecureAsyncOP)
Starts switching connection to secure.
(Inherited from TCP_Client.)
TcpStream
Gets TCP stream which must be used to send/receive data through this session.
(Inherited from TCP_Client.)
Timeout
Gets or sets default TCP read/write timeout.
(Inherited from TCP_Client.)
ToString()()()()
Returns a string that represents the current object.
(Inherited from Object.)
TransferMode
Gets or sets data connection establish mode.

ValidateCertificateCallback
Gets or stes remote callback which is called when remote server certificate needs to be validated. Value null means not sepcified.
(Inherited from TCP_Client.)
WriteLine(String)
Sends and logs specified line to connected host.
(Inherited from TCP_Client.)
Inheritance Hierarchy

Assembly: LumiSoft.Net (Module: LumiSoft.Net.dll) Version: 4.5.5510.19119