bitz-server  0.1.6
Public Member Functions | List of all members
socketlibrary::TCPServerSocketM Class Reference

#include <socket.h>

Inheritance diagram for socketlibrary::TCPServerSocketM:
socketlibrary::TCPServerSocket socketlibrary::Socket

Public Member Functions

 TCPServerSocketM (unsigned short localPort, int queueLen=5) throw (SocketException)
 
TCPSocketaccept () throw (SocketException)
 
bool pendingConnections () throw (SocketException)
 
int getWaitingClients (vector< TCPSocket * > &clients) throw (SocketException)
 
void closeClientConnection (TCPSocket *client)
 
- Public Member Functions inherited from socketlibrary::TCPServerSocket
 TCPServerSocket (unsigned short localPort, int queueLen=5) throw (SocketException)
 
 TCPServerSocket (const string &localAddress, unsigned short localPort, int queueLen=5) throw (SocketException)
 
TCPSocketaccept () throw (SocketException)
 
- Public Member Functions inherited from socketlibrary::Socket
 ~Socket ()
 
string getLocalAddress () throw (SocketException)
 
unsigned short getLocalPort () throw (SocketException)
 
void setLocalPort (unsigned short localPort) throw (SocketException)
 
void setLocalAddressAndPort (const string &localAddress, unsigned short localPort=0) throw (SocketException)
 

Additional Inherited Members

- Static Public Member Functions inherited from socketlibrary::Socket
static void cleanUp () throw (SocketException)
 
static unsigned short resolveService (const string &service, const string &protocol="tcp")
 
- Protected Member Functions inherited from socketlibrary::Socket
 Socket (int type, int protocol) throw (SocketException)
 
 Socket (int sock)
 
- Protected Attributes inherited from socketlibrary::Socket
int sock
 

Detailed Description

TCP socket class for multi-client servers

Constructor & Destructor Documentation

socketlibrary::TCPServerSocketM::TCPServerSocketM ( 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
localPortlocal port of server socket, a value of zero will give a system-assigned unused port
queueLenmaximum queue length for outstanding connection requests (default 5)
Exceptions
SocketExceptionthrown if unable to create TCP server socket

Member Function Documentation

TCPSocket * socketlibrary::TCPServerSocketM::accept ( )
throw (SocketException
)

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

Returns
new connection socket
Exceptions
SocketExceptionthrown if attempt to accept a new connection fails
void socketlibrary::TCPServerSocketM::closeClientConnection ( TCPSocket client)

Closes the connection to a client

Parameters
clientthe client TCPSocket to close
int socketlibrary::TCPServerSocketM::getWaitingClients ( vector< TCPSocket * > &  clients)
throw (SocketException
)

Checks for read waiting clients

Parameters
clientsa vector of TCPSocket pointers to get the waiting clients
Returns
number of clients waiting
Exceptions
SocketExceptionthrown if attempt to check for waiting clients fail
bool socketlibrary::TCPServerSocketM::pendingConnections ( )
throw (SocketException
)

Checks for incoming connections or error

Returns
boolean (true if incoming connections are present)
Exceptions
SocketExceptionthrown if attempt to check for new connections fail