Eine einfache TCP-Clientklasse, welche ihr KnowHow in den abgeleiteten Klassen lernen soll. Mehr ...

#include <TcpClient.h>

Klassendiagramm für tcp::Client:

[Legende]

Zusammengehörigkeiten von tcp::Client:

[Legende]

Öffentliche Methoden
	Client (const std::string &rsHostname, unsigned int uiPort, int iAdressFamily, int iSocketType, int iProtocol, int iSecTimeOut)

	Client (const std::string &rsHostname, unsigned int uiPort, int iAdressFamily, int iSocketType, int iProtocol, unsigned int uiDataSize, int iSecTimeOut)

virtual	~Client ()

virtual void	cancel () override

virtual void	setDataSize (unsigned int uiDataSize) override

int	connectServer ()

virtual int	disconnectServer ()

bool	isServerConnected () const

virtual int	send (char *pszRawMsg, unsigned int uiRawMsgSize, unsigned int uiMessageID=0, int iActionCode=0, const std::string &rsInfo="")

virtual int	send (Message *pTcpMessage) override

int	acceptServerMessage (Message *pTcpServerMessage)

int	getSocketAdrFromString (SOCKADDR_IN *Socketadress, const std::string &rsHostnameOrIp) const

std::string	getHostName () const

int	getPeerName (std::string &rsIPAdress, unsigned int &ruiPort) const

ActionCode	getWaitingServerMsgActionCode () const

Öffentliche Methoden geerbt von tcp::TcpMain
	TcpMain (unsigned int uiPort, int iAdressFamily, int iSocketType, int iProtocol, int iSecTimeOut)

	TcpMain (unsigned int uiPort, int iAdressFamily, int iSocketType, int iProtocol, unsigned int uiDataSize, int iSecTimeOut)

virtual	~TcpMain ()

unsigned int	getPortNum () const

unsigned int	getDataSize () const

SOCKET	getMainSocket () const

void	setTimeOutSec (int iSecTimeOut)

int	TimeOutSec ()

Öffentliche Methoden geerbt von eut::RepeatingThread
	RepeatingThread ()

virtual	~RepeatingThread ()

virtual int	start ()

bool	testCancel ()

RepeatingThread::STATUS	status () const

bool	isInExclusiveAccess () const

void	setExclusiveAccess ()

void	unsetExclusiveAccess ()

int	getBreakCounter ()

virtual void	takeABreak ()

virtual void	finishBreak ()

void	waitForInput ()

void	signalInput ()

Geschützte Methoden
	Client ()

	Client (unsigned int, int, int, int, int)

virtual void	work () override

virtual Transmitter *	generateNewTransmitter ()

virtual ClientReceiver *	generateNewReceiver ()

virtual void	processServerMessage (Message *pTcpMessage)

virtual int	syncDataSize ()

Geschützte Methoden geerbt von tcp::TcpMain
	TcpMain ()

void	setWSACleanup () const

int	startWinsock () const

Geschützte Methoden geerbt von eut::RepeatingThread
void	threadWork ()

void	setStatus (STATUS eStatus)

STATUS	getStatus ()

void	toOrder (ORDER eOrder)

ORDER	getOrder ()

Geschützte Attribute
ClientReceiver *	m_pReceiver

Transmitter *	m_pTransmitter

Geschützte Attribute geerbt von tcp::TcpMain
int	m_iSecTimeOut

unsigned int	m_uiServerPort

unsigned int	m_uiDataSize

int	m_iAdressFamily

int	m_iSocketType

int	m_iProtocol

SOCKET	m_MainSocket

Private Methoden
	Client (const Client &)

Client &	operator= (const Client &)

Private Attribute
SOCKADDR_IN	m_Socketadress

std::string	m_sHostname

std::queue< Message * >	m_MsgQueue

ActionCode	m_eToWaitingForServer

