Documentation of SFML 1.6

Warning: this page refers to an old version of SFML. Click here to switch to the latest version.
Public Member Functions | Private Member Functions | List of all members
sf::Selector< Type > Class Template Reference

Selector allow reading from multiple sockets without blocking. More...

#include <Selector.hpp>

Inheritance diagram for sf::Selector< Type >:
sf::SelectorBase

Public Member Functions

void Add (Type Socket)
 Add a socket to watch.
 
void Remove (Type 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.
 
Type GetSocketReady (unsigned int Index)
 After a call to Wait(), get the Index-th socket which is ready for reading.
 

Private Member Functions

void Add (SocketHelper::SocketType Socket)
 Add a socket to watch.
 
void Remove (SocketHelper::SocketType Socket)
 Remove a socket.
 

Detailed Description

template<typename Type>
class sf::Selector< Type >

Selector allow reading from multiple sockets without blocking.

It's a kind of multiplexer

Definition at line 44 of file Selector.hpp.

Member Function Documentation

template<typename Type >
void sf::Selector< Type >::Add ( Type  Socket)

Add a socket to watch.

Parameters
Socket: Socket to add
template<typename Type >
void sf::Selector< Type >::Clear ( )

Remove all sockets.

template<typename Type >
Type sf::Selector< Type >::GetSocketReady ( unsigned int  Index)

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
template<typename Type >
void sf::Selector< Type >::Remove ( Type  Socket)

Remove a socket.

Parameters
Socket: Socket to remove
template<typename Type >
unsigned int sf::Selector< Type >::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
The documentation for this class was generated from the following file: