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

# CTCPIPCommConnect Klassenreferenz

Class of CTCPIPCommConnect. Mehr...

`#include <TCPIPCommConnect.h>`

Klassendiagramm für CTCPIPCommConnect:

Aufstellung aller Elemente

## Öffentliche Methoden
| CTCPIPCommConnect ()
| Conctuctor creates a new object of CTCPIPCommConnect.
virtual | ~CTCPIPCommConnect ()
| destructor
void | Initialize (const short TCPport, const char *pIPAddress, const bool PassiveConnection=false)
| Initialize Initializes and stars the connection thread.
bool | ConnectRequest (SOCKET PassiveSocket)
| ConnectRequest Tries to establish the connection to the communication partner.
bool | DisconnectRequest (void)
| DisconnectRequest Close the current connection.
int | GetLastSocketError (void) const
| GetLastSocketError Returns the last socket error occured.
bool | Terminating (void) const
| Terminating Returns the state whether the class is terminating (destructor) or not.
SOCKET | GetSocket (void)
| GetSocket Returns the socket of the established connection.
unsigned long | GetRemoteIPAddr (void)
| GetRemoteIPAddr Returns the remote IP Address as a long value.
in_addr | ConvToInAddr (unsigned long nIPAddress) const
| ConvToInAddr Returns a IP Address as a in_addr.
const SOCKADDR_IN & | GetRemoteAddr (void)
| Returns the remote IP Address as a SOCKADDR_IN.
SOCKADDR_IN | ConvTCPAddrToSocketAddr (const short TCPport, const char *pIPAddr)
| ConvTCPAddrToSocketAddr Converts the TCP port and IP Address string into a socket address.
## Geschützte Methoden
virtual void | ConInd (void)=0
| ConInd Indicates that the TCP/IP connection is established.
virtual void | DisInd (void)=0
| DisInd Indicates that the TCP/IP connection was broken down.
## Private Methoden
bool | AwaitConnection (void)
| AwaitConnection Calls the Await Function in order to await a connection.
bool | EstablishConnection (void)
| EstablishConnection Calls the Connect Function in order to establish activley a connection.
## Private, statische Methoden
void | ConnectThread (CTCPIPCommConnect *pClass)
| ConvTCPAddrToSocketAddr (static) Start function for the Connect Thread.
## Private Attribute
SOCKET | m_Socket
SOCKET | m_PassiveSocket
SOCKADDR_IN | m_RemoteAddr
bool | m_PassiveConnection
int | m_LastSocketError
DWORD | m_ThreadID
HANDLE | m_ThreadHandle
HANDLE | m_hEventTerminate
HANDLE | m_hEventTerminateFinished
HANDLE | m_hEventConnecting
unsigned long | m_RemoteIPAddr
bool | m_Terminating

## Ausführliche Beschreibung

Class of CTCPIPCommConnect.

Version:
  1.1

Autor:
  Udo Weber

Definiert in Zeile 57 der Datei TCPIPCommConnect.h.

## Beschreibung der Konstruktoren und Destruktoren

CTCPIPCommConnect::CTCPIPCommConnect | ( |  | ) |

  | Conctuctor creates a new object of CTCPIPCommConnect. Parameter:
  | - |
Rückgabe: - Definiert in Zeile 75 der Datei TCPIPCommConnect.cpp. Benutzt ConnectThread().

## Dokumentation der Elementfunktionen

bool CTCPIPCommConnect::AwaitConnection | ( | void |  | ) | `[private]`

  | AwaitConnection Calls the Await Function in order to await a connection. Parameter:
  | - |
Rückgabe: true if function successful (does not mean that connection is established) Definiert in Zeile 320 der Datei TCPIPCommConnect.cpp. Wird benutzt von ConnectThread().

virtual void CTCPIPCommConnect::ConInd | ( | void |  | ) | `[protected, pure virtual]`

  | ConInd Indicates that the TCP/IP connection is established. Parameter:
  | - |
Rückgabe: - Implementiert in CTCPIPComm. Wird benutzt von ConnectThread().

bool CTCPIPCommConnect::ConnectRequest | ( | SOCKET | PassiveSocket | ) |

  | ConnectRequest Tries to establish the connection to the communication partner. Parameter:
  | PassiveSocket | Socket for the passive connection estalishment
Rückgabe: true if function call was successful Definiert in Zeile 270 der Datei TCPIPCommConnect.cpp. Benutzt ConnectRequest(). Wird benutzt von ConnectRequest().

