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

# CTCPIPCommSend Klassenreferenz

Class of CTCPIPCommSend. Mehr...

`#include <TCPIPCommSend.h>`

Klassendiagramm für CTCPIPCommSend:

Aufstellung aller Elemente

## Öffentliche Methoden
| CTCPIPCommSend (const long MaxSendBufferLen=8192)
| Conctuctor creates a new object of CTCPIPCommSend.
virtual | ~CTCPIPCommSend ()
| destructor
void | Initialize (const SOCKET Socket)
| Initialize Initializes and starts the connection thread.
bool | Send (const void *pData, const long DataLen)
| Send Transmits the give data 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 | SendDisInd (void)=0
| SendDisInd Indicates that the TCP/IP connection was broken down.
void | InitializeClass (const long MaxSendBufferLen)
| Initializes object data.
## Private, statische Methoden
void | SendThread (CTCPIPCommSend *pClass)
| SendThread (static) Start function for the Send Thread.
## Private Attribute
SOCKET | m_Socket
int | m_LastSocketError
DWORD | m_ThreadID
HANDLE | m_hReadPipe
HANDLE | m_hWritePipe
HANDLE | m_ThreadHandle
HANDLE | m_hEventTerminate
HANDLE | m_hEventTerminateFinished
HANDLE | m_hEventStartReceiving
void * | m_pSendBuffer
long | m_MaxSendBufferLen
bool | m_Terminating
int | m_SendCnt

## Ausführliche Beschreibung

Class of CTCPIPCommSend.

Version:
  1.1

Autor:
  Udo Weber

Definiert in Zeile 52 der Datei TCPIPCommSend.h.

## Beschreibung der Konstruktoren und Destruktoren

CTCPIPCommSend::CTCPIPCommSend | ( | const long | MaxSendBufferLen = `8192` | ) |

  | Conctuctor creates a new object of CTCPIPCommSend. Parameter:
  | MaxSendBufferLen | Maximum Lenght sending messages
Rückgabe: - Definiert in Zeile 62 der Datei TCPIPCommSend.cpp. Benutzt CTCPIPCommSend() und InitializeClass(). Wird benutzt von CTCPIPCommSend().

## Dokumentation der Elementfunktionen

int CTCPIPCommSend::GetLastSocketError | ( | void |  | ) | const`[inline]`

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

void CTCPIPCommSend::Initialize | ( | const SOCKET | Socket | ) |

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

void CTCPIPCommSend::InitializeClass | ( | const long | MaxSendBufferLen | ) | `[protected]`

  | Initializes object data. Use this to Initialize the class object after construction. Parameter:
  | MaxSendBufferLen | Maximum Lenght sending messages
Rückgabe: - Definiert in Zeile 76 der Datei TCPIPCommSend.cpp. Benutzt InitializeClass() und SendThread(). Wird benutzt von CTCPIPCommSend() und InitializeClass().

bool CTCPIPCommSend::Send | ( | const void * | pData,
|  | const long | DataLen
| ) |

  | Send Transmits the give data to the communication partner. Parameter:
  | pData | Pointer to the data to be transmitted
  | DataLen | Length of the given data
Rückgabe: true if function call was successful Erneute Implementation in CTCPIPComm. Definiert in Zeile 176 der Datei TCPIPCommSend.cpp. Benutzt Send(). Wird benutzt von Send().

virtual void CTCPIPCommSend::SendDisInd | ( | void |  | ) | `[protected, pure virtual]`

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

void CTCPIPCommSend::SendThread | ( | CTCPIPCommSend * | pClass | ) | `[static, private]`

  | SendThread (static) Start function for the Send Thread. Parameter:
  | pClass | Pointer to the current class
Rückgabe: - Definiert in Zeile 243 der Datei TCPIPCommSend.cpp. Benutzt m_hEventTerminateFinished, m_hReadPipe, m_LastSocketError, m_MaxSendBufferLen, m_pSendBuffer, m_Socket, SendDisInd(), SendThread() und Terminating(). Wird benutzt von InitializeClass() und SendThread().

void CTCPIPCommSend::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 187 der Datei TCPIPCommSend.h.

bool CTCPIPCommSend::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 181 der Datei TCPIPCommSend.h. Wird benutzt von SendThread() und CTCPIPComm::~CTCPIPComm().

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

- TCPIPCommSend.h
- TCPIPCommSend.cpp