C# Class CSharpUtils.Net.FTP

Show file Open project: soywiz/csharputils Class Usage Examples

Public Properties

Property	Type	Description
pass	string
port	int
server	string
user	string

Protected Properties

Property	Type	Description
_timeout	int

Public Methods

Method	Description
ChangeDir ( string path ) : void	Change to another directory on the ftp server
Connect ( ) : void	Connect to an ftp server
Connect ( string server, int port, string user, string pass ) : void	Connect to a ftp server
Connect ( string server, string user, string pass ) : void	Connect to a ftp server
Disconnect ( ) : void	Closes all connections to the ftp server
DoDownload ( ) : long	Download a file, to be used in a loop until the file is completely downloaded
DoUpload ( ) : long	Upload the file, to be used in a loop until file is completely uploaded
FTP ( ) : System	Constructor
FTP ( string server, int port, string user, string pass ) : System	Constructor
FTP ( string server, string user, string pass ) : System	Constructor
GetFileDate ( string fileName ) : System.DateTime	GetFileDate will query the ftp server for the date of the remote file.
GetFileDateRaw ( string fileName ) : string	Returns the 'Raw' DateInformation in ftp format. (YYYYMMDDhhmmss). Use GetFileDate to return a DateTime object as a better option.
GetFileSize ( string filename ) : long	Get the size of a file (Provided the ftp server supports it)
GetWorkingDirectory ( ) : string	Get the working directory on the ftp server
List ( ) : ArrayList	Retrieves a list of files from the ftp server
ListDirectories ( ) : ArrayList	Gets a directory list only
ListEntries ( ) : LinkedList	List FTPEntry items with the current path on the FTP connection.
ListFiles ( ) : ArrayList	Gets a file list only
MakeDir ( string dir ) : void	Create a directory on the ftp server
OpenDownload ( string remote_filename, string local_filename, bool resume = false ) : void	Open a file for download
OpenUpload ( Stream _file, string remote_filename, bool resume = false ) : void	Open an upload with resume support
OpenUpload ( string filename, string remote_filename, bool resume = false ) : void
RemoveDir ( string dir ) : void	Remove a directory from the ftp server
RemoveFile ( string filename ) : void	Remove a file from the ftp server
RenameFile ( string oldfilename, string newfilename ) : void	Rename a file on the ftp server

Protected Methods

Method	Description
SetSocketTimeout ( Socket Socket ) : void
SetSocketTimeout ( Socket Socket, int Timeout ) : void

Private Methods

Method	Description
CloseDataSocket ( ) : void
ConnectDataSocket ( ) : void
ConvertFTPDateToDateTime ( string input ) : System.DateTime
Fail ( ) : void
OpenDataSocket ( ) : void
ReadResponse ( ) : void
SendCommand ( string command ) : void
SetBinaryMode ( bool mode ) : void

Method Details

ChangeDir() public method

Change to another directory on the ftp server

public ChangeDir ( string path ) : void
path	string	Directory to change to
return	void

Connect() public method

Connect to an ftp server

public Connect ( ) : void
return	void

Connect() public method

Connect to a ftp server

public Connect ( string server, int port, string user, string pass ) : void
server	string	IP or hostname of the server to connect to
port	int	Port number the server is listening on
user	string	Account name to login as
pass	string	Password for the account specified
return	void

Connect() public method

Connect to a ftp server

public Connect ( string server, string user, string pass ) : void
server	string	IP or hostname of the server to connect to
user	string	Account name to login as
pass	string	Password for the account specified
return	void

Disconnect() public method

Closes all connections to the ftp server

public Disconnect ( ) : void
return	void

DoDownload() public method

Download a file, to be used in a loop until the file is completely downloaded

public DoDownload ( ) : long
return	long

DoUpload() public method

Upload the file, to be used in a loop until file is completely uploaded

public DoUpload ( ) : long
return	long

FTP() public method

Constructor

public FTP ( ) : System
return	System

FTP() public method

Constructor

public FTP ( string server, int port, string user, string pass ) : System
server	string	Server to connect to
port	int	Port server is listening on
user	string	Account to login as
pass	string	Account password
return	System

FTP() public method

Constructor

public FTP ( string server, string user, string pass ) : System
server	string	Server to connect to
user	string	Account to login as
pass	string	Account password
return	System

GetFileDate() public method

GetFileDate will query the ftp server for the date of the remote file.

public GetFileDate ( string fileName ) : System.DateTime
fileName	string	Remote FileName to Query
return	System.DateTime

GetFileDateRaw() public method

Returns the 'Raw' DateInformation in ftp format. (YYYYMMDDhhmmss). Use GetFileDate to return a DateTime object as a better option.

public GetFileDateRaw ( string fileName ) : string
fileName	string	Remote FileName to Query
return	string

GetFileSize() public method

Get the size of a file (Provided the ftp server supports it)

public GetFileSize ( string filename ) : long
filename	string	Name of file
return	long

GetWorkingDirectory() public method

Get the working directory on the ftp server

public GetWorkingDirectory ( ) : string
return	string

List() public method

Retrieves a list of files from the ftp server

public List ( ) : ArrayList
return	System.Collections.ArrayList

ListDirectories() public method

Gets a directory list only

public ListDirectories ( ) : ArrayList
return	System.Collections.ArrayList

ListEntries() public method

List FTPEntry items with the current path on the FTP connection.

public ListEntries ( ) : LinkedList
return	LinkedList

ListFiles() public method

Gets a file list only

public ListFiles ( ) : ArrayList
return	System.Collections.ArrayList

MakeDir() public method

Create a directory on the ftp server

public MakeDir ( string dir ) : void
dir	string	Directory to create
return	void

OpenDownload() public method

Open a file for download

public OpenDownload ( string remote_filename, string local_filename, bool resume = false ) : void
remote_filename	string	The name of the file on the FTP server
local_filename	string	The name of the file to save as (Can include path to file)
resume	bool	Attempt resume if file exists
return	void

OpenUpload() public method

Open an upload with resume support

public OpenUpload ( Stream _file, string remote_filename, bool resume = false ) : void
_file	Stream	Local file to upload (Can include path to file)
remote_filename	string	Filename to store file as on ftp server
resume	bool	Attempt resume if exists
return	void

OpenUpload() public method

public OpenUpload ( string filename, string remote_filename, bool resume = false ) : void
filename	string
remote_filename	string
resume	bool
return	void

RemoveDir() public method

Remove a directory from the ftp server

public RemoveDir ( string dir ) : void
dir	string	Name of directory to remove
return	void

RemoveFile() public method

Remove a file from the ftp server

public RemoveFile ( string filename ) : void
filename	string	Name of the file to delete
return	void

RenameFile() public method

Rename a file on the ftp server

public RenameFile ( string oldfilename, string newfilename ) : void
oldfilename	string	Old file name
newfilename	string	New file name
return	void

SetSocketTimeout() protected method

protected SetSocketTimeout ( Socket Socket ) : void
Socket	Socket
return	void

SetSocketTimeout() protected method

protected SetSocketTimeout ( Socket Socket, int Timeout ) : void
Socket	Socket
Timeout	int
return	void

Property Details

_timeout protected property

protected int _timeout
return	int

pass public property

Password for account

public string pass
return	string

port public property

Port number the FTP server is listening on

public int port
return	int

server public property

IP address or hostname to connect to

public string server
return	string

user public property

Username to login as

public string user
return	string