Input/Connection.hpp
Go to the documentation of this file.
00001 
00002 //
00003 // Thor C++ Library
00004 // Copyright (c) 2011-2015 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/Config.hpp>
00033 
00034 #include <SFML/System/NonCopyable.hpp>
00035 
00036 #include <memory>
00037 
00038 
00039 namespace thor
00040 {
00041 namespace detail
00042 {
00043 
00044     class AbstractConnectionImpl;
00045 
00046 } // namespace detail
00047 
00048 
00051 
00057 class THOR_API Connection
00058 {
00059     // ---------------------------------------------------------------------------------------------------------------------------
00060     // Public member functions
00061     public:
00064                                     Connection();
00065 
00068         bool                        isConnected() const;
00069 
00075         void                        invalidate();
00076 
00080         void                        disconnect();
00081 
00082 
00083     // ---------------------------------------------------------------------------------------------------------------------------
00084     // Implementation details
00085     public:
00086         // Create connection from tracker object
00087         explicit                    Connection(std::weak_ptr<detail::AbstractConnectionImpl> tracker);
00088 
00089 
00090     // ---------------------------------------------------------------------------------------------------------------------------
00091     // Private variables
00092     private:
00093         std::weak_ptr<detail::AbstractConnectionImpl> mWeakRef;
00094 };
00095 
00096 
00102 class THOR_API ScopedConnection : private sf::NonCopyable
00103 {
00104     // ---------------------------------------------------------------------------------------------------------------------------
00105     // Public member functions
00106     public:
00109                                     ScopedConnection();
00110 
00114         explicit                    ScopedConnection(const Connection& connection);
00115 
00118                                     ScopedConnection(ScopedConnection&& source);
00119 
00122         ScopedConnection&           operator= (ScopedConnection&& source);
00123 
00126                                     ~ScopedConnection();
00127 
00130         bool                        isConnected() const;
00131 
00132 
00133     // ---------------------------------------------------------------------------------------------------------------------------
00134     // Private variables
00135     private:
00136         Connection                  mConnection;
00137 };
00138 
00140 
00141 } // namespace thor
00142 
00143 #endif // THOR_CONNECTION_HPP