regcom::network::SocketSet

SocketSet Class Reference

#include <SocketSet.h>

List of all members.


Public Member Functions

 SocketSet ()
 Public constructor.
virtual ~SocketSet ()
 Virtual destructor.
common::ErrorCodeType Init (int maxSockets)
 Initializes socket set.
common::ErrorCodeType Add (TcpSocket &rSocket)
 Adds socket.
common::ErrorCodeType Remove (TcpSocket &rSocket)
 Removes socket.

Private Attributes

SDLNet_SocketSet m_SocketSet
 Private SDL_net data.

Detailed Description

SocketSet class.
Full Description
This class provides a container for sockets and allows code to block while waiting for socket activity.

Constructor & Destructor Documentation

SocketSet (  ) 

Public constructor.

Full Description
This method creates a new instance of the class.
Returns:
New instance of the class.

~SocketSet (  )  [virtual]

Virtual destructor.

Full Description
This method destroys an existing instance of the class.
Returns:
None.

Member Function Documentation

common::ErrorCodeType Init ( int  maxSockets  ) 

Initializes socket set.

Full Description
This method initializes the socket set.
Returns:
Success if successful.

Failure otherwise.

Parameters:
maxSockets  Maximum number of sockets.

common::ErrorCodeType Add ( TcpSocket &  rSocket  ) 

Adds socket.

Full Description
This method adds a TCP socket to the socket set.
Returns:
Success if successful.

Failure otherwise.

Parameters:
rSocket  Socket to be added.

common::ErrorCodeType Remove ( TcpSocket &  rSocket  ) 

Removes socket.

Full Description
This method removes a TCP socket from the socket set.
Returns:
Success if successful.

Failure otherwise.

Parameters:
rSocket  Socket to be removed.

Member Data Documentation

SDLNet_SocketSet m_SocketSet [private]

Private SDL_net data.

The documentation for this class was generated from the following files: