Tamir.SharpSsh.Scp Class Reference

Class for handling SCP file transfers over SSH connection. More...

Inheritance diagram for Tamir.SharpSsh.Scp:

List of all members.

Public Member Functions

Scp (string host, string user, string password)

Scp (string host, string user)

override void Cancel ()

override void Mkdir (string dir)

Creates a directory on the remot server.

override void Put (string fromFilePath, string toFilePath)

override void Get (string fromFilePath, string toFilePath)

void To (string localPath, string remotePath)

Copies a file from local machine to a remote SSH machine.

void To (string localPath, string remotePath, bool _recursive)

Copies a file from local machine to a remote SSH machine.

void From (string remoteFile, string localPath)

Copies a file from a remote SSH machine to the local machine using SCP.

void From (string remoteFile, string localPath, bool _recursive)

Copies a file from a remote SSH machine to the local machine using SCP.

Protected Member Functions

override void ConnectChannel ()

This function is empty, so no channel is connected on session connect.

void SCP_CheckConnectivity ()

Checks is a channel is already connected by this instance.

void SCP_ConnectTo (out Channel channel, out Stream server, string rfile, bool recursive)

Connect a channel to the remote server using the 'SCP TO' command ('scp -t').

void SCP_ConnectFrom (out Channel channel, out Stream server, string rfile, bool recursive)

Connect a channel to the remote server using the 'SCP From' command ('scp -f').

void SCP_SendFile (Stream server, string src, string dst)

Transfer a file to the remote server.

void SCP_ReceiveFile (Stream server, string rfile, string lfile, int size)

Transfer a file from the remote server.

void SCP_EnterIntoDir (Stream server, string dir)

Instructs the remote server to enter into a directory.

void SCP_EnterIntoParent (Stream server)

Instructs the remote server to go up one level.

Properties

override string ChannelType [get]

bool Recursive [get, set]

Gets or sets a value indicating the default recursive transfer behaviour.

bool Verbos [get, set]

Gets or sets a value indicating whether trace information should be printed.

Detailed Description

Class for handling SCP file transfers over SSH connection.

Definition at line 43 of file Scp.cs.

Constructor & Destructor Documentation

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

Definition at line 49 of file Scp.cs.

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

Definition at line 54 of file Scp.cs.

Member Function Documentation

override void Tamir.SharpSsh.Scp.Cancel ( ) [virtual]

Implements Tamir.SharpSsh.SshTransferProtocolBase.

Definition at line 90 of file Scp.cs.

override void Tamir.SharpSsh.Scp.ConnectChannel ( ) [protected, virtual]

This function is empty, so no channel is connected on session connect.

Reimplemented from Tamir.SharpSsh.SshBase.

Definition at line 68 of file Scp.cs.

void Tamir.SharpSsh.Scp.From	(	string	remoteFile,
		string	localPath,
		bool	_recursive
	)

Copies a file from a remote SSH machine to the local machine using SCP.

Parameters:

	remoteFile	The remmote file name
	localPath	The local destination path
	recursive	Value indicating whether a recursive transfer should take place

Definition at line 235 of file Scp.cs.

void Tamir.SharpSsh.Scp.From	(	string	remoteFile,
		string	localPath
	)

Copies a file from a remote SSH machine to the local machine using SCP.

Parameters:

	remoteFile	The remmote file name
	localPath	The local destination path

Definition at line 224 of file Scp.cs.

override void Tamir.SharpSsh.Scp.Get	(	string	fromFilePath,
		string	toFilePath
	)			`[virtual]`

Implements Tamir.SharpSsh.SshTransferProtocolBase.

Definition at line 117 of file Scp.cs.

override void Tamir.SharpSsh.Scp.Mkdir ( string dir ) [virtual]

Creates a directory on the remot server.

Parameters:

dir

The new directory

Implements Tamir.SharpSsh.SshTransferProtocolBase.

Definition at line 99 of file Scp.cs.

override void Tamir.SharpSsh.Scp.Put	(	string	fromFilePath,
		string	toFilePath
	)			`[virtual]`

Implements Tamir.SharpSsh.SshTransferProtocolBase.

Definition at line 112 of file Scp.cs.

void Tamir.SharpSsh.Scp.SCP_CheckConnectivity ( ) [protected]

Checks is a channel is already connected by this instance.

Definition at line 358 of file Scp.cs.

void Tamir.SharpSsh.Scp.SCP_ConnectFrom	(	out Channel	channel,
		out Stream	server,
		string	rfile,
		bool	recursive
	)			`[protected]`

Connect a channel to the remote server using the 'SCP From' command ('scp -f').

Parameters:

	channel	Will contain the new connected channel
	server	Will contaun the new connected server I/O stream
	rfile	The remote path on the server
	recursive	Idicate a recursive scp transfer

