---

RNSocket Klassenreferenz

Kapsel für WinSock. Mehr...

#include <RNSocket.h>

Öffentliche Datenelemente
	RNSocket (void)
	~RNSocket (void)
bool	create (int iAdressFamily=AF_INET, int iType=SOCK_STREAM, int iProtocol=IPPROTO_IP)
bool	close (void)
bool	shutdown (int iFlags)
bool	connect (char *pcDestName, int iPort, int iAddressFamily=AF_INET)
bool	bind (char *pcDestName, int iPort)
bool	listen (int iBackLog=SOMAXCONN)
bool	accept (RNSocket &socketNew)
bool	receive (void *pvoidData, int *piLength, int iFlags=0)
bool	send (void *pvoidData, int *piLength, int iFlags=0)
bool	isReadable (bool &bReadable, int iMilliSeconds)
bool	isWriteable (bool &bWriteable, int iMilliSeconds)
Öffentliche, statische Datenelemente
bool	init (int iMajorVersion=1, int iMinorVersion=1)
bool	cleanUp (void)
Private Attribute
SOCKET	m_Socket
	Socket - Handle. Mehr...
sockaddr_in	m_addrLocal
	Adresse dieses Sockets. Mehr...
sockaddr_in	m_addrTarget
	Adresse des Ziel-Sockets. Mehr...
Statische private Attribute
WSAData	m_wsaData
	Socket Version. Mehr...
bool	m_bSocketInitialized = false
	gibt an, um WinSockets initialisiert sind. Mehr...

---

Ausführliche Beschreibung

Kapsel für WinSock.

Die Klasse RNSocket beitet eine Klasse zur Kapselung von WinSock. Sie enthält Methoden um Verbindungen herzustellen und Daten zu senden und zu empfangen. Die Klasse gibt jeweils bool Werte zurück, die den Erfolg der Methoden angeben. Bei einem false ist die Methode gescheitert, und der entsprechende Fehlercode kann über WSAGetLastError ausgelesen werden.

---

Beschreibung der Konstruktoren und Destruktoren

RNSocket::RNSocket (  void    )

Konstruktor { m_Socket = INVALID_SOCKET; ZeroMemory(&m_addrLocal, sizeof(m_addrLocal)); ZeroMemory(&m_addrTarget, sizeof(m_addrTarget)); }

RNSocket::~RNSocket (  void    )

Destruktor { close(); }

---

Dokumentation der Elementfunktionen

bool RNSocket::accept (  RNSocket &    socketNew )

