Connection.hpp

Go to the documentation of this file.

//
// Thor C++ Library
// Copyright (c) 2011-2016 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/Config.hpp>

#include <SFML/System/NonCopyable.hpp>

#include <memory>


namespace thor
{
namespace detail
{

    class AbstractConnectionImpl;

} // namespace detail



class THOR_API Connection
{
    // ---------------------------------------------------------------------------------------------------------------------------
    // Public member functions
    public:
                                    Connection();

        bool                        isConnected() const;

        void                        invalidate();

        void                        disconnect();


    // ---------------------------------------------------------------------------------------------------------------------------
    // Implementation details
    public:
        // Create connection from tracker object
        explicit                    Connection(std::weak_ptr<detail::AbstractConnectionImpl> tracker);


    // ---------------------------------------------------------------------------------------------------------------------------
    // Private variables
    private:
        std::weak_ptr<detail::AbstractConnectionImpl> mWeakRef;
};


class THOR_API ScopedConnection : private sf::NonCopyable
{
    // ---------------------------------------------------------------------------------------------------------------------------
    // Public member functions
    public:
                                    ScopedConnection();

        explicit                    ScopedConnection(const Connection& connection);

                                    ScopedConnection(ScopedConnection&& source);

        ScopedConnection&           operator= (ScopedConnection&& source);

                                    ~ScopedConnection();

        bool                        isConnected() const;


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


} // namespace thor

#endif // THOR_CONNECTION_HPP