tcp::Server::ServerReceiverTransmitter Klassenreferenz

Tuple von Socket-Receiver und -Transmitter für den Server. Mehr ...

#include <TcpServer.h>

Klassendiagramm für tcp::Server::ServerReceiverTransmitter:

Öffentliche Methoden
	ServerReceiverTransmitter (Transmitter *pTransmitter, ServerReceiver *pReceiver)
virtual	~ServerReceiverTransmitter ()
int	getPeerName (std::string &rstrIPAdress, unsigned int &ruiPort) const
int	send (char *pszRawMsg, unsigned int uiRawMsgSize, unsigned int uiMessageID=0, int iActionCode=0, const std::string &rstrInfo="")
int	send (Message *pTcpMessage)
void	setValid (bool bValid)
SOCKET	Socket () const

Geschützte Methoden
	ServerReceiverTransmitter ()

Private Methoden
	ServerReceiverTransmitter (const ServerReceiverTransmitter &rT)
Server::ServerReceiverTransmitter &	operator= (const ServerReceiverTransmitter &)

Private Attribute
ServerReceiver *	m_pReceiver
Transmitter *	m_pTransmitter

Ausführliche Beschreibung

Tuple von Socket-Receiver und -Transmitter für den Server.

Copyright

© 2010 Helmut Jakoby

Autor

Helmut Jakoby

Beschreibung der Konstruktoren und Destruktoren

ServerReceiverTransmitter() [1/3]

tcp::Server::ServerReceiverTransmitter::ServerReceiverTransmitter ( )

protected

Dieser Konstruktor steht niccht zur Verfügung.

ServerReceiverTransmitter() [2/3]

tcp::Server::ServerReceiverTransmitter::ServerReceiverTransmitter	(	Transmitter *	pTransmitter,
		ServerReceiver *	pReceiver )

Dieser Konstruktor startet übergebenen Tcp-Leser und -Schreiber.

Parameter

[in]	pTransmitter	Der Schreiber (sendet Daten an einen Client).
[in]	pReceiver	Der Leser (empfängt Daten von einem Client).

Achtung

Der ServerReceiverTransmitter übernimmt die Verantwortung für die in pTransmitter und pReceiver übergebenen Objekte. Das bedeutet, die aufrufende Instanz darf die übergebenen Objekte nicht aus dem Speicher entfernen.

Ausnahmebehandlung

eut::ErrorNException

Bei einem Fehler wird eine Exception geworfen.

~ServerReceiverTransmitter()

virtual tcp::Server::ServerReceiverTransmitter::~ServerReceiverTransmitter ( )

virtual

Im Destruktor werden der Tcp-Leser und -Schreiber angehalten und aus dem Speicher entfernt.

ServerReceiverTransmitter() [3/3]

tcp::Server::ServerReceiverTransmitter::ServerReceiverTransmitter ( const ServerReceiverTransmitter & rT )

private

Der Copy-Konstruktor steht nicht zur Verfügung.

Dokumentation der Elementfunktionen

getPeerName()

int tcp::Server::ServerReceiverTransmitter::getPeerName	(	std::string &	rstrIPAdress,
		unsigned int &	ruiPort ) const

Liefert die IP-Adresse und den Port.

Parameter

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

Rückgabe

Eine Rückgabe < 0 zeigt einen Fehler an.

operator=()

Server::ServerReceiverTransmitter & tcp::Server::ServerReceiverTransmitter::operator= ( const ServerReceiverTransmitter & )

private

Der Zuweisungsoperator steht nicht zur Verfügung.

send() [1/2]

int tcp::Server::ServerReceiverTransmitter::send	(	char *	pszRawMsg,
		unsigned int	uiRawMsgSize,
		unsigned int	uiMessageID = 0,
		int	iActionCode = 0,
		const std::string &	rstrInfo = "" )

Sendet übergebene Daten über seinen Transmitter an den Client.

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]	rstrInfo	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]

int tcp::Server::ServerReceiverTransmitter::send

(

Message *

pTcpMessage

)

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

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, muss dieser auch die Message aus dem Speicher entfernen.

setValid()

void tcp::Server::ServerReceiverTransmitter::setValid

(

bool

bValid

)

Wird aufgerufen, wenn Socket nicht mehr ok.

Socket()

SOCKET tcp::Server::ServerReceiverTransmitter::Socket

(

)

const

Liefert den Socket.

Ausnahmebehandlung

eut::ErrorNException

Wenn kein SOCKET, wird eine Exception geworfen.

Dokumentation der Datenelemente

m_pReceiver

ServerReceiver* tcp::Server::ServerReceiverTransmitter::m_pReceiver

private

Der Tcp-Leser des Servers (empfängt Daten von einem Client)

m_pTransmitter

Transmitter* tcp::Server::ServerReceiverTransmitter::m_pTransmitter

private

Der Tcp-Schreiber des Servers (sendet Daten an einen Client).

---

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

• TcpServer.h