Rebex SFTP for .NET

Sftp Members

Sftp overview

Public Static Fields

DefaultPort Default SFTP port (22).

Public Static Properties

Version Gets the version of the SFTP component.

Public Instance Constructors

Sftp Constructor Initializes a new instance of the Sftp class.

Public Instance Properties

Fingerprint Gets the server public key fingerprint.
LocalEndPoint Gets the local client EndPoint.
Proxy Gets or sets the network proxy to use to access a remote server.
RemoteEndPoint Gets the remote server EndPoint.
Session Gets the SSH session used by this SFTP session.
State Gets the current state of the Sftp object.
Timeout Gets or sets the length of time before the operation times out.

Public Instance Methods

AbortTransferOverloaded. Aborts pending transfers (either file transfer or directory listing) identified by the specified user-provided state object.
BeginConnectOverloaded. Begins an asynchronous Connect operation. Connects to the SFTP server.
BeginCreateDirectory Begins an asynchronous CreateDirectory operation. Creates a directory on the server.
BeginDeleteFile Begins an asynchronous DeleteFile operation. Deletes a file on the server.
BeginDisconnect Begins an asynchronous Disconnect operation. Informs the server that the connection is about to close and terminates the connection.
BeginGetFileOverloaded. Begins an asynchronous GetFile operation. Downloads the specified part of the remote file to the data stream.
BeginGetFileDateTime Begins an asynchronous GetFileDateTime operation. Retrieves the modification date and time of the specified remote file.
BeginGetFileLength Begins an asynchronous GetFileLength operation. Retrieves the size of the specified remote file.
BeginGetInfo Begins an asynchronous GetInfo operation. Retrieves a SftpItem containing the information about the specified remote file or directory.
BeginGetList Begins an asynchronous GetList operation. Retrieves the list of files and directories in the specified remote directory.
BeginGetNameList Begins an asynchronous GetNameList operation. Retrieves the list of file and directory names in the specified remote directory.
BeginGetRawList Begins an asynchronous GetRawList operation. Retrieves the list of files and directories in the specified remote directory using a raw text format.
BeginChangeDirectory Begins an asynchronous ChangeDirectory operation. Changes the current working directory on the server.
BeginLoginOverloaded. Begins an asynchronous Login operation. Authenticates the user to the server and initializes the SFTP session.
BeginPutFileOverloaded. Begins an asynchronous PutFile operation. Uploads the content of the data stream to the specified offset of the file on the server.
BeginRemoveDirectory Begins an asynchronous RemoveDirectory operation. Deletes an empty remote directory with the specified pathname.
BeginRename Begins an asynchronous Rename operation. Renames a file or directory on the server.
BeginResolveSymlink Begins an asynchronous ResolveSymlink operation. Resolves the symlink and returns the real path.
BeginSetAttributes Begins an asynchronous SetAttributes operation. Sets the attributes of the remote file.
ConnectOverloaded. Connects to the SFTP server.
CreateDirectory Creates a directory on the server.
DeleteFile Deletes a file on the server.
Disconnect Informs the server that the connection is about to close and terminates the connection.
DisposeOverloaded. Disposes the Sftp object and all the socket objects.
EndConnect Ends a pending asynchronous Connect operation.
EndCreateDirectory Ends a pending asynchronous CreateDirectory operation.
EndDeleteFile Ends a pending asynchronous DeleteFile operation.
EndDisconnect Ends a pending asynchronous Disconnect operation.
EndGetFile Ends a pending asynchronous GetFile operation.
EndGetFileDateTime Ends a pending asynchronous GetFileDateTime operation.
EndGetFileLength Ends a pending asynchronous GetFileLength operation.
EndGetInfo Ends a pending asynchronous GetInfo operation.
EndGetList Ends a pending asynchronous GetList operation.
EndGetNameList Ends a pending asynchronous GetNameList operation.
EndGetRawList Ends a pending asynchronous GetRawList operation.
EndChangeDirectory Ends a pending asynchronous ChangeDirectory operation.
EndLogin Ends a pending asynchronous Login operation.
EndPutFile Ends a pending asynchronous PutFile operation.
EndRemoveDirectory Ends a pending asynchronous RemoveDirectory operation.
EndRename Ends a pending asynchronous Rename operation.
EndResolveSymlink Ends a pending asynchronous GetInfo operation.
EndSetAttributes Ends a pending asynchronous SetAttributes operation.
Equals (inherited from Object)Determines whether the specified Object is equal to the current Object.
GetConnectionState Checks whether the SFTP session is still connected and returns its state.
GetCurrentDirectory Gets the absolute path of the current working directory on the remote server.
GetFileOverloaded. Downloads the remote file to the data stream.
GetFileDateTime Retrieves the modification date and time of the specified remote file.
GetFileLength Retrieves the size of the specified remote file.
GetHashCode (inherited from Object)Serves as a hash function for a particular type. GetHashCode is suitable for use in hashing algorithms and data structures like a hash table.
GetInfoOverloaded. Retrieves a SftpItem containing the information about the specified remote file or directory.
GetListOverloaded. Retrieves the list of files and directories in the current remote directory.
GetNameListOverloaded. Retrieves the list of file and directory names in the current remote directory.
GetRawListOverloaded. Retrieves the list of files and directories in the current remote directory using a raw text format.
GetType (inherited from Object)Gets the Type of the current instance.
ChangeDirectory Changes the current working directory on the server.
CheckConnectionState Checks whether the SFTP session is still connected. Throws an exception on error.
LoginOverloaded. Authenticates the user to the server and initializes the SFTP session.
PutFileOverloaded. Uploads the content of the data stream to the file on the server, overriding it if it already exists.
RemoveDirectory Deletes an empty remote directory with the specified pathname.
Rename Renames a file or directory on the server.
ResolveSymlink Resolves the symlink and returns the real path.
SetAttributes Sets the attributes of the remote file.
ToString (inherited from Object)Returns a String that represents the current Object.

Public Instance Events

CommandSent Occurs when a command is send to the server.
ResponseRead Occurs when a response is received from the server.
StateChanged Occurs when the state of the Sftp object is changed.
TransferProgress Occurs when data is send or received.

Protected Instance Methods

DisposeOverloaded. Releases the unmanaged resources used by the Sftp and optionally releases the managed resources.
Finalize Finalizer. Called by garbage collector during object destruction.
MemberwiseClone (inherited from Object)Creates a shallow copy of the current Object.
OnCommandSent Raises the CommandSent event.
OnResponseRead Raises the ResponseRead event.
OnStateChanged Raises the StateChanged event.
OnTransferProgress Raises the TransferProgress event.

See Also

Sftp Class | Rebex.Net Namespace