Selector.hpp

//
// SFML - Simple and Fast Multimedia Library
// Copyright (C) 2007-2009 Laurent Gomila (laurent.gom@gmail.com)
//
// This software is provided 'as-is', without any express or implied warranty.
// In no event will the authors be held liable for any damages arising from the use of this software.
//
// Permission is granted to anyone to use this software for any purpose,
// including commercial applications, and to alter it and redistribute it freely,
// subject to the following restrictions:
//
// 1. The origin of this software must not be misrepresented;
//    you must not claim that you wrote the original software.
//    If you use this software in a product, an acknowledgment
//    in the product documentation would be appreciated but is not required.
//
// 2. Altered source versions must be plainly marked as such,
//    and must not be misrepresented as being the original software.
//
// 3. This notice may not be removed or altered from any source distribution.
//
 
#ifndef SFML_SELECTOR_HPP
#define SFML_SELECTOR_HPP

// Headers
#include <SFML/Network/SocketUDP.hpp>
#include <SFML/Network/SocketTCP.hpp>
#include <SFML/Network/SelectorBase.hpp>
#include <map>
 
 
namespace sf
{

template <typename Type>
class Selector : private SelectorBase
{
public :

    void Add(Type Socket);

    ///
    ////////////////////////////////////////////////////////////
    void Remove(Type Socket);


    void Clear();

    /// is ready, or when the given time is out
    ///
    /// \param Timeout : Timeout, in seconds (0 by default : no timeout)
    ///
    /// \return Number of sockets ready to be read
    ///
    ////////////////////////////////////////////////////////////
    unsigned int Wait(float Timeout = 0.f);

    /// \return The Index-th socket
    ///
    ////////////////////////////////////////////////////////////
    Type GetSocketReady(unsigned int Index);
 
private :

    // Types
    typedef std::map<SocketHelper::SocketType, Type> SocketTable;

    // Member data
    SocketTable mySockets; 
};
 
#include <SFML/Network/Selector.inl>
 
// Let's define the two only valid types of Selector
typedef Selector<SocketUDP> SelectorUDP;
typedef Selector<SocketTCP> SelectorTCP;
 
} // namespace sf
 
 
#endif // SFML_SELECTOR_HPP