Deveel.Data.Protocol.DefaultLocalBootable Class Reference

A bootable object that filters through to a DatabaseInterface but is thread-safe and multi-threaded. /summary> More...

Inheritance diagram for Deveel.Data.Protocol.DefaultLocalBootable:

Classes
class	LocalDatabaseInterface
	A local implementation of DatabaseInterface that will dispose the parent ILocalBootable object when the last open connection is disposed. More...

Public Member Functions
	DefaultLocalBootable (DbController controller, string databaseName)
IDatabaseInterface	Create (string username, string password, IDbConfig config)
IDatabaseInterface	Boot (IDbConfig config)
bool	CheckExists (IDbConfig config)
IDatabaseInterface	Connect ()

Properties
bool	IsBooted [get]

Private Member Functions
IDatabase IDatabaseHandler.	GetDatabase (string name)

Private Attributes
readonly DbController	controller
readonly string	databaseName
bool	booted
	Set to true if the database is booted. More...
Control.DbSystem	dbsys
	The local DbSystem database object. More...
int	connectId
	The connection id. More...
int	openConnections
	The number of connections that are current open. More...

Detailed Description

A bootable object that filters through to a DatabaseInterface but is thread-safe and multi-threaded. /summary>

This is to be used when you have a local client accessing a stand-alone database.

Definition at line 31 of file DefaultLocalBootable.cs.

Constructor & Destructor Documentation

Deveel.Data.Protocol.DefaultLocalBootable.DefaultLocalBootable ( DbController  controller, string  databaseName  )

inline

Definition at line 32 of file DefaultLocalBootable.cs.

                                                                                  {
            this.controller = controller;
            this.databaseName = databaseName;
        }

Member Function Documentation

IDatabaseInterface Deveel.Data.Protocol.DefaultLocalBootable.Boot ( IDbConfig  config )

inline

Definition at line 93 of file DefaultLocalBootable.cs.

                                                         {
            if (booted)
                throw new DataException("Database was booted more than once.");

            // Local connections are formatted as;
            // 'Local/[type]/[connect_id]'
            string hostString = String.Format("{0}/Boot/", KnownConnectionProtocols.Local);

            // Start the DbSystem and bind it to a IDatabaseInterface.
            if (controller.IsInitialized(databaseName))
                dbsys = controller.ConnectToDatabase(config, databaseName);
            else
                dbsys = controller.StartDatabase(config, databaseName);

            IDatabaseInterface dbInterface = new LocalDatabaseInterface(this, hostString);

            booted = true;
            ++openConnections;

            return dbInterface;
        }

bool Deveel.Data.Protocol.DefaultLocalBootable.CheckExists ( IDbConfig  config )

inline

Definition at line 116 of file DefaultLocalBootable.cs.

                                                  {
            if (booted)
                throw new DataException("The database is already booted.");

            return controller.DatabaseExists(config, databaseName);
        }

IDatabaseInterface Deveel.Data.Protocol.DefaultLocalBootable.Connect ( )

inline

Definition at line 129 of file DefaultLocalBootable.cs.

                                            {
            if (!booted)
                throw new DataException("The database is not started.");

            // Local connections are formatted as;
            // 'Local/[type]/[connect_id]'
            string hostString = String.Format("{0}/Connection/{1}", KnownConnectionProtocols.Local, connectId);

            // Create a IDatabaseInterface,
            IDatabaseInterface dbInterface = new LocalDatabaseInterface(this, hostString);

            ++connectId;
            ++openConnections;

            return dbInterface;
        }

IDatabaseInterface Deveel.Data.Protocol.DefaultLocalBootable.Create ( string  username, string  password, IDbConfig  config  )

inline

Definition at line 65 of file DefaultLocalBootable.cs.

                                                                                             {
            if (String.IsNullOrEmpty(username) || 
                String.IsNullOrEmpty(password))
                throw new DataException("Username and Password must both be set.");

            if (booted)
                throw new DataException("Database is already created.");

            // Local connections are formatted as;
            // 'Local/[type]/[connect_id]'
            string hostString = String.Format("{0}/Create/", KnownConnectionProtocols.Local);

            // Create the DbSystem and bind it to a IDatabaseInterface.
            dbsys = controller.CreateDatabase(config, databaseName, username, password);
            IDatabaseInterface dbInterface = new LocalDatabaseInterface(this, hostString);

            booted = true;
            ++openConnections;

            return dbInterface;
        }

IDatabase IDatabaseHandler. Deveel.Data.Protocol.DefaultLocalBootable.GetDatabase ( string  name )

inlineprivate

Implements Deveel.Data.IDatabaseHandler.

Definition at line 88 of file DefaultLocalBootable.cs.

                                                            {
            return (dbsys == null ? null : dbsys.Database);
        }

Member Data Documentation

bool Deveel.Data.Protocol.DefaultLocalBootable.booted

private

Set to true if the database is booted.

Definition at line 43 of file DefaultLocalBootable.cs.

int Deveel.Data.Protocol.DefaultLocalBootable.connectId

private

The connection id.

This is incremented by 1 each time an interface connects to the local runtime.

Definition at line 57 of file DefaultLocalBootable.cs.

readonly DbController Deveel.Data.Protocol.DefaultLocalBootable.controller

private

Definition at line 37 of file DefaultLocalBootable.cs.

readonly string Deveel.Data.Protocol.DefaultLocalBootable.databaseName

private

Definition at line 38 of file DefaultLocalBootable.cs.

Control.DbSystem Deveel.Data.Protocol.DefaultLocalBootable.dbsys

private

The local DbSystem database object.

Definition at line 48 of file DefaultLocalBootable.cs.

int Deveel.Data.Protocol.DefaultLocalBootable.openConnections

private

The number of connections that are current open.

Definition at line 62 of file DefaultLocalBootable.cs.

Property Documentation

bool Deveel.Data.Protocol.DefaultLocalBootable.IsBooted

get

Definition at line 124 of file DefaultLocalBootable.cs.

---

The documentation for this class was generated from the following file:

• /var/calculate/remote/distfiles/egit-src/deveeldb.git/src/deveeldb/Deveel.Data.Protocol/DefaultLocalBootable.cs