C# Class openHistorian.Adapters.Connection

Represents an openHistorian connection.
Inheritance: IDisposable
Show file Open project: GridProtectionAlliance/openHistorian Class Usage Examples

Public Methods

Method Description
Connection ( string historianServer, string instanceName ) : System

Creates a new openHistorian Connection.
Dispose ( ) : void

Releases all the resources used by the Connection object.
OpenDatabase ( string instanceName = null ) : openHistorian.Snap.HistorianValue>.GSF.Snap.Services.ClientDatabaseBase

Opens new database instance for this Connection.

Protected Methods

Method Description
Dispose ( bool disposing ) : void

Releases the unmanaged resources used by the Connection object and optionally releases the managed resources.

Method Details

Connection() public method

Creates a new openHistorian Connection.
public Connection ( string historianServer, string instanceName ) : System
historianServer string Historian server connection string, e.g., "localhost" or "myhistorian:38402"
instanceName string Instance name of historian, e.g., "PPA".
return System

Dispose() public method

Releases all the resources used by the Connection object.
public Dispose ( ) : void
return void

Dispose() protected method

Releases the unmanaged resources used by the Connection object and optionally releases the managed resources.
protected Dispose ( bool disposing ) : void
disposing bool true to release both managed and unmanaged resources; false to release only unmanaged resources.
return void

OpenDatabase() public method

Opens new database instance for this Connection.
public OpenDatabase ( string instanceName = null ) : openHistorian.Snap.HistorianValue>.GSF.Snap.Services.ClientDatabaseBase
instanceName string Instance name of historian, e.g., "PPA" - or null to use default instance name associated with this connection.
return openHistorian.Snap.HistorianValue>.GSF.Snap.Services.ClientDatabaseBase