Events/Connection.hpp

Go to the documentation of this file.

//
// Thor C++ Library
// Copyright (c) 2011 Jan Haller
// 
// 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 THOR_CONNECTION_HPP
#define THOR_CONNECTION_HPP

#include <Thor/Tools/NonCopyable.hpp>
#include <Thor/Config.hpp>

#include THOR_TR1_HEADER(memory)


namespace thor
{
namespace detail
{

    class AbstractConnectionImpl;

    template <typename Parameter>
    class Listener;

} // namespace detail



class THOR_API Connection
{
    // ---------------------------------------------------------------------------------------------------------------------------
    // Public member functions
    public:
                                    Connection();
                            
        bool                        IsConnected() const;
        
        void                        Invalidate();
        
        void                        Disconnect();

    
    // ---------------------------------------------------------------------------------------------------------------------------
    // Private variables
    private:
        std::tr1::weak_ptr<detail::AbstractConnectionImpl> mWeakRef;
        
    
    // ---------------------------------------------------------------------------------------------------------------------------
    // Friends
    template <typename Parameter>
    friend class detail::Listener;
};


class THOR_API ScopedConnection : private NonCopyable
{
    // ---------------------------------------------------------------------------------------------------------------------------
    // Public member functions
    public:
        explicit                    ScopedConnection(const Connection& connection);
                
                                    ~ScopedConnection();
                
        bool                        IsConnected() const;

    
    // ---------------------------------------------------------------------------------------------------------------------------
    // Private variables
    private:
        Connection                  mConnection;
};


} // namespace thor

#endif // THOR_CONNECTION_HPP