void CTCPIPCommConnect::ConnectThread | ( | CTCPIPCommConnect * | pClass | ) | `[static, private]`

  | ConvTCPAddrToSocketAddr (static) Start function for the Connect Thread. Parameter:
  | pClass | Pointer to the current class
Rückgabe: - Definiert in Zeile 377 der Datei TCPIPCommConnect.cpp. Benutzt AwaitConnection(), ConInd(), ConnectThread(), DisInd(), EstablishConnection(), m_hEventConnecting, m_hEventTerminate, m_hEventTerminateFinished, m_LastSocketError, m_PassiveConnection, m_RemoteIPAddr, m_Socket und Terminating(). Wird benutzt von ConnectThread() und CTCPIPCommConnect().

SOCKADDR_IN CTCPIPCommConnect::ConvTCPAddrToSocketAddr | ( | const short | TCPport,
|  | const char * | pIPAddr
| ) |

  | ConvTCPAddrToSocketAddr Converts the TCP port and IP Address string into a socket address. Parameter:
  | TCPport | TCP port
  | pIPAddr | Null terminated string containing IP Address or Name
Rückgabe: SOCKADDR_IN structure Definiert in Zeile 217 der Datei TCPIPCommConnect.cpp. Benutzt ConvTCPAddrToSocketAddr(). Wird benutzt von ConvTCPAddrToSocketAddr() und Initialize().

struct in_addr CTCPIPCommConnect::ConvToInAddr | ( | unsigned long | nIPAddress | ) | const

  | ConvToInAddr Returns a IP Address as a in_addr. Parameter:
  | IP | Address (ulong format)
Rückgabe: IP Address (in_addr) Definiert in Zeile 196 der Datei TCPIPCommConnect.cpp.

bool CTCPIPCommConnect::DisconnectRequest | ( | void |  | ) |

  | DisconnectRequest Close the current connection. Parameter:
  | - |
Rückgabe: true if function call was successful Definiert in Zeile 297 der Datei TCPIPCommConnect.cpp. Wird benutzt von CTCPIPComm::DisInd() und ~CTCPIPCommConnect().

virtual void CTCPIPCommConnect::DisInd | ( | void |  | ) | `[protected, pure virtual]`

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

bool CTCPIPCommConnect::EstablishConnection | ( | void |  | ) | `[private]`

  | EstablishConnection Calls the Connect Function in order to establish activley a connection. Parameter:
  | - |
Rückgabe: true if function successful (does not mean that connection is established) Definiert in Zeile 345 der Datei TCPIPCommConnect.cpp. Wird benutzt von ConnectThread().

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

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

const SOCKADDR_IN & CTCPIPCommConnect::GetRemoteAddr | ( | void |  | ) | `[inline]`

| Returns the remote IP Address as a SOCKADDR_IN. Rückgabe: Remote IP Address Definiert in Zeile 259 der Datei TCPIPCommConnect.h.

unsigned long CTCPIPCommConnect::GetRemoteIPAddr | ( | void |  | ) | `[inline]`

  | GetRemoteIPAddr Returns the remote IP Address as a long value. Parameter:
  | - |
Rückgabe: Remote IP Address Definiert in Zeile 254 der Datei TCPIPCommConnect.h.

SOCKET CTCPIPCommConnect::GetSocket | ( | void |  | ) | `[inline]`

  | GetSocket Returns the socket of the established connection. Parameter:
  | - |
Rückgabe: Socket Definiert in Zeile 247 der Datei TCPIPCommConnect.h. Wird benutzt von CTCPIPComm::ConInd().

void CTCPIPCommConnect::Initialize | ( | const short | TCPport,
|  | const char * | pIPAddress,
|  | const bool | PassiveConnection = `false`
| ) |

  | Initialize Initializes and stars the connection thread. Parameter:
  | TCPport | TCP Port to establish the connection
  | pIPAddress | Null terminated String containing IP-Address or Name
  | PassiveConnection | False if awaiting connection from partner (default)
Rückgabe: - Definiert in Zeile 154 der Datei TCPIPCommConnect.cpp. Benutzt ConvTCPAddrToSocketAddr() und Initialize(). Wird benutzt von Initialize().

bool CTCPIPCommConnect::Terminating | ( | void |  | ) | const`[inline]`

  | Terminating Returns the state whether the class is terminating (destructor) or not. Parameter:
  | - |
Rückgabe: True if terminating Definiert in Zeile 240 der Datei TCPIPCommConnect.h. Wird benutzt von ConnectThread().

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

- TCPIPCommConnect.h
- TCPIPCommConnect.cpp