d979ca254e
Made every read-only pointer "const" in CSFML git-svn-id: https://sfml.svn.sourceforge.net/svnroot/sfml/branches/sfml2@1290 4e206d99-4929-0410-ac5d-dfc041789085
117 lines
4.1 KiB
C++
117 lines
4.1 KiB
C++
////////////////////////////////////////////////////////////
|
|
//
|
|
// 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
|
|
{
|
|
////////////////////////////////////////////////////////////
|
|
/// Selector allow reading from multiple sockets
|
|
/// without blocking. It's a kind of multiplexer
|
|
////////////////////////////////////////////////////////////
|
|
template <typename Type>
|
|
class Selector : private SelectorBase
|
|
{
|
|
public :
|
|
|
|
////////////////////////////////////////////////////////////
|
|
/// Add a socket to watch
|
|
///
|
|
/// \param socket : Socket to add
|
|
///
|
|
////////////////////////////////////////////////////////////
|
|
void Add(Type socket);
|
|
|
|
////////////////////////////////////////////////////////////
|
|
/// Remove a socket
|
|
///
|
|
/// \param socket : Socket to remove
|
|
///
|
|
////////////////////////////////////////////////////////////
|
|
void Remove(Type socket);
|
|
|
|
////////////////////////////////////////////////////////////
|
|
/// Remove all sockets
|
|
///
|
|
////////////////////////////////////////////////////////////
|
|
void Clear();
|
|
|
|
////////////////////////////////////////////////////////////
|
|
/// 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
|
|
///
|
|
/// \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);
|
|
|
|
////////////////////////////////////////////////////////////
|
|
/// 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()
|
|
///
|
|
/// \param index : Index of the socket to get
|
|
///
|
|
/// \return The index-th socket
|
|
///
|
|
////////////////////////////////////////////////////////////
|
|
Type GetSocketReady(unsigned int index) const;
|
|
|
|
private :
|
|
|
|
////////////////////////////////////////////////////////////
|
|
// Types
|
|
////////////////////////////////////////////////////////////
|
|
typedef std::map<SocketHelper::SocketType, Type> SocketTable;
|
|
|
|
////////////////////////////////////////////////////////////
|
|
// Member data
|
|
////////////////////////////////////////////////////////////
|
|
SocketTable mySockets; ///< Table matching the SFML socket instances with their low-level handles
|
|
};
|
|
|
|
#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
|