Hauptseite | Klassenhierarchie | Alphabetische Liste | Auflistung der Klassen | Auflistung der Dateien | Klassen-Elemente

# 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

## 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: -

## 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.

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: -

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: -

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: - Implementiert in CGatewaySecurity, CGatewayServer und CTCPIPConnector.

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

  | RecvDisInd Indicates that the TCP/IP connection was broken down. Parameter:
  | - |
Rückgabe: - Implementiert in CTCPIPComm.

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

  | RecvThread (static) Start function for the Receive Thread. Parameter:
  | pClass | Pointer to the current class
Rückgabe: -

bool CTCPIPCommReceive::StartReceiving | ( | void |  | ) |

  | ConnectRequest Tries to establish the connection to the communication partner. Parameter:
  | - |
Rückgabe: true if function call was successful

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: -

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

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

- TCPIPCommReceive.h
- TCPIPCommReceive.cpp