Weitere Geerbte Elemente
Öffentliche Typen geerbt von eut::RepeatingThread
enum	EuTHREADERROR { EuTHREAD_ERR_NO_THREAD = -10301 , EuTHREAD_ERR_THREAD_ALREADY_WORKING = -10302 , EuTHREAD_ERR_THREAD_BREAK_COUNT_LESS_THAN_ZERO = -10303 , EuTHREAD_ERR_UNKNOWN = -10400 }
	Fehlerbereich = -10301 bis -10400 Mehr ...

enum	STATUS { eAT_THE_START , eWORKING , ePAUSING , eENDING , eCOMPLETED }

enum	ORDER { eUNDEFINED , eDO_WORK , eEXIT }

Ausführliche Beschreibung

Eine einfache TCP-Clientklasse, welche ihr KnowHow in den abgeleiteten Klassen lernen soll.

Client läuft als Thread, welcher Verbindung zu einem Socket-Server aufnehmen kann.

Client hat als Oberklassen-Attribute den Port, die Datengröße welche versendet wird, die Adressfamilie, den Sockettyp, den Protokoltyp und einen MainSocket (hier den Verbindungssocket zum Server).

Zusätzlich sind hier als Attribute ein ClientReceiver, welcher die Daten vom Server als Thread bearbeitet, ein Transmitter, welcher Daten an den Server sendet, die Socketadresse, der Hostname und eine MsgQueue, welche die einzelnen Messages des ClientReceiver aufnimmt.

Start des Clients:

Bei der instanziierung mit Übergabe von Hostname, Port, Adressfamilie, Sockettyp, Protokol und optional der Datengröße, wird zuerst einmal die Socketadresse anhand des übergebenen Hostnamen ermittelt und der eigene Thread gestartet.

Mit dem Server verbinden:

Es wird versucht, mit dem Server über die Client-Methode Client::connectServer() Kontakt aufzunehem. Wenn dieses gelingt, werden der ClientReceiver und Transmitter instanziiert und gestartet (auch diese sind Threads).

Der Client wartet in Client::work() auf Daten vom Server (lauscht blockierent).

Abbruch der Verbindung durch den Server:

Der Socket wird im ClientReceiver in ClientReceiver::work() freigegeben. Wenn Fehler < 0, dann ist die Verbindung abgebrochen.

Daten vom Server verarbeiten:

Es wird über ClientReceiver::generateNewTcpMessage (...) eine tcp::Message bzw. abgeleitete Message erstellt und an ClientReceiver::acceptMessage(AbstractMessage*) weitergegeben.
Diese Methode kann überschrieben werden; der ClientReceiver reicht die Message lediglich an seinen Parent (Client oder Unterklasse) Client::acceptServerMessage() weiter. Dort wird die Message in die MsgQueue des Clients eingefügt und in Client::work() weiterverarbeitet und an die Clientmethode Client::processServerMessage(Message *) weitergeleitet, welche hier anschließend die Message löscht; auch diese Methode kann überschrieben werden.

Senden an den Server:

Gesendet wird über Client::send (...) (kann in Unterklassen überschrieben werden) welche die Daten hier in eine tcp::Message packt und an Transmitter::acceptOrder (...) zum weiterverarbeiten übergibt, der diese Daten dann an den Server sendet.

Beenden der Verbindung zu Server:

Über Client::disconnectServer() wird die Verbindung zum Server abgebaut. Es werden der ClientReceiver und Transmitter entfernt. Ein erneutes connect ist möglich.

Siehe auch: MyTestClient

Copyright: © 2010 Helmut Jakoby

Autor: Helmut Jakoby

Beschreibung der Konstruktoren und Destruktoren

◆ Client() [1/5]

tcp::Client::Client ( )

protected

Dieser Konstruktor steht niccht zur Verfügung.

◆ Client() [2/5]

tcp::Client::Client	(	unsigned int	,
		int	,
		int	,
		int	,
		int	)

protected

Dieser Konstruktor steht niccht zur Verfügung.

◆ Client() [3/5]

tcp::Client::Client	(	const std::string &	rsHostname,
		unsigned int	uiPort,
		int	iAdressFamily,
		int	iSocketType,
		int	iProtocol,
		int	iSecTimeOut )

Der Konstruktor startet den Client, ist aber noch nicht mit dem Server aus rsHostname verbunden.

