Dokumentace třídy CAdmin

správcovské rozhraní databáze ...

#include <Admin.h>

Diagram dědičnosti pro třídu CAdmin

Veřejné metody
virtual	~CAdmin ()=0
	destruktor ...
virtual bool	Backup (std::ostream *cStream)=0
	záloha databáze ...
virtual bool	Info (RDbInfo *prInfo)=0
	informace o databázi ...
virtual void	OnStart (void)=0
	akce při spuštění serveru ...
virtual void	OnStop (void)=0
	akce při zastavení serveru ...

Detailní popis

správcovské rozhraní databáze

Třída poskytuje deklaraci (čistě virtuálních) metod určených pro správu databáze. Každá implementace databáze musí kromě kromě klientského rozhraní CQuery definovat i metody pro její správu. Na rozdíl od zmíněného klientského rozhraní se nepředpokládá vzdálené (meziprocesové) volání metod rozhraní pro správu.

Dokumentace konstruktoru a destruktoru

CAdmin::~CAdmin ( )

inlinepure virtual

destruktor

Destruktor je deklarován jako virtuální, sám neprovádí žádnou činnost.

Dokumentace k metodám

virtual bool CAdmin::Backup ( std::ostream *  cStream )

pure virtual

záloha databáze

Provedení zálohy databáze do výstupního proudu je konzistentním zachycením jejího obrazu v nějakém okamžiku. K tomu získá výhradní přístup k databázi (pro CMemoryDb viz Zamykání položek databáze v operační paměti).

Parametry

[in]

cStream

výstupní proud pro provedení zálohy. Předpokládá se, že proud je již otevřen do režimu umožňující binární zápis dat. Přitom je lhostejno, zda je spojen se souborem, TCP soketem či jiným zařízením. Po dokončení operace není proud uzavřen (je pouze synchronizován), to musí učinit volající.

Návratová hodnota

výsledek operace

Poznámka

Problematika zálohování databáze, obnovy dat, jejich formátu atd. je podrobněji popsána na zvláštní stránce.

Implementováno v CMemoryDb.

virtual bool CAdmin::Info ( RDbInfo *  prInfo )

pure virtual

informace o databázi

Získání počtu objektů jednotlivých typů v databázi.

Parametry

[in]

prInfo

ukazatel na struktutu, která bude naplněna požadovanými údaji.

Návratová hodnota

výsledek operace

Implementováno v CMemoryDb.

virtual void CAdmin::OnStart ( void  )

pure virtual

akce při spuštění serveru

Uživatelská akce (specifická dle druhu použité databáze), která se provádí těsně před spuštěním komunikačních serverů - příkaz START.

Implementováno v CMemoryDb.

virtual void CAdmin::OnStop ( void  )

pure virtual

akce při zastavení serveru

Uživatelská akce (specifická dle druhu použité databáze), která se provádí těsně po zastavení komunikačních serverů - příkaz STOP.

Implementováno v CMemoryDb.

---

Dokumentace pro tuto třídu byla generována z následujícího souboru:

• Server/Admin.h