sf::SelectorBase Class Reference

Private base class for selectors. More...

#include <SelectorBase.hpp>

Inheritance diagram for sf::SelectorBase:

sf::Selector< Type > List of all members.

Public Member Functions

 SelectorBase ()
 Default constructor.
void Add (SocketHelper::SocketType Socket)
 Add a socket to watch.
void Remove (SocketHelper::SocketType Socket)
 Remove a socket.
void Clear ()
 Remove all sockets.
unsigned int Wait (float Timeout=0.f)
 Wait and collect sockets which are ready for reading.
SocketHelper::SocketType GetSocketReady (unsigned int Index) const
 After a call to Wait(), get the Index-th socket which is ready for reading.

Detailed Description

Private base class for selectors.

As Selector is a template class, this base is needed so that every system call get compiled in SFML (not inlined)

Definition at line 43 of file SelectorBase.hpp.


Constructor & Destructor Documentation

sf::SelectorBase::SelectorBase (  ) 

Default constructor.


Member Function Documentation

void sf::SelectorBase::Add ( SocketHelper::SocketType  Socket  ) 

Add a socket to watch.

Parameters:
Socket : Socket to add

void sf::SelectorBase::Remove ( SocketHelper::SocketType  Socket  ) 

Remove a socket.

Parameters:
Socket : Socket to remove

void sf::SelectorBase::Clear (  ) 

Remove all sockets.

Reimplemented in sf::Selector< Type >.

unsigned int sf::SelectorBase::Wait ( float  Timeout = 0.f  ) 

Wait and collect sockets which are ready for reading.

This functions will return either when at least one socket is ready, or when the given time is out

Parameters:
Timeout : Timeout, in seconds (0 by default : no timeout)
Returns:
Number of sockets ready to be read

Reimplemented in sf::Selector< Type >.

SocketHelper::SocketType sf::SelectorBase::GetSocketReady ( unsigned int  Index  )  const

After a call to Wait(), get the Index-th socket which is ready for reading.

The total number of sockets ready is the integer returned by the previous call to Wait()

Parameters:
Index : Index of the socket to get
Returns:
The Index-th socket

Reimplemented in sf::Selector< Type >.


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