The Scp type exposes the following members.
Constructors
| Name | Description | |
|---|---|---|
  | Scp |
Initializes a new instance of the Scp class.
|
Methods
| Name | Description | |
|---|---|---|
| BeginConnect(String, AsyncCallback, Object) |
Begins asynchronous Connect operation.
Connects to the SCP host.
|
| BeginConnect(String, Int32, AsyncCallback, Object) |
Begins asynchronous Connect operation.
Connects to the SCP host.
|
| BeginConnect(String, Int32, SshParameters, AsyncCallback, Object) | Obsolete. |
| BeginCreateDirectory |
Begins asynchronous CreateDirectory operation.
Creates a directory on the server.
|
| BeginDisconnect |
Begins asynchronous Disconnect operation.
Informs the server that the connection is about to close and
terminates the connection.
|
| BeginDownload |
Begins asynchronous Download operation.
Downloads the content of the remote directory (files and all subfolders) to the specified local directory.
|
| BeginGetFile(String, Stream, AsyncCallback, Object) |
Begins asynchronous GetFile operation.
Downloads the remote file to the data stream.
|
| BeginGetFile(String, String, AsyncCallback, Object) |
Begins asynchronous GetFile operation.
Downloads the remote file to the local file, overriding it if it already exists.
|
| BeginGetFiles | Obsolete. |
| BeginLogin(AsyncCallback, Object) |
Begins asynchronous Login operation.
Authenticates the user to the server interactively and initializes the SCP session.
Uses AuthenticationRequest event to request credentials.
|
| BeginLogin(String, AsyncCallback, Object) |
Begins asynchronous Login operation.
Authenticates the user to the server interactively and initializes the SCP session.
Uses AuthenticationRequest event to request credentials.
|
| BeginLogin(SshGssApiCredentials, AsyncCallback, Object) |
Begins asynchronous Login operation.
Authenticates to the server using GSSAPI.
Kerberos is only supported on Mono.
NTLM is supported on Windows and partially on Mono.
|
| BeginLogin(String, SshPrivateKey, AsyncCallback, Object) |
Begins asynchronous Login operation.
Authenticates the user to the server using his private key and initializes the SCP session.
|
| BeginLogin(String, String, AsyncCallback, Object) |
Begins asynchronous Login operation.
Authenticates the user to the server and initializes the SCP session.
|
| BeginLogin(String, String, SshPrivateKey, AsyncCallback, Object) |
Begins asynchronous Login operation.
Authenticates the user to the server using a combination of password and public key and initializes the SCP session.
|
| BeginPutFile(Stream, String, AsyncCallback, Object) |
Begins asynchronous PutFile operation.
Uploads the content of the data stream to the file on the server, overriding it if it already exists.
|
| BeginPutFile(String, String, AsyncCallback, Object) |
Begins asynchronous PutFile operation.
Uploads the content of the local file to the file on the server, overriding it if it already exists.
|
| BeginPutFiles | Obsolete. |
| BeginUpload |
Begins asynchronous Upload operation.
Uploads the content of the local directory (files and all subfolders) to the specified remote directory.
|
| Bind |
Binds the Scp object to an underlying SSH session. This can be used instead of Connect(String)/Login(String, String) methods.
|
| Connect(String) |
Connects to the SCP host.
|
| Connect(String, Int32) |
Connects to the SCP host.
|
| Connect(String, Int32, SshParameters) | Obsolete. |
| CreateDirectory |
Creates a directory on the server.
|
| Disconnect |
Informs the server that the connection is about to close and
terminates the connection.
|
| Dispose()()()() |
Disposes the Scp object and all the socket objects.
|
 | Dispose(Boolean) |
