Dokumentace třídy CSocketEndpoint

obsluha TCP zakončení ...

#include <SocketEndpoint.h>

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

Veřejné metody
	CSocketEndpoint (const char *pszLocation)
	konstruktor ...
	~CSocketEndpoint ()
	destruktor ...
SOCKET	Socket (void) const
	popisovač soketu ...
bool	Valid (void) const
	platnost soketu ...
void	Address (sockaddr_in *prAddress)
	naplnění struktury IP adresou a portem ...
void	OpenSocket (void)
	otevření soketu ...
void	CloseSocket (void)
	uzavření soketu
int	Send (const char *pcData, unsigned uiLength)
	odeslání dat ...
int	Receive (char *pcData, unsigned uiLength)
	příjem dat ...

Detailní popis

obsluha TCP zakončení

Třída zapozdřuje společné vlastnosti přijímací a vysílací části soketu, pomocí kterých probíhá vzájemná komunikace.

Dokumentace konstruktoru a destruktoru

CSocketEndpoint::CSocketEndpoint

(

const char *

pszLocation

)

konstruktor

Provádí inicializaci knihovny pro podporu soketů ve Windows a převádí požadované URL na IP adresu a port pomocí DNS.

Parametry

[in]

pszLocation

definice místa svázaného s vnitřním soketem třídy Definice místa se skládá z adresy a volielného portu odděleného dvojtečkou. Defaultní port je určen konstantou TCP_DEFAULT_PORT. Adresa může být v číselném formátu nebo je určena pomocí doménového jména. Příklady rozeznávaných formátů: "localhost" - spojení na místní smyčce a defaultním portu, "127.0.0.1:25100" - spojení na místní smyčce a portu 25100, ":25100" "*:25100" - spojení na libovolné adrese počítače a portu 25100, což má smysl pro naslouchací soket na straně serveru, "comp32.company.tld" - místo určené doménovým jménem, port defaultní.

CSocketEndpoint::~CSocketEndpoint

(

)

destruktor

Uzavírá případně otevřený soket a ukončuje práci se soketovou knihovnou.

Dokumentace k metodám

void CSocketEndpoint::Address

(

sockaddr_in *

prAddress

)

naplnění struktury IP adresou a portem

Parametry

[out]

prAddress

adresa struktury pro naplnění údaji získanými při volání konstruktoru

void CSocketEndpoint::OpenSocket

(

void

)

otevření soketu

IP adresa a port jsou definovány při volání konstruktoru, na jejich základě je otevřen soket pro komunikaci pomocí TCP a jsou nastaveny jeho základní vlastnosti.

int CSocketEndpoint::Receive	(	char *	pcData,
		unsigned	uiLength
	)

příjem dat

Pomocí vnitřního soketu jsou přijímána data (větší rozsah po blocích) a ukládána do určené paměti.

Parametry

[out]	pcData	adresa bloku paměti k uložení přijatých dat
[in]	uiLength	délka bloku paměti (tj. maximálně možný počet bytů k uložení)

Návratová hodnota

velikost skutečně přijatých dat (0 v případě chyby, např. neotevření soketu apod.)

int CSocketEndpoint::Send	(	const char *	pcData,
		unsigned	uiLength
	)

odeslání dat

Data jsou odesílána pomocí vnitřního soketu, není prováděna žádná jiná manipulace se soketem. Větší rozsah dat se odesílá po blocích.

Parametry

[in]	pcData	adresa bloku dat k odeslání
[in]	uiLength	délka dat

Návratová hodnota

velikost skutečně odeslaných dat (0 v případě chyby, např. neotevření soketu apod.)

SOCKET CSocketEndpoint::Socket

(

void

)

const

popisovač soketu

Návratová hodnota

popisovač platného soketu nebo INVALID_SOCKET

bool CSocketEndpoint::Valid

(

void

)

const

platnost soketu

Návratová hodnota

true, pokud je vnitřní soket otevřen a platný

---

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

• Common/SocketEndpoint.h