Akzeptiert eine Verbindung, ab sofort können über den neuen Socket Daten ausgetauscht werden. { int iAddrTargetLength = sizeof(socketNew.m_addrTarget); // anfragende Verbindung akzeptieren socketNew.m_Socket = ::accept( m_Socket, (struct sockaddr*) &socketNew.m_addrTarget, &iAddrTargetLength); if(socketNew.m_Socket == INVALID_SOCKET) { return false; } return true; }

bool RNSocket::bind (  char *    pcDestName, int    iPort )

Bindet den Socket an den angegebenem Namen (IP) und Port. { int iResult; // Spezification unseres Socket bestimmen if(pcDestName == NULL) { m_addrLocal.sin_addr.s_addr = htonl(INADDR_ANY); } else { m_addrLocal.sin_addr.s_addr = inet_addr(pcDestName); } m_addrLocal.sin_port = htons((WORD)iPort); iResult = ::bind( m_Socket, (struct sockaddr*) &m_addrLocal, sizeof(m_addrLocal)); if(iResult == SOCKET_ERROR) { return false; } return true; }

bool RNSocket::cleanUp (  void    )  [static]

Entlädt die Winsock dll mit Hilfe von WSACleanup. { HRESULT hResult; // sind die Sockets ueberhaupt noch initialisiert ?! if(!m_bSocketInitialized) { return false; } hResult = WSACleanup(); if (hResult == SOCKET_ERROR) { return false; } m_bSocketInitialized = false; // erfolgreich aufgeräumt! return true; }

bool RNSocket::close (  void    )

Schliesst den Socket. { int iResult; iResult = closesocket(m_Socket); if(iResult == SOCKET_ERROR) { return false; } m_Socket=INVALID_SOCKET; return true; }

bool RNSocket::connect (  char *    pcDestName, int    iPort, int    iAddressFamily = AF_INET )

Öffnet eine Verbindung zur angegebenen IP-Adresse und Port. { int iResult; // Ziel bestimmen m_addrTarget.sin_family = iAddressFamily; m_addrTarget.sin_port = htons((WORD)iPort); m_addrTarget.sin_addr.s_addr = inet_addr(pcDestName); // und verbinden iResult = ::connect(m_Socket, (struct sockaddr *) &m_addrTarget, sizeof(m_addrTarget)); if (iResult == SOCKET_ERROR) { return false; } return true; }

bool RNSocket::create (  int    iAdressFamily = AF_INET, int    iType = SOCK_STREAM, int    iProtocol = IPPROTO_IP )

Erstellt den Socket mit den entsprechenden Parametern. { if (m_Socket != INVALID_SOCKET) { close(); } m_Socket = socket( iAdressFamily, iType, iProtocol); if (m_Socket == INVALID_SOCKET) { return false; } //wird später für bind gebraucht m_addrLocal.sin_family=iAdressFamily; BOOL bYes=TRUE; if ( setsockopt( m_Socket, SOL_SOCKET, SO_REUSEADDR, (char*)&bYes, sizeof(bYes)) == SOCKET_ERROR) { return false; } return true; }

bool RNSocket::init (  int    iMajorVersion = 1, int    iMinorVersion = 1 )  [static]

Initialisiert die Sockets mit der angegebenen Vesion. (Lädt die Windows dll) { //Version erzeugen WORD wVersionReg = MAKEWORD((WORD)iMajorVersion, (WORD)iMinorVersion); if(m_bSocketInitialized) { // schon initialisiert? return false; } if (WSAStartup(wVersionReg, &m_wsaData) != 0) { m_bSocketInitialized=false; return false; } if ( LOBYTE( m_wsaData.wVersion ) != iMajorVersion || HIBYTE( m_wsaData.wVersion ) != iMinorVersion ) { WSACleanup(); m_bSocketInitialized=false; return false; } m_bSocketInitialized=true; return true; }

bool RNSocket::isReadable (  bool &    bReadable, int    iMilliSeconds )

Überprüft ob der Socket "readable" ist. { int iResult; fd_set fdSet; FD_ZERO(&fdSet); FD_SET(m_Socket, &fdSet); timeval tvTimeOut; tvTimeOut.tv_sec=iMilliSeconds/1000; tvTimeOut.tv_usec=(iMilliSeconds%1000)*1000; iResult = ::select(0, &fdSet, NULL, NULL, &tvTimeOut); // Fehler if(iResult == SOCKET_ERROR) { // konnte status nicht ermitteln bReadable = false; return false; } // Timeout if(iResult == 0) { bReadable = false; return true; } // hat geklappt - der socket ist in lesbarem zustand bReadable = true; return true; }

bool RNSocket::isWriteable (  bool &    bWriteable, int    iMilliSeconds )

Überprüft ob der Socket "writeable" ist. { int iResult; fd_set fdSet; FD_ZERO(&fdSet); FD_SET(m_Socket, &fdSet); timeval tvTimeOut; tvTimeOut.tv_sec=iMilliSeconds/1000; tvTimeOut.tv_sec=(iMilliSeconds%1000)*1000; iResult = ::select(0, NULL, &fdSet, NULL, &tvTimeOut); // Fehler if(iResult == SOCKET_ERROR) { // konnte status nicht ermitteln bWriteable = false; return false; } // Timeout if(iResult == 0) { bWriteable = false; return true; } // hat geklappt - der socket ist in schreibbarem zustand bWriteable = true; return true; }

bool RNSocket::listen (  int    iBackLog = SOMAXCONN )

Veranlasst das Lauschen an einem Socket, der vorher ge"bind"et wurde. iBackLog gibt an wie Connection Requests gequeued werden. { int iResult; iResult = ::listen(m_Socket, iBackLog); if( iResult == SOCKET_ERROR) { return false; } return true; }

bool RNSocket::receive (  void *    pvoidData, int *    piLength, int    iFlags = 0 )

Empfängt Daten auf dem Socket, es werden maximal piLength Daten empfangen. Sind es weniger, wird piLength entsprechend verändert. { int iDataReceived; iDataReceived=recv(m_Socket, (char*)pvoidData, *piLength, iFlags); if (iDataReceived==SOCKET_ERROR) return false; *piLength=iDataReceived; return true; }

bool RNSocket::send (  void *    pvoidData, int *    piLength, int    iFlags = 0 )

Sendet die Daten aus dem Buffer. Es wird versucht alle Daten zu senden, und nur bei einem Fehler wird abgebrochen. { int iSendTotal = 0; // how many bytes we’ve sent int iBytesLeft = *piLength; // how many we have left to send int iBytesSend; while (iSendTotal < *piLength) { iBytesSend = ::send(m_Socket, ((char*)(pvoidData))+iSendTotal, iBytesLeft, iFlags); if (iBytesSend == SOCKET_ERROR ) { *piLength = iSendTotal; return false; } iSendTotal += iBytesSend; iBytesLeft -= iBytesSend; } *piLength = iSendTotal; return true; }

bool RNSocket::shutdown (  int    iFlags )

Ruft shutdown() für den Socket mit den gewünschten Parametern auf. { int iResult; iResult = ::shutdown(m_Socket, iFlags); if(iResult == SOCKET_ERROR) { return false; } return true; }

---

Dokumentation der Datenelemente

sockaddr_in RNSocket::m_addrLocal [private]

Adresse dieses Sockets.

sockaddr_in RNSocket::m_addrTarget [private]

Adresse des Ziel-Sockets.

bool RNSocket::m_bSocketInitialized = false [static, private]

gibt an, um WinSockets initialisiert sind.

SOCKET RNSocket::m_Socket [private]

Socket - Handle.

WSADATA RNSocket::m_wsaData [static, private]

Socket Version.

---

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

• RNSocket.h
• RNSocket.cpp

---