Parameter

[in]	rsHostname	Der Hostname oder IP-Adresse (z.B. "LOCALHOST" oder "192.168.2.102").
[in]	uiPort	Der Port des Servers.
[in]	iAdressFamily	Die Socket-AdressFamily um einen Socket zu instanziieren (i.d.R. AF_INET).
[in]	iSocketType	Der Socket-Typ (i.d.R. SOCK_STREAM).
[in]	iProtocol	Das Socket-Protokol (i.d.R. 0).
[in]	iSecTimeOut	Die Zeit bis ein Warten auf eine Verbindung bzw. warten auf Daten abgebrochen wird.

Ausnahmebehandlung

eut::ErrorNException Bei einem Fehler wird eine Exception geworfen.

◆ Client() [4/5]

tcp::Client::Client	(	const std::string &	rsHostname,
		unsigned int	uiPort,
		int	iAdressFamily,
		int	iSocketType,
		int	iProtocol,
		unsigned int	uiDataSize,
		int	iSecTimeOut )

Der Konstruktor startet den Client, ist aber noch nicht mit dem Server aus rsHostname verbunden.

Parameter

[in]	rsHostname	Der Hostname oder IP-Adresse (z.B. "LOCALHOST" oder "192.168.2.102").
[in]	uiPort	Der Port des Servers.
[in]	iAdressFamily	Die Socket-AdressFamily um einen Socket zu instanziieren (i.d.R. AF_INET).
[in]	iSocketType	Der Socket-Typ (i.d.R. SOCK_STREAM).
[in]	iProtocol	Das Socket-Protokol (i.d.R. 0).
[in]	uiDataSize	Die Paketgröße.
[in]	iSecTimeOut	Die Zeit bis ein Warten auf eine Verbindung bzw. warten auf Daten abgebrochen wird.

Ausnahmebehandlung

eut::ErrorNException Bei einem Fehler wird eine Exception geworfen.

◆ ~Client()

virtual tcp::Client::~Client ( )

virtual

Im Destruktor wird die Verbindung zum Server abgebrochen wenn noch nicht geschehen.

◆ Client() [5/5]

tcp::Client::Client ( const Client & )

private

Der Copy-Konstruktor steht nicht zur Verfügung.

Dokumentation der Elementfunktionen

◆ acceptServerMessage()

int tcp::Client::acceptServerMessage ( Message * pTcpServerMessage )

Es wird die übergebene Message, i.d.R. vom Server über den ClientReceiver in die MsgQueue eingefügt und somit verarbeitet.

Parameter

[in] pTcpServerMessage Die erhaltene Nachricht vom Server.

Rückgabe: Eine Rückgabe < 0 zeigt einen Fehler an.

◆ cancel()

virtual void tcp::Client::cancel ( )

overridevirtual

Wenn der Thread beendet wirde, wird diese virtuale Methode aufgerufen. Hier wird die MsgQueue aufgeräumt.

Erneute Implementation von eut::RepeatingThread.

◆ connectServer()

int tcp::Client::connectServer ( )

Verbindet sich mit dem Server.

Rückgabe: Eine Rückgabe < 0 zeigt einen Fehler an.

◆ disconnectServer()

virtual int tcp::Client::disconnectServer ( )

virtual

Beendet die Verbindung mit dem Server.

Rückgabe: Eine Rückgabe < 0 zeigt einen Fehler an.

◆ generateNewReceiver()

virtual ClientReceiver * tcp::Client::generateNewReceiver ( )

protectedvirtual

Liefert hier einen ClientReceiver; kann in Unterklassen überschrieben werden um ggf. einen abgeleiteten Typ von ClientReceiver zu liefern.

Rückgabe: Zeiger auf den zu nutzenden Leser (dieser empfängt Daten von einem Server) für diesen Client

Achtung: Diese Methode wird intern genutzt und das auf dem Heap instanziierte Objekt auch intern wieder aus dem Speicher entfernt.

◆ generateNewTransmitter()

virtual Transmitter * tcp::Client::generateNewTransmitter ( )

protectedvirtual