Releases the unmanaged resources used by the Scp
and optionally releases the managed resources.
|
| Download |
Downloads the content of the remote directory (files and all subfolders) to the specified local directory.
|
| EndConnect |
Ends an asynchronous BeginConnect operation.
|
| EndCreateDirectory |
Ends an asynchronous BeginCreateDirectory operation.
|
| EndDisconnect |
Ends an asynchronous BeginDisconnect operation.
|
| EndDownload |
Ends an asynchronous BeginDownload operation.
|
| EndGetFile |
Ends an asynchronous BeginGetFile operation.
|
| EndGetFiles | Obsolete. |
| EndLogin |
Ends an asynchronous BeginLogin operation.
|
| EndPutFile |
Ends an asynchronous BeginPutFile operation.
|
| EndPutFiles | Obsolete. |
| EndUpload |
Ends an asynchronous BeginUpload operation.
|
| Equals | Determines whether the specified Object is equal to the current Object. (Inherited from Object.) |
| Finalize |
Finalizer. Called by garbage collector during object destruction.
(Overrides Object..::..Finalize()()()().) |
| GetFile(String, Stream) |
Downloads the remote file to the data stream.
|
| GetFile(String, String) |
Downloads the remote file to the local file, overriding it if it already exists.
|
| GetFiles | Obsolete. |
| GetHashCode | Serves as a hash function for a particular type. GetHashCode()()()() is suitable for use in hashing algorithms and data structures like a hash table. (Inherited from Object.) |
| GetType | Gets the Type of the current instance. (Inherited from Object.) |
| Login()()()() |
Authenticates the user to the server interactively and initializes the SCP session.
Uses AuthenticationRequest event to request credentials.
|
| Login(String) |
Authenticates the user to the server interactively and initializes the SCP session.
Uses AuthenticationRequest event to request credentials.
|
| Login(SshGssApiCredentials) |
Authenticates to the server using GSSAPI.
Kerberos is only supported on Mono.
NTLM is supported on Windows and partially on Mono.
|
| Login(String, SshPrivateKey) |
Authenticates the user to the server using his private key and initializes the SCP session.
|
| Login(String, String) |
Authenticates the user to the server and initializes the SCP session.
|
| Login(String, String, SshPrivateKey) |
Authenticates the user to the server using a combination of password and public key and initializes the SCP session.
|
| MemberwiseClone | Creates a shallow copy of the current Object. (Inherited from Object.) |
| OnBatchTransferProgress |
Raises the BatchTransferProgress event.
|
| OnTransferProgress |
Raises the TransferProgress event.
|
| PutFile(Stream, String) |
Uploads the content of the data stream to the file on the server, overriding it if it already exists.
|
| PutFile(String, String) |
Uploads the content of the local file to the file on the server, overriding it if it already exists.
|
| PutFiles | Obsolete. |
| SetSocketFactory |
Sets the socket factory to be used to create communication sockets.
|
| ToString |
Returns a string representation of this object.
(Overrides Object..::..ToString()()()().) |
| Upload |
Uploads the content of the local directory (files and all subfolders) to the specified remote directory.
|
Fields
| Name | Description | |
|---|---|---|
  | DefaultPort |
Default SCP port (22).
|
Properties
| Name | Description | |
|---|---|---|
 | Encoding |
Gets or sets the Encoding to use to encode and decode command parameters and server responses.
|
| Fingerprint |
Gets the server public key fingerprint (a SHA-256 hash of the server public key).
|
 | InstanceId |
Gets instance ID (intended for logging purposes).
(Inherited from NetworkSession.) |
| IsAuthenticated |
Gets a value indicating whether the session is authenticated.
(Overrides NetworkSession..::..IsAuthenticated.) |
| IsConnected |
Gets a value indicating whether the session is connected.
(Overrides NetworkSession..::..IsConnected.) |
| LocalEndPoint |
Gets the local client EndPoint.
|
| LogWriter |
Gets or sets the LogWriter used by this object.
(Inherited from NetworkSession.) |
| Proxy |
Gets or sets the network proxy to use to access a remote server.
|
| RemoteEndPoint |
Gets the remote server EndPoint.
|
| ServerKey |
Gets the server public key.
|
| ServerName |
Gets the server name, if available.
(Inherited from NetworkSession.) |
| ServerPort |
Gets the server port, if available.
(Inherited from NetworkSession.) |
| Session |
Gets the SSH session used by this SCP session.
|
| Settings |
Gets or sets SCP object settings.
|
| State | |
| Timeout |
Gets or sets the length of time in milliseconds before the operation times out (specify -1 or 0 to indicate that the request does not time out).
|
| UserName |
Gets the authenticated user name, if available.
(Inherited from NetworkSession.) |
| Version |
Gets the version of the SCP component.
|
Events
| Name | Description | |
|---|---|---|
 | AuthenticationRequest |
Occurs when an authentication request is received from the server that cannot be answered programmatically.
|
| BannerReceived |
Occurs when a banner message is received from the server.
|
| BatchTransferProgress |
Occurs when a significant action occurs in Download(String, String) or Upload(String, String) methods.
|
| FingerprintCheck |
Occurs when a fingerprint is received from the server and needs to be validated.
|
| TransferProgress |
Occurs when data is send or received.
|
See Also
