Dokumentace třídy CClientConnection

klientská část komunikačního rozhraní ...

#include <ClientConn.h>

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

Veřejné metody
	CClientConnection (unsigned uiTimeout)
	konstruktor ...
virtual	~CClientConnection ()
	destruktor
int	OpenSession (void)
	otevření sezení ...
int	SessionCmd (CCommand *cCmd, unsigned uiAddTimeout=0)
	vykonání příkazu v rámci sezení ...
int	CloseSession (void)
	uzavření sezení ...
int	Process (CCommand *cCmd, unsigned uiAddTimeout=0)
	vykonání příkazu na serveru ...

Chráněné metody
virtual bool	ConnectServer (void)=0
	připojení k serveru ...
virtual void	DisconnectServer (void)=0
	odpojení od serveru
virtual bool	Write (const CCommand *cCmd)=0
	odeslání příkazu ...
virtual bool	Wait (unsigned uiTimeout)=0
	čekání na odpověď ...
virtual bool	Read (CCommand *cCmd)=0
	vyzvednutí odpovědi ...

Detailní popis

klientská část komunikačního rozhraní

Třída slouží jako společné rozhraní pro klientskou část komunikace, nezávisle na konkrétním způsobu transportu příkazů. Konkrétní realizace musí být dokončena v potomcích tohoto rozhraní.

Klient může příkazy vykonávat ve dvou režimech:

• jednotlivě - viz metoda Process,
• dávkově v rámci sezení (session). Sezení je potřeba nejprvě otevřít, pak je možné provádět jednotlivé příkazy dle potřeby a nakonec se sezení uzavře (viz OpenSession, SessionCmd a CloseSession).

Dokumentace konstruktoru a destruktoru

CClientConnection::CClientConnection

(

unsigned

uiTimeout

)

konstruktor

Parametry

[in]

uiTimeout

maximální doba v milisekundách, po kterou klient čeká na odpověď od serveru

Dokumentace k metodám

int CClientConnection::CloseSession

(

void

)

uzavření sezení

Otevřené sezení je uzavřeno a spojení se serverem ukončeno.

Návratová hodnota

výsledek - nenulová hodnota značí chybu
Seznam chybových kódů s vysvětlením zde.

virtual bool CClientConnection::ConnectServer ( void  )

protectedpure virtual

připojení k serveru

Návratová hodnota

úspěch operace

Implementováno v CClientMsg a CClientTcp.

int CClientConnection::OpenSession

(

void

)

otevření sezení

Provede se připojení k serveru a inicializace sezení. Případně otevřené předchozí sezení je ukončeno.

Návratová hodnota

výsledek - nenulová hodnota značí chybu
Seznam chybových kódů s vysvětlením zde.

int CClientConnection::Process	(	CCommand *	cCmd,
		unsigned	uiAddTimeout = 0
	)

vykonání příkazu na serveru

Klient postupně provede následující operace:

• připojí se k serveru
• odešle příkaz na server
• po dobu určeného časového limitu čeká na odpověď
• přijme odpověď a příslušně ji zformátuje
• ukončí spojení se serverem Pro vykonání jednotlivých operací volá příslušné metody, které jsou implementovány podle druhu transportu.

  Parametry

  [in,out]	cCmd	třída CCommand obsahující data příkazu a stavové slovo
  [in]	uiAddTimeout	dodatečný časový limit pro vykonání příkazu v milisekundách (přičítá se k základní hodnotě definované v kontruktoru třídy)

  Návratová hodnota

  výsledek - nenulová hodnota značí chybu
  Seznam chybových kódů s vysvětlením zde. Pokud je metoda vyvolána v době aktivního sezení, je po návratu sezení ukončeno.

virtual bool CClientConnection::Read ( CCommand *  cCmd )

protectedpure virtual

vyzvednutí odpovědi

Parametry

[in]

cCmd

třída pro uložení přijatých dat a stavového slova

Návratová hodnota

úspěch operace

Implementováno v CClientMsg a CClientTcp.

int CClientConnection::SessionCmd	(	CCommand *	cCmd,
		unsigned	uiAddTimeout = 0
	)

vykonání příkazu v rámci sezení

Klient pomocí chráněných metod postupně provede následující operace:

• odešle příkaz na server
• po dobu určeného časového limitu čeká na odpověď
• přijme odpověď a příslušně ji zformátuje

  Parametry

  [in,out]	cCmd	třída CCommand obsahující data příkazu a stavové slovo
  [in]	uiAddTimeout	dodatečný časový limit pro vykonání příkazu v milisekundách (přičítá se k základní hodnotě definované v kontruktoru třídy)

  Návratová hodnota

  výsledek - nenulová hodnota značí chybu
  Seznam chybových kódů s vysvětlením zde.

virtual bool CClientConnection::Wait ( unsigned  uiTimeout )

protectedpure virtual

čekání na odpověď

Návratová hodnota

true v případě, že během požadovaného časového limitu byla přijata odpověď od serveru

Implementováno v CClientMsg a CClientTcp.

virtual bool CClientConnection::Write ( const CCommand *  cCmd )

protectedpure virtual

odeslání příkazu

Parametry

[in]

cCmd

příkaz k odeslání

Návratová hodnota

úspěch operace

Implementováno v CClientMsg a CClientTcp.

---

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

• Client/ClientConn.h