Liefert hier einen Transmitter; kann in Unterklassen überschrieben werden um ggf. einen abgeleiteten Typ von Transmitter zu liefern.

Rückgabe: Zeiger auf den zu nutzenden Schreiber (dieser sendet Daten an einen Server) für diesen Client.

Achtung: Diese Methode wird intern genutzt und das auf dem Heap instanziierte Objekt auch intern wieder aus dem Speicher entfernt.

◆ getHostName()

std::string tcp::Client::getHostName ( ) const

Liefert den Hostname oder IP-Adresse (z.B. "LOCALHOST" oder "192.168.2.102") aus m_sHostname.

Rückgabe: s.o.

◆ getPeerName()

int tcp::Client::getPeerName	(	std::string &	rsIPAdress,
		unsigned int &	ruiPort ) const

Liefert die IP-Adresse und den Port.

Parameter

[in,out]	rsIPAdress	Die IP-Adresse (z.B. "192.168.2.102").
[in,out]	ruiPort	Der Port welcher angesprochen wird.

Rückgabe: Eine Rückgabe < 0 zeigt einen Fehler an.

◆ getSocketAdrFromString()

int tcp::Client::getSocketAdrFromString	(	SOCKADDR_IN *	Socketadress,
		const std::string &	rsHostnameOrIp ) const

Liefert den Hostnamen als IP-Adresse.

Parameter

[in,out]	Socketadress	In dieser Struktur wird die IP-Adresse geliefert.
[in]	rsHostnameOrIp	Der Hostname (z.B. "LOCALHOST").

Rückgabe: Eine Rückgabe < 0 zeigt einen Fehler an.

◆ getWaitingServerMsgActionCode()

ActionCode tcp::Client::getWaitingServerMsgActionCode ( ) const

Liefert den ActionCode der Message, auf die gewartet wird.

Rückgabe: s.o.

◆ isServerConnected()

bool tcp::Client::isServerConnected ( ) const

Gibt Auskunft, ob mit dem Server verbunden.

Rückgabe: Wenn true, dann besteht eine Verbindung.

◆ operator=()

Client & tcp::Client::operator= ( const Client & )

private

Der Zuweisungsoperator steht nicht zur Verfügung.

◆ processServerMessage()

virtual void tcp::Client::processServerMessage ( Message * pTcpMessage )

protectedvirtual

Soll in Unterklassen die Nachricht vom Server verarbeiten. In den überschriebenen Methoden mus immer diese Methode aufgerufen werden, weil hier u.a. die übergebene Message aus dem Speicher entfernt wird.

Parameter

[in] pTcpMessage Die zu verarbeitende Nachricht vom Server.

Erneute Implementation in MyTestClient.

◆ send() [1/2]

virtual int tcp::Client::send	(	char *	pszRawMsg,
		unsigned int	uiRawMsgSize,
		unsigned int	uiMessageID = 0,
		int	iActionCode = 0,
		const std::string &	rsInfo = "" )

virtual

Sendet die übergebene Daten in einer Message über seinen Transmitter an den Server.

Parameter

[in]	pszRawMsg	Zeiger auf die zu sendenden Daten.
[in]	uiRawMsgSize	Die Größe der zu sendenden Daten.
[in]	uiMessageID	Es kann eine MessageID übergeben werden.
[in]	iActionCode	Es kann ein ActionCode übergeben werden.
[in]	rsInfo	Es kann eine freie Info übergeben werden.

Rückgabe: Eine Rückgabe < 0 zeigt einen Fehler an.

Achtung: Es werden die Daten in pszRawMsg intern aus dem Speicher entfernt; die aufrufende Instanz darf die zu sendenden Daten nicht mehr verwenden oder aus dem Speicher entfernen.

◆ send() [2/2]

virtual int tcp::Client::send ( Message * pTcpMessage )

overridevirtual

Sendet übergebene Message über seinen Transmitter an den Server.

Parameter

[in] pTcpMessage Das zu sendende Nachrichtenpacket.

Rückgabe: Eine Rückgabe < 0 zeigt einen Fehler an.

