Class SSHConnection

Inheritance

System.Object

SSHConnection

Implements

System.IDisposable

Namespace: BoldReports.Data

Assembly: BoldReports.Web.dll

Syntax

public class SSHConnection : Object, IDisposable

Constructors

SSHConnection(SSHConnectionSettings, Tuple<String, String>)

Initializes a new instance of the SSHConnection class with the specified SSH connection settings and database host information.

Declaration

public SSHConnection(SSHConnectionSettings sshSettings, Tuple<string, string> dbHostInfo)

Parameters

Type	Name	Description
BoldReports.RDL.DOM.SSHConnectionSettings	sshSettings	An BoldReports.RDL.DOM.SSHConnectionSettings object containing the SSH connection configuration.
System.Tuple<System.String, System.String>	dbHostInfo	A System.Tuple<, > containing the database host name and address.

Properties

IsConnected

Gets a value indicating whether the data extension is currently connected.

Declaration

public bool IsConnected { get; }

Property Value

Type	Description
System.Boolean	true if the data extension is connected; otherwise, false.

Localhost

Gets the localhost value.

Declaration

public string Localhost { get; }

Property Value

Type	Description
System.String	A string representing the localhost address.

SshForwardedPort

Gets or sets the SSH forwarded port number.

Declaration

public uint SshForwardedPort { get; }

Property Value

Type	Description
System.UInt32	The SSH forwarded port number as an unsigned 32-bit integer.

Methods

Dispose()

Provides a mechanism for releasing unmanaged resources.

Declaration

public void Dispose()

Remarks

It close or release unmanaged resources such as files, streams, and handles held by an instance of the class that implements this interface.

Implements

System.IDisposable