From 7763f07327f3abce839a690df46ced3bfd1d3d09 Mon Sep 17 00:00:00 2001 From: Erwin Nindl Date: Sun, 7 Oct 2007 22:07:03 +0000 Subject: added doxygen generatet documentation --- doc/html/classTCPServerSocket.html | 184 +++++++++++++++++++++++++++++++++++++ 1 file changed, 184 insertions(+) create mode 100644 doc/html/classTCPServerSocket.html (limited to 'doc/html/classTCPServerSocket.html') diff --git a/doc/html/classTCPServerSocket.html b/doc/html/classTCPServerSocket.html new file mode 100644 index 0000000..6dcb6dc --- /dev/null +++ b/doc/html/classTCPServerSocket.html @@ -0,0 +1,184 @@ + + +anytun: TCPServerSocket Class Reference + + + + +
+
+
+
+

TCPServerSocket Class Reference

#include <PracticalSocket.h> +

+

Inheritance diagram for TCPServerSocket: +

+ +Socket + +List of all members. + + + + + + + + + + + +

Public Member Functions

 TCPServerSocket (unsigned short localPort, int queueLen=5) throw (SocketException)
 TCPServerSocket (const string &localAddress, unsigned short localPort, int queueLen=5) throw (SocketException)
TCPSocket * accept () throw (SocketException)

Private Member Functions

void setListen (int queueLen) throw (SocketException)
+

Detailed Description

+TCP socket class for servers +

+

Constructor & Destructor Documentation

+ +
+
+ + + + + + + + + + + + + + + + + + +
TCPServerSocket::TCPServerSocket (unsigned short  localPort,
int  queueLen = 5 
) throw (SocketException)
+
+
+ +

+Construct a TCP socket for use with a server, accepting connections on the specified port on any interface

Parameters:
+ + + +
localPort local port of server socket, a value of zero will give a system-assigned unused port
queueLen maximum queue length for outstanding connection requests (default 5)
+
+
Exceptions:
+ + +
SocketException thrown if unable to create TCP server socket
+
+ +
+

+ +

+
+ + + + + + + + + + + + + + + + + + + + + + + + +
TCPServerSocket::TCPServerSocket (const string &  localAddress,
unsigned short  localPort,
int  queueLen = 5 
) throw (SocketException)
+
+
+ +

+Construct a TCP socket for use with a server, accepting connections on the specified port on the interface specified by the given address

Parameters:
+ + + + +
localAddress local interface (address) of server socket
localPort local port of server socket
queueLen maximum queue length for outstanding connection requests (default 5)
+
+
Exceptions:
+ + +
SocketException thrown if unable to create TCP server socket
+
+ +
+

+

Member Function Documentation

+ +
+
+ + + + + + + + +
TCPSocket * TCPServerSocket::accept (  )  throw (SocketException)
+
+
+ +

+Blocks until a new connection is established on this socket or error

Returns:
new connection socket
+
Exceptions:
+ + +
SocketException thrown if attempt to accept a new connection fails
+
+ +
+

+ +

+
+ + + + + + + + + +
void TCPServerSocket::setListen (int  queueLen  )  throw (SocketException) [private]
+
+
+ +

+ +

+

+

The documentation for this class was generated from the following files: +
Generated on Sun Oct 7 23:43:50 2007 for anytun by  + +doxygen 1.5.1
+ + -- cgit v1.2.3