Definition at line 395 of file Scp.cs.

void Tamir.SharpSsh.Scp.SCP_ConnectTo	(	out Channel	channel,
		out Stream	server,
		string	rfile,
		bool	recursive
	)			`[protected]`

Connect a channel to the remote server using the 'SCP TO' command ('scp -t').

Parameters:

	channel	Will contain the new connected channel
	server	Will contaun the new connected server I/O stream
	rfile	The remote path on the server
	recursive	Idicate a recursive scp transfer

Definition at line 371 of file Scp.cs.

void Tamir.SharpSsh.Scp.SCP_EnterIntoDir	(	Stream	server,
		string	dir
	)			`[protected]`

Instructs the remote server to enter into a directory.

Parameters:

	server	A connected server I/O stream
	dir	The directory name/param>

Definition at line 508 of file Scp.cs.

void Tamir.SharpSsh.Scp.SCP_EnterIntoParent ( Stream server ) [protected]

Instructs the remote server to go up one level.

Parameters:

server

A connected server I/O stream

Definition at line 534 of file Scp.cs.

void Tamir.SharpSsh.Scp.SCP_ReceiveFile	(	Stream	server,
		string	rfile,
		string	lfile,
		int	size
	)			`[protected]`

Transfer a file from the remote server.

Parameters:

	server	A connected server I/O stream
	rfile	The remote file to copy
	lfile	The local destination path

Definition at line 476 of file Scp.cs.

void Tamir.SharpSsh.Scp.SCP_SendFile	(	Stream	server,
		string	src,
		string	dst
	)			`[protected]`

Transfer a file to the remote server.

Parameters:

	server	A connected server I/O stream
	src	The source file to copy
	dst	The remote destination path

Definition at line 418 of file Scp.cs.

void Tamir.SharpSsh.Scp.To	(	string	localPath,
		string	remotePath,
		bool	_recursive
	)

Copies a file from local machine to a remote SSH machine.

Parameters:

	localPath	The local file path.
	remotePath	The path of the remote file.

Definition at line 140 of file Scp.cs.

void Tamir.SharpSsh.Scp.To	(	string	localPath,
		string	remotePath
	)

Copies a file from local machine to a remote SSH machine.

Parameters:

	localPath	The local file path.
	remotePath	The path of the remote file.

Definition at line 129 of file Scp.cs.

Property Documentation

override string Tamir.SharpSsh.Scp.ChannelType [get, protected]

Reimplemented from Tamir.SharpSsh.SshBase.

Definition at line 60 of file Scp.cs.

bool Tamir.SharpSsh.Scp.Recursive [get, set]

Gets or sets a value indicating the default recursive transfer behaviour.

Definition at line 76 of file Scp.cs.

bool Tamir.SharpSsh.Scp.Verbos [get, set]

Gets or sets a value indicating whether trace information should be printed.

Definition at line 85 of file Scp.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/Scp.cs


Public Member Functions
	Scp (string host, string user, string password)
	Scp (string host, string user)
override void	Cancel ()
override void	Mkdir (string dir)
	Creates a directory on the remot server.
override void	Put (string fromFilePath, string toFilePath)
override void	Get (string fromFilePath, string toFilePath)
void	To (string localPath, string remotePath)
	Copies a file from local machine to a remote SSH machine.
void	To (string localPath, string remotePath, bool _recursive)
	Copies a file from local machine to a remote SSH machine.
void	From (string remoteFile, string localPath)
	Copies a file from a remote SSH machine to the local machine using SCP.
void	From (string remoteFile, string localPath, bool _recursive)
	Copies a file from a remote SSH machine to the local machine using SCP.
Protected Member Functions
override void	ConnectChannel ()
	This function is empty, so no channel is connected on session connect.
void	SCP_CheckConnectivity ()
	Checks is a channel is already connected by this instance.
void	SCP_ConnectTo (out Channel channel, out Stream server, string rfile, bool recursive)
	Connect a channel to the remote server using the 'SCP TO' command ('scp -t').
void	SCP_ConnectFrom (out Channel channel, out Stream server, string rfile, bool recursive)
	Connect a channel to the remote server using the 'SCP From' command ('scp -f').
void	SCP_SendFile (Stream server, string src, string dst)
	Transfer a file to the remote server.
void	SCP_ReceiveFile (Stream server, string rfile, string lfile, int size)
	Transfer a file from the remote server.
void	SCP_EnterIntoDir (Stream server, string dir)
	Instructs the remote server to enter into a directory.
void	SCP_EnterIntoParent (Stream server)
	Instructs the remote server to go up one level.
Properties
override string	ChannelType `[get]`
bool	Recursive `[get, set]`
	Gets or sets a value indicating the default recursive transfer behaviour.
bool	Verbos `[get, set]`
	Gets or sets a value indicating whether trace information should be printed.