Tamir.SharpSsh.SshTransferProtocolBase Class Reference

Summary description for SshTransferProtocolBase. More...

Inheritance diagram for Tamir.SharpSsh.SshTransferProtocolBase:

List of all members.

Public Member Functions
	SshTransferProtocolBase (string host, string user, string password)
	SshTransferProtocolBase (string host, string user)
abstract void	Get (string fromFilePath, string toFilePath)
abstract void	Put (string fromFilePath, string toFilePath)
abstract void	Mkdir (string directory)
abstract void	Cancel ()
Protected Member Functions
void	SendStartMessage (string src, string dst, int totalBytes, string msg)
	Sends a notification that a file transfer has started.
void	SendEndMessage (string src, string dst, int transferredBytes, int totalBytes, string msg)
	Sends a notification that a file transfer has ended.
void	SendProgressMessage (string src, string dst, int transferredBytes, int totalBytes, string msg)
	Sends a transfer progress notification.
Events
FileTransferEvent	OnTransferStart
	Triggered when transfer is starting.
FileTransferEvent	OnTransferEnd
	Triggered when transfer ends.
FileTransferEvent	OnTransferProgress
	Triggered on every interval with the transfer progress iformation.

---

Detailed Description

Summary description for SshTransferProtocolBase.

Definition at line 38 of file SshTransferProtocolBase.cs.

---

Constructor & Destructor Documentation

Tamir.SharpSsh.SshTransferProtocolBase.SshTransferProtocolBase	(	string	host,
		string	user,
		string	password
	)

Definition at line 40 of file SshTransferProtocolBase.cs.

Tamir.SharpSsh.SshTransferProtocolBase.SshTransferProtocolBase	(	string	host,
		string	user
	)

Definition at line 45 of file SshTransferProtocolBase.cs.

---

Member Function Documentation

abstract void Tamir.SharpSsh.SshTransferProtocolBase.Cancel

(

)

[pure virtual]

Implements Tamir.SharpSsh.ITransferProtocol.

Implemented in Tamir.SharpSsh.Scp, and Tamir.SharpSsh.Sftp.

abstract void Tamir.SharpSsh.SshTransferProtocolBase.Get	(	string	fromFilePath,
		string	toFilePath
	)			[pure virtual]

Implements Tamir.SharpSsh.ITransferProtocol.

Implemented in Tamir.SharpSsh.Scp, and Tamir.SharpSsh.Sftp.

abstract void Tamir.SharpSsh.SshTransferProtocolBase.Mkdir

(

string

directory

)

[pure virtual]

Implements Tamir.SharpSsh.ITransferProtocol.

Implemented in Tamir.SharpSsh.Scp, and Tamir.SharpSsh.Sftp.

abstract void Tamir.SharpSsh.SshTransferProtocolBase.Put	(	string	fromFilePath,
		string	toFilePath
	)			[pure virtual]

Implements Tamir.SharpSsh.ITransferProtocol.

Implemented in Tamir.SharpSsh.Scp, and Tamir.SharpSsh.Sftp.

void Tamir.SharpSsh.SshTransferProtocolBase.SendEndMessage	(	string	src,
		string	dst,
		int	transferredBytes,
		int	totalBytes,
		string	msg
	)			[protected]

Sends a notification that a file transfer has ended.

Parameters:

	src	The source file to transferred
	dst	Transfer destination
	transferredBytes	Transferred Bytes
	totalBytes	Total bytes to transfer
	msg	A transfer message

Definition at line 90 of file SshTransferProtocolBase.cs.

void Tamir.SharpSsh.SshTransferProtocolBase.SendProgressMessage	(	string	src,
		string	dst,
		int	transferredBytes,
		int	totalBytes,
		string	msg
	)			[protected]

Sends a transfer progress notification.

Parameters:

	src	The source file to transferred
	dst	Transfer destination
	transferredBytes	Transferred Bytes
	totalBytes	Total bytes to transfer
	msg	A transfer message

Definition at line 104 of file SshTransferProtocolBase.cs.

void Tamir.SharpSsh.SshTransferProtocolBase.SendStartMessage	(	string	src,
		string	dst,
		int	totalBytes,
		string	msg
	)			[protected]

Sends a notification that a file transfer has started.

Parameters:

	src	The source file to transferred
	dst	Transfer destination
	totalBytes	Total bytes to transfer
	msg	A transfer message

Definition at line 76 of file SshTransferProtocolBase.cs.

---

Event Documentation

FileTransferEvent Tamir.SharpSsh.SshTransferProtocolBase.OnTransferEnd

Triggered when transfer ends.

Implements Tamir.SharpSsh.ITransferProtocol.

Definition at line 63 of file SshTransferProtocolBase.cs.

FileTransferEvent Tamir.SharpSsh.SshTransferProtocolBase.OnTransferProgress

Triggered on every interval with the transfer progress iformation.

Implements Tamir.SharpSsh.ITransferProtocol.

Definition at line 67 of file SshTransferProtocolBase.cs.

FileTransferEvent Tamir.SharpSsh.SshTransferProtocolBase.OnTransferStart

Triggered when transfer is starting.

Implements Tamir.SharpSsh.ITransferProtocol.

Definition at line 59 of file SshTransferProtocolBase.cs.

---

The documentation for this class was generated from the following file:

• C:/work/OMMR/OCHHP_OMMR_OMMR/Code/Assemblies/SharpSSH/Source/SharpSSH-1.1.1.13.src/SharpSSH/SshTransferProtocolBase.cs