C# Class GSF.Snap.Services.SnapServer

Hosts all of the components of a SortedTreeStore.

A centralized server hosting model for a SortedTreeStore. This class contains all of the databases, client connections, sockets, user authentication, and core settings for the SortedTreeStore.

Inheritance: GSF.Diagnostics.DisposableLoggingClassBase

Show file Open project: GridProtectionAlliance/openHistorian Class Usage Examples

Public Methods

Method	Description
AddDatabase ( IToServerDatabaseSettings databaseConfig ) : void
AddDatabase ( ServerDatabaseSettings databaseConfig ) : void	Adds a database to the server
AddSocketListener ( SnapSocketListenerSettings socketSettings ) : void	Adds the socket interface to the database
GetFullStatus ( StringBuilder status ) : void	Gets the status of the server.
RemoveDatabase ( string database ) : void	Unloads the database name.
SnapServer ( ) : System	Creates an empty server instance
SnapServer ( IToServerDatabaseSettings settings ) : System	Creates a new instance of SnapServer and adds the supplied database
SnapServer ( IToServerSettings settings ) : System	Creates a new instance of SnapServer
UnloadSocket ( IPEndPoint socketEndpoint ) : void	Unloads the specified socket interface.

Protected Methods

Method	Description
Dispose ( bool disposing ) : void	Releases the unmanaged resources used by the SnapServer object and optionally releases the managed resources.

Private Methods

Method	Description
Contains ( string databaseName ) : bool	Determines if databaseName is contained in the database.
GetDatabase ( string databaseName ) : SnapServerDatabaseBase	Gets the database that matches databaseName
GetDatabaseInfo ( ) : List	Gets basic information for every database connected to the server.
RegisterClient ( Client client ) : void	Registers a client with the server host.
UnRegisterClient ( Client client ) : void	UnRegisters a client with the server host.

Method Details

AddDatabase() public method

public AddDatabase ( IToServerDatabaseSettings databaseConfig ) : void
databaseConfig	IToServerDatabaseSettings
return	void

AddDatabase() public method

Adds a database to the server

public AddDatabase ( ServerDatabaseSettings databaseConfig ) : void
databaseConfig	ServerDatabaseSettings
return	void

AddSocketListener() public method

Adds the socket interface to the database

public AddSocketListener ( SnapSocketListenerSettings socketSettings ) : void
socketSettings	SnapSocketListenerSettings	the config data for the socket listener
return	void

Dispose() protected method

Releases the unmanaged resources used by the SnapServer 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

GetFullStatus() public method

Gets the status of the server.

public GetFullStatus ( StringBuilder status ) : void
status	StringBuilder
return	void

RemoveDatabase() public method

Unloads the database name.

public RemoveDatabase ( string database ) : void
database	string
return	void

SnapServer() public method

Creates an empty server instance

public SnapServer ( ) : System
return	System

SnapServer() public method

Creates a new instance of SnapServer and adds the supplied database

public SnapServer ( IToServerDatabaseSettings settings ) : System
settings	IToServerDatabaseSettings
return	System

SnapServer() public method

Creates a new instance of SnapServer

public SnapServer ( IToServerSettings settings ) : System
settings	IToServerSettings
return	System

UnloadSocket() public method

Unloads the specified socket interface.

public UnloadSocket ( IPEndPoint socketEndpoint ) : void
socketEndpoint	System.Net.IPEndPoint
return	void