CTCPIPCommReceive Klassenreferenz

Class of CTCPIPCommReceive. Mehr...

#include <TCPIPCommReceive.h>

Klassendiagramm für CTCPIPCommReceive:

Aufstellung aller Elemente

Öffentliche Methoden
	CTCPIPCommReceive (const long MaxRecvBufferLen=8192)
	Conctuctor creates a new object of CTCPIPCommConnect.
virtual	~CTCPIPCommReceive ()
	destructor
void	Initialize (const SOCKET Socket)
	Initialize Initializes and stars the connection thread.
bool	StartReceiving (void)
	ConnectRequest Tries to establish the connection to the communication partner.
int	GetLastSocketError (void) const
	GetLastSocketError Returns the last socket error occured.
bool	Terminating (void) const
	Terminating (get state) Returns the state whether the class is terminating (destructor) or not.
void	Terminating (bool Terminating)
	Terminating (set state) Sets the state Terminating according to the parameter.
Geschützte Methoden
virtual void	Receive (void *pData, long DataLen)=0
	Receive Indicates that the TCP/IP connection is established.
virtual void	RecvDisInd (void)=0
	RecvDisInd Indicates that the TCP/IP connection was broken down.
void	InitializeClass (const long MaxRecvBufferLen)
	Initializes object data.
Private, statische Methoden
void	RecvThread (CTCPIPCommReceive *pClass)
	RecvThread (static) Start function for the Receive Thread.
Private Attribute
SOCKET	m_Socket
int	m_LastSocketError
DWORD	m_ThreadID
HANDLE	m_ThreadHandle
HANDLE	m_hEventTerminate
HANDLE	m_hEventTerminateFinished
HANDLE	m_hEventStartReceiving
void *	m_pRecvBuffer
long	m_MaxRecvBufferLen
bool	m_Terminating

---

Ausführliche Beschreibung

Class of CTCPIPCommReceive.

Version:

1.1

Autor:

Udo Weber

Definiert in Zeile 51 der Datei TCPIPCommReceive.h.

---

Beschreibung der Konstruktoren und Destruktoren

CTCPIPCommReceive::CTCPIPCommReceive (  const long  MaxRecvBufferLen = 8192  )

Conctuctor creates a new object of CTCPIPCommConnect. Parameter: MaxRecvBufferLen  Maximum Lenght receiving messages Rückgabe: - Definiert in Zeile 67 der Datei TCPIPCommReceive.cpp. Benutzt CTCPIPCommReceive() und InitializeClass(). Wird benutzt von CTCPIPCommReceive().

---

Dokumentation der Elementfunktionen

int CTCPIPCommReceive::GetLastSocketError (  void   )  const [inline]

GetLastSocketError Returns the last socket error occured. Parameter: -  Rückgabe: Last socket error Erneute Implementation in CTCPIPComm. Definiert in Zeile 174 der Datei TCPIPCommReceive.h.

void CTCPIPCommReceive::Initialize (  const SOCKET  Socket  )

Initialize Initializes and stars the connection thread. Parameter: Socket  The socket to be used for receiving data Rückgabe: - Definiert in Zeile 177 der Datei TCPIPCommReceive.cpp. Benutzt Initialize(). Wird benutzt von Initialize().

void CTCPIPCommReceive::InitializeClass (  const long  MaxRecvBufferLen  )  [protected]

Initializes object data. Use this to Initialize the class object after construction. Parameter: MaxRecvBufferLen  Maximum Lenght receiving messages Rückgabe: - Definiert in Zeile 95 der Datei TCPIPCommReceive.cpp. Benutzt InitializeClass() und RecvThread(). Wird benutzt von CTCPIPCommReceive() und InitializeClass().

virtual void CTCPIPCommReceive::Receive (  void *  pData, long  DataLen )  [protected, pure virtual]

Receive Indicates that the TCP/IP connection is established. Parameter: pData  Pointer to the data received DataLen  Length of the received data Rückgabe: - Wird benutzt von RecvThread().

virtual void CTCPIPCommReceive::RecvDisInd (  void   )  [protected, pure virtual]

RecvDisInd Indicates that the TCP/IP connection was broken down. Parameter: -  Rückgabe: - Implementiert in CTCPIPComm. Wird benutzt von RecvThread().

void CTCPIPCommReceive::RecvThread (  CTCPIPCommReceive *  pClass  )  [static, private]

RecvThread (static) Start function for the Receive Thread. Parameter: pClass  Pointer to the current class Rückgabe: - Definiert in Zeile 223 der Datei TCPIPCommReceive.cpp. Benutzt m_hEventStartReceiving, m_hEventTerminate, m_hEventTerminateFinished, m_pRecvBuffer, m_Socket, Receive(), RecvDisInd(), RecvThread() und Terminating(). Wird benutzt von InitializeClass() und RecvThread().

bool CTCPIPCommReceive::StartReceiving (  void   )

ConnectRequest Tries to establish the connection to the communication partner. Parameter: -  Rückgabe: true if function call was successful Definiert in Zeile 196 der Datei TCPIPCommReceive.cpp. Wird benutzt von CTCPIPComm::ConInd().

void CTCPIPCommReceive::Terminating (  bool  Terminating  )  [inline]

Terminating (set state) Sets the state Terminating according to the parameter. Parameter: Terminating  TRUE if derived class is terminating (destructor) Rückgabe: - Definiert in Zeile 186 der Datei TCPIPCommReceive.h.

bool CTCPIPCommReceive::Terminating (  void   )  const [inline]

Terminating (get state) Returns the state whether the class is terminating (destructor) or not. Parameter: -  Rückgabe: True if terminating Definiert in Zeile 180 der Datei TCPIPCommReceive.h. Wird benutzt von RecvThread() und CTCPIPComm::~CTCPIPComm().

---

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

• TCPIPCommReceive.h
• TCPIPCommReceive.cpp

---