PowerTCP SSH and SFTP for .NET
Ssh Class Members
Properties  Methods  Events


The following tables list the members exposed by Ssh.

Public Constructors
 NameDescription
Public ConstructorSsh ConstructorOverloaded.   
Top
Public Properties
 NameDescription
Public PropertyAcceptAllHostKeysWhen true, all host keys are accepted if not overridden with HostKeyEventArgs.Verified. When false, the SshConnection.HostKey event must be used to verify host keys. (Inherited from Dart.Ssh.SshConnection)
Public PropertyConnection Gets the underlying Connection instance being used for server communications. (Inherited from Dart.Ssh.SshConnection)
Public PropertyContainer (Inherited from System.ComponentModel.Component)
Public PropertyDisableInnerExceptions Set to true to disable the use of Exception.InnerException. (Inherited from Dart.Ssh.ComponentBase)
Public PropertyEncoding Character encoding used by the component. (Inherited from Dart.Ssh.ComponentBase)
Public PropertySite (Inherited from System.ComponentModel.Component)
Public PropertyState Gets a value that reflects the current TCP connection state and SSH authentication state. (Inherited from Dart.Ssh.SshConnection)
Public PropertySynchronizingObject Gets or sets the object used to marshal data to the UI thread (for raising events). (Inherited from Dart.Ssh.ComponentBase)
Public PropertySyncRoot Gets an object that is used to synchronize access to the upper layer protocol in use. (Inherited from Dart.Ssh.ComponentBase)
Public PropertyTag Gets or sets an object that stores any user data. (Inherited from Dart.Ssh.ComponentBase)
Public PropertyThreadingModel Controls the threading model used by the component. (Inherited from Dart.Ssh.ComponentBase)
Top
Protected Properties
Public Methods
 NameDescription
Public MethodAuthenticateOverloaded.  Performs 'keyboard-interactive' authentication. (Inherited from Dart.Ssh.SshConnection)
Public MethodClose Closes the connection to the SSH-2 server. (Inherited from Dart.Ssh.SshConnection)
Public MethodConnectOverloaded. Connects to the SSH-2 server specified by Connection.RemoteEndPoint. (Inherited from Dart.Ssh.SshConnection)
Public MethodCreateLocalPortForwarderOverloaded. Creates a new LocalPortForwarder. (Inherited from Dart.Ssh.SshConnection)
Public MethodCreateObjRefCreates an object that contains all the relevant information required to generate a proxy used to communicate with a remote object. (Inherited from System.MarshalByRefObject)
Public MethodDisposeOverloaded. Overridden.  Releases all resources associated with the object.  
Public MethodExecuteOverloaded.  Executes a command on the server.  
Public MethodGetLifetimeServiceRetrieves the current lifetime service object that controls the lifetime policy for this instance. (Inherited from System.MarshalByRefObject)
Public MethodInitializeLifetimeServiceObtains a lifetime service object to control the lifetime policy for this instance. (Inherited from System.MarshalByRefObject)
Public MethodMarshalOverloaded.  Marshals data to the UI thread.  
Public MethodOnBannerRaises the SshConnection.Banner event. (Inherited from Dart.Ssh.SshConnection)
Public MethodOnChallengeRaises the SshConnection.Challenge event. (Inherited from Dart.Ssh.SshConnection)
Public MethodOnHostKeyRaises the SshConnection.HostKey event. (Inherited from Dart.Ssh.SshConnection)
Public MethodStart Starts a worker thread on which the specified delegate function executes.  
Public MethodStartShellOverloaded.  Starts a "dumb" shell.  
Public MethodStartSubSystem Starts a subsystem on the remote machine. For advanced applications.  
Public MethodToString (Inherited from System.ComponentModel.Component)
Top
Protected Methods
 NameDescription
Protected MethodFinalize (Inherited from System.ComponentModel.Component)
Protected MethodGetService (Inherited from System.ComponentModel.Component)
Protected MethodMemberwiseCloneOverloaded. Creates a shallow copy of the current System.MarshalByRefObject object. (Inherited from System.MarshalByRefObject)
Protected MethodOnData Raises the Data event.  
Protected MethodOnErrorRaises the Error event. (Inherited from Dart.Ssh.ComponentBase)
Protected MethodOnLog Raises the Log event. (Inherited from Dart.Ssh.SshConnection)
Protected MethodOnStateChangedRaises the SshConnection.StateChanged event. (Inherited from Dart.Ssh.SshConnection)
Protected MethodOnUserStateRaises the UserState event. (Inherited from Dart.Ssh.ComponentBase)
Top
Public Events
 NameDescription
Public EventBanner Raised when the server presents a banner during authentication. (Inherited from Dart.Ssh.SshConnection)
Public EventChallenge Raised when the server presents its challenges during 'keyboard-interactive' authentication. (Inherited from Dart.Ssh.SshConnection)
Public EventDataRaised when the Marshal method is called by the user.  
Public EventDisposed (Inherited from System.ComponentModel.Component)
Public EventErrorRaised when Marshal(Exception) is used or an unhandled Exception is thrown in a worker thread created using Start. (Inherited from Dart.Ssh.ComponentBase)
Public EventHostKey Raised when the server presents its hostkey while establishing a connection. (Inherited from Dart.Ssh.SshConnection)
Public EventLog Used to log packet-level communications. (Inherited from Dart.Ssh.SshConnection)
Public EventStateChanged Raised when the value of the State property changes, or a call to any Authenticate method returns. (Inherited from Dart.Ssh.SshConnection)
Public EventUserStateRaised when Marshal(String,Object) is used. (Inherited from Dart.Ssh.ComponentBase)
Top
See Also

Reference

Ssh Class
Dart.Ssh Namespace


PowerTCP SSH and SFTP for .NET Documentation Version 7.0
© 2023 Dart Communications. All Rights Reserved.
Send comments on this topic