Achtung: Die übergebene Message darf von der aufrufenden Instanz nicht aus dem Speicher entfernt werden! Da die Message zur Weiterverarbeitung an den Transmitter gegeben wird, und dieser entscheidet wann gesendet wird. Darum wird dieser auch die Message aus dem Speicher entfernen.

Implementiert tcp::TcpMain.

◆ setDataSize()

virtual void tcp::Client::setDataSize ( unsigned int uiDataSize )

overridevirtual

Setzt die Paketgröße.

Parameter

[in] uiDataSize Die Paketgröße.

Erneute Implementation von tcp::TcpMain.

◆ syncDataSize()

virtual int tcp::Client::syncDataSize ( )

protectedvirtual

Synchronisiert die Datengröße mit dem Server.

Rückgabe: Ein Rückgabewert < 0 zeigt einen Fehler an.

◆ work()

virtual void tcp::Client::work ( )

overrideprotectedvirtual

Arbeit des Threads. Es wird eine erhaltene Message an Methode Client::processServerMessage(Message * pTcpMessage) weitergereicht.

Implementiert eut::RepeatingThread.

Dokumentation der Datenelemente

◆ m_eToWaitingForServer

ActionCode tcp::Client::m_eToWaitingForServer

private

Wenn dieser Wert ungleich ACTION_UNDEF, wird in Client::work() jede Message, welche nicht diesen ActionCode hat, wieder in die MsgQueue angehängt. Somit wird in Client::work() auf die Message mit diesem ActionCode gewartet.

Wenn dann, in Client::work(), die Message mit dem diesem ActionCode eintrifft, wird m_eToWaitingForServer wieder auf ACTION_UNDEF gesetzt und die Message zur Weiterverarbeitung an Client::processServerMessage (...) weiter gereicht.

◆ m_MsgQueue

std::queue<Message *> tcp::Client::m_MsgQueue

private

Die Queue mit den empfangenen Daten vom Server.

◆ m_pReceiver

ClientReceiver* tcp::Client::m_pReceiver

protected

Der Leser empfängt Daten von einem Server für diesen Client.

Siehe auch: ClientReceiver

◆ m_pTransmitter

Transmitter* tcp::Client::m_pTransmitter

protected

Der Schreiber sendet Daten an einen Server für diesen Client.

Siehe auch: Transmitter

◆ m_sHostname

std::string tcp::Client::m_sHostname

private

Der Hostname oder IP-Adresse (z.B. "LOCALHOST" oder "192.168.2.102").

◆ m_Socketadress

SOCKADDR_IN tcp::Client::m_Socketadress

private

Die Adressstruktur.

Die Dokumentation für diese Klasse wurde erzeugt aufgrund der Datei:

TcpClient.h

Öffentliche Methoden

Geschützte Methoden

Geschützte Attribute

Private Methoden

Private Attribute

Weitere Geerbte Elemente

Ausführliche Beschreibung

Start des Clients:

Mit dem Server verbinden:

Abbruch der Verbindung durch den Server:

Daten vom Server verarbeiten:

Senden an den Server:

Beenden der Verbindung zu Server:

Beschreibung der Konstruktoren und Destruktoren

◆ Client() [1/5]

◆ Client() [2/5]

◆ Client() [3/5]

◆ Client() [4/5]

◆ ~Client()

◆ Client() [5/5]

Dokumentation der Elementfunktionen

◆ acceptServerMessage()

◆ cancel()

◆ connectServer()

◆ disconnectServer()

◆ generateNewReceiver()

◆ generateNewTransmitter()

◆ getHostName()

◆ getPeerName()

◆ getSocketAdrFromString()

◆ getWaitingServerMsgActionCode()

◆ isServerConnected()

◆ operator=()

◆ processServerMessage()

◆ send() [1/2]

◆ send() [2/2]

◆ setDataSize()

◆ syncDataSize()

◆ work()

Dokumentation der Datenelemente

◆ m_eToWaitingForServer

◆ m_MsgQueue

◆ m_pReceiver

◆ m_pTransmitter

◆ m_sHostname

◆ m_Socketadress