Click or drag to resize

BaseClient Class

Serves as base class for client implementations, provides common client functionality.
Inheritance Hierarchy

Namespace: Crestron.SimplSharp.Ssh
Assembly: SimplSharpHelperInterface (in SimplSharpHelperInterface.dll) Version: 2.21.121
Syntax
C#
public abstract class BaseClient : IDisposable

The BaseClient type exposes the following members.

Properties
 NameDescription
Public propertyIsConnected Gets a value indicating whether this client is connected to the server.
Public propertyKeepAliveInterval Gets or sets the keep alive interval in seconds.
Top
Methods
 NameDescription
Public methodConnect Connects client to the server.
Public methodDisconnect Disconnects client from the server.
Public methodDispose Performs application-defined tasks associated with freeing, releasing, or resetting unmanaged ResourceMessages.
Protected methodDispose(Boolean) Releases unmanaged and - optionally - managed resources
Public methodEqualsDetermines whether the specified object is equal to the current object.
(Inherited from Object)
Protected methodFinalize Releases unmanaged resources and performs other cleanup operations before the BaseClient is reclaimed by garbage collection.
(Overrides ObjectFinalize)
Public methodGetHashCodeServes as the default hash function.
(Inherited from Object)
Public methodGetTypeGets the Type of the current instance.
(Inherited from Object)
Protected methodMemberwiseCloneCreates a shallow copy of the current Object.
(Inherited from Object)
Protected methodOnConnected Called when client is connected to the server.
Protected methodOnConnecting Called when client is connecting to the server.
Protected methodOnDisconnected Called when client is disconnected from the server.
Protected methodOnDisconnecting Called when client is disconnecting from the server.
Public methodSendKeepAlive Sends keep-alive message to the server.
Public methodToStringReturns a string that represents the current object.
(Inherited from Object)
Top
Events
 NameDescription
Public eventErrorOccurred Occurs when an error occurred.
Public eventHostKeyReceived Occurs when host key received.
Top

Version Information

.NET

Supported in: 6.0

.NET Compact Framework

Supported in: 3.5
See Also