C# Class CmisSync.Lib.FileTransmission.SimpleFileDownloader

Simple file downloader.

Inheritance: IFileDownloader

显示文件 Open project: OpenDataSpace/CmisSync Class Usage Examples

Public Methods

Method	Description
Dispose ( ) : void	Releases all resource used by the CmisSync.Lib.FileTransmission.SimpleFileDownloader object. Call Dispose when you are finished using the CmisSync.Lib.FileTransmission.SimpleFileDownloader. The Dispose method leaves the CmisSync.Lib.FileTransmission.SimpleFileDownloader in an unusable state. After calling Dispose, you must release all references to the CmisSync.Lib.FileTransmission.SimpleFileDownloader so the garbage collector can reclaim the memory that the CmisSync.Lib.FileTransmission.SimpleFileDownloader was occupying.
DownloadFile ( IDocument remoteDocument, Stream localFileStream, Transmission transmission, HashAlgorithm hashAlg, UpdateChecksum update = null ) : void	Downloads the file and returns the SHA-1 hash of the content of the saved file

Protected Methods

Method	Description
Dispose ( bool disposing ) : void	Dispose(bool disposing) executes in two distinct scenarios. If disposing equals true, the method has been called directly or indirectly by a user's code. Managed and unmanaged resources can be disposed. If disposing equals false, the method has been called by the runtime from inside the finalizer and you should not reference other objects. Only unmanaged resources can be disposed.

Private Methods

Method	Description
UpdateHash ( HashAlgorithm hash, long length, UpdateChecksum update ) : void

Method Details

Dispose() public method

Releases all resource used by the CmisSync.Lib.FileTransmission.SimpleFileDownloader object.

Call Dispose when you are finished using the CmisSync.Lib.FileTransmission.SimpleFileDownloader. The Dispose method leaves the CmisSync.Lib.FileTransmission.SimpleFileDownloader in an unusable state. After calling Dispose, you must release all references to the CmisSync.Lib.FileTransmission.SimpleFileDownloader so the garbage collector can reclaim the memory that the CmisSync.Lib.FileTransmission.SimpleFileDownloader was occupying.

public Dispose ( ) : void
return	void

Dispose() protected method

Dispose(bool disposing) executes in two distinct scenarios. If disposing equals true, the method has been called directly or indirectly by a user's code. Managed and unmanaged resources can be disposed. If disposing equals false, the method has been called by the runtime from inside the finalizer and you should not reference other objects. Only unmanaged resources can be disposed.

protected Dispose ( bool disposing ) : void
disposing	bool	If set to true disposing.
return	void

DownloadFile() public method

Downloads the file and returns the SHA-1 hash of the content of the saved file

On any disc or network io exception If the remote object has been disposed before the dowload is finished If download is aborted On exceptions thrown by the CMIS Server/Client

public DownloadFile ( IDocument remoteDocument, Stream localFileStream, Transmission transmission, HashAlgorithm hashAlg, UpdateChecksum update = null ) : void
remoteDocument	IDocument	Remote document.
localFileStream	Stream	Local taget file stream.
transmission	Transmission	Transmission status.
hashAlg	System.Security.Cryptography.HashAlgorithm	Hash algoritm, which should be used to calculate hash of the uploaded stream content
update	UpdateChecksum
return	void