Bromeon
Events/Connection.hpp
Go to the documentation of this file.
00001 
00002 //
00003 // Thor C++ Library
00004 // Copyright (c) 2011-2012 Jan Haller
00005 // 
00006 // This software is provided 'as-is', without any express or implied
00007 // warranty. In no event will the authors be held liable for any damages
00008 // arising from the use of this software.
00009 // 
00010 // Permission is granted to anyone to use this software for any purpose,
00011 // including commercial applications, and to alter it and redistribute it
00012 // freely, subject to the following restrictions:
00013 // 
00014 // 1. The origin of this software must not be misrepresented; you must not
00015 //    claim that you wrote the original software. If you use this software
00016 //    in a product, an acknowledgment in the product documentation would be
00017 //    appreciated but is not required.
00018 // 
00019 // 2. Altered source versions must be plainly marked as such, and must not be
00020 //    misrepresented as being the original software.
00021 // 
00022 // 3. This notice may not be removed or altered from any source distribution.
00023 //
00025 
00028 
00029 #ifndef THOR_CONNECTION_HPP
00030 #define THOR_CONNECTION_HPP
00031 
00032 #include <Thor/Tools/NonCopyable.hpp>
00033 #include <Thor/Config.hpp>
00034 
00035 #include THOR_TR1_HEADER(memory)
00036 
00037 
00038 namespace thor
00039 {
00040 namespace detail
00041 {
00042 
00043     class AbstractConnectionImpl;
00044 
00045     template <typename Parameter>
00046     class Listener;
00047 
00048 } // namespace detail
00049 
00050 
00053 
00058 class THOR_API Connection
00059 {
00060     // ---------------------------------------------------------------------------------------------------------------------------
00061     // Public member functions
00062     public:
00065                                     Connection();
00066                             
00069         bool                        IsConnected() const;
00070         
00076         void                        Invalidate();
00077         
00081         void                        Disconnect();
00082 
00083     
00084     // ---------------------------------------------------------------------------------------------------------------------------
00085     // Private variables
00086     private:
00087         std::tr1::weak_ptr<detail::AbstractConnectionImpl> mWeakRef;
00088         
00089     
00090     // ---------------------------------------------------------------------------------------------------------------------------
00091     // Friends
00092     template <typename Parameter>
00093     friend class detail::Listener;
00094 };
00095 
00096 
00101 class THOR_API ScopedConnection : private NonCopyable
00102 {
00103     // ---------------------------------------------------------------------------------------------------------------------------
00104     // Public member functions
00105     public:
00109         explicit                    ScopedConnection(const Connection& connection);
00110                 
00113                                     ~ScopedConnection();
00114                 
00117         bool                        IsConnected() const;
00118 
00119     
00120     // ---------------------------------------------------------------------------------------------------------------------------
00121     // Private variables
00122     private:
00123         Connection                  mConnection;
00124 };
00125 
00127 
00128 } // namespace thor
00129 
00130 #endif // THOR_CONNECTION_HPP