tcp::Transmitter Klassenreferenz

Eine Klasse, welche über ein SOCKET mit einem Client oder Server kommunizieret und Senddaten vom Typ Message erwartet. Mehr ...

#include <TcpTransmitter.h>

Klassendiagramm für tcp::Transmitter:

Zusammengehörigkeiten von tcp::Transmitter:

Öffentliche Methoden
	Transmitter (SOCKET Socket)
virtual	~Transmitter ()
virtual void	cancel () override
int	acceptOrder (Message *pTcpMessage)
Öffentliche Methoden geerbt von tcp::ReceiverTransmitter
	ReceiverTransmitter (SOCKET Socket)
virtual	~ReceiverTransmitter ()
virtual void	takeABreak () override
virtual void	finishBreak () override
int	getPeerName (std::string &rstrIPAdress, unsigned int &ruiPort) const
SOCKET	Socket () const
Ö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 ()
void	waitForInput ()
void	signalInput ()

Geschützte Methoden
	Transmitter ()
virtual void	work () override
Geschützte Methoden geerbt von tcp::ReceiverTransmitter
	ReceiverTransmitter ()
Geschützte Methoden geerbt von eut::RepeatingThread
void	threadWork ()
void	setStatus (STATUS eStatus)
STATUS	getStatus ()
void	toOrder (ORDER eOrder)
ORDER	getOrder ()

Private Methoden
	Transmitter (const Transmitter &)
Transmitter &	operator= (const Transmitter &)

Private Attribute
std::queue< Message * >	m_MsgQueue

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 }
Geschützte Attribute geerbt von tcp::ReceiverTransmitter
SOCKET	m_Socket

Ausführliche Beschreibung

Eine Klasse, welche über ein SOCKET mit einem Client oder Server kommunizieret und Senddaten vom Typ Message erwartet.

Copyright

© 2010 Helmut Jakoby

Autor

Helmut Jakoby

Beschreibung der Konstruktoren und Destruktoren

Transmitter() [1/3]

tcp::Transmitter::Transmitter ( )

protected

Der Standard-Konstruktor steht niccht zur Verfügung.

Transmitter() [2/3]

tcp::Transmitter::Transmitter

(

SOCKET

Socket

)

Konstruktor mit Parameterübergabe.

Parameter

[in]

Socket

Socket über den kommuniziert wird.

Ausnahmebehandlung

eut::ErrorNException

Bei einem Fehler wird eine Exception geworfen.

~Transmitter()

virtual tcp::Transmitter::~Transmitter ( )

virtual

Destruktor.

Transmitter() [3/3]

tcp::Transmitter::Transmitter ( const Transmitter & )

private

Der Copy-Konstruktor steht nicht zur Verfügung.

Dokumentation der Elementfunktionen

acceptOrder()

int tcp::Transmitter::acceptOrder

(

Message *

pTcpMessage

)

Übernimmt die Nachricht in die Liste der Sendenachrichten.

Parameter

[in]

pTcpMessage

Die zu versendende Nachricht.

Rückgabe

Eine Rückgabe < 0 zeigt einen Fehler bzw. ein Info an.

Achtung

Das übergebene Objekt wird von diesem Objekt übernommen und darf von der aufrufenden Instanz nicht mehr verändert oder aus dem Speicher entfernt werden.

cancel()

virtual void tcp::Transmitter::cancel ( )

overridevirtual

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

Zu beachten

Diese Methode gibt es nur, wenn nicht mit POSIX-Threads kompiliert (defined (__PTHREADS)).

Erneute Implementation von eut::RepeatingThread.

operator=()

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

private

Der Zuweisungsoperator steht nicht zur Verfügung.

work()

virtual void tcp::Transmitter::work ( )

overrideprotectedvirtual

Sendet die Daten aus der Liste der Sendenachrichten an das Socket, der im Konstruktor übergeben wurde.

Implementiert eut::RepeatingThread.

Dokumentation der Datenelemente

m_MsgQueue

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

private

Die Queue mit den zu sendenden Nachrichten.

---

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

• TcpTransmitter.h