RemoteConnectionPool.h

Go to the documentation of this file.

/*
 * Copyright (C) by
 *   MetraLabs GmbH (MLAB), GERMANY
 * and
 *   Neuroinformatics and Cognitive Robotics Labs (NICR) at TU Ilmenau, GERMANY
 * All rights reserved.
 *
 * Contact: info@mira-project.org
 *
 * Commercial Usage:
 *   Licensees holding valid commercial licenses may use this file in
 *   accordance with the commercial license agreement provided with the
 *   software or, alternatively, in accordance with the terms contained in
 *   a written agreement between you and MLAB or NICR.
 *
 * GNU General Public License Usage:
 *   Alternatively, this file may be used under the terms of the GNU
 *   General Public License version 3.0 as published by the Free Software
 *   Foundation and appearing in the file LICENSE.GPL3 included in the
 *   packaging of this file. Please review the following information to
 *   ensure the GNU General Public License version 3.0 requirements will be
 *   met: http://www.gnu.org/copyleft/gpl.html.
 *   Alternatively you may (at your option) use any later version of the GNU
 *   General Public License if such license has been publicly approved by
 *   MLAB and NICR (or its successors, if any).
 *
 * IN NO EVENT SHALL "MLAB" OR "NICR" BE LIABLE TO ANY PARTY FOR DIRECT,
 * INDIRECT, SPECIAL, INCIDENTAL, OR CONSEQUENTIAL DAMAGES ARISING OUT OF
 * THE USE OF THIS SOFTWARE AND ITS DOCUMENTATION, EVEN IF "MLAB" OR
 * "NICR" HAS BEEN ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 *
 * "MLAB" AND "NICR" SPECIFICALLY DISCLAIM ANY WARRANTIES, INCLUDING,
 * BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND
 * FITNESS FOR A PARTICULAR PURPOSE. THE SOFTWARE PROVIDED HEREUNDER IS
 * ON AN "AS IS" BASIS, AND "MLAB" AND "NICR" HAVE NO OBLIGATION TO
 * PROVIDE MAINTENANCE, SUPPORT, UPDATES, ENHANCEMENTS OR MODIFICATIONS.
 */

#ifndef _MIRA_FRAMEWORK_INCLUDE_FW_REMOTE_INTERNAL_REMOTECONNECTIONPOOL_H_
#define _MIRA_FRAMEWORK_INCLUDE_FW_REMOTE_INTERNAL_REMOTECONNECTIONPOOL_H_

#include <unordered_map>

#include <serialization/IsTransparentSerializable.h>
#include <fw/RemoteConnection.h>

namespace mira {


// forward declarations
class RemoteOutgoingConnectionBase;
class RemoteIncomingConnection;
class RemoteConnection;
struct KnownFramework;

class RemoteConnectionPool;

class RemoteConnectionProxy : boost::noncopyable
{
    friend class RemoteConnectionPool;
public:
    RemoteConnectionProxy() : mRemoteConnectionPool(nullptr), mRemoteConnection(nullptr) {};
    RemoteConnectionProxy (RemoteConnectionProxy&&) noexcept;
    RemoteConnectionProxy& operator= (RemoteConnectionProxy&&) noexcept;

    ~RemoteConnectionProxy();

    friend void swap(RemoteConnectionProxy& a, RemoteConnectionProxy& b);

    template<typename Reflector>
    void reflect(Reflector& r)
    {
        r.delegate(mRemoteConnection);
    }

    const RemoteConnection* operator->() const { return mRemoteConnection; }
    RemoteConnection* operator->() { return mRemoteConnection; }

    const RemoteConnection& operator*() const  { return *mRemoteConnection; }
    RemoteConnection& operator*()  { return *mRemoteConnection; }

    const RemoteConnection* get() const { return mRemoteConnection; }
    RemoteConnection* get() { return mRemoteConnection; }

    bool valid() const;

    bool operator== (const RemoteConnection* other) const { return mRemoteConnection == other; }

private:
    // only the RemoteConnectionPool has access and can create a valid instance
    RemoteConnectionProxy(RemoteConnectionPool*, RemoteConnection*);

private:
    RemoteConnectionPool* mRemoteConnectionPool;
    RemoteConnection* mRemoteConnection;
};

template <typename SerializerTag>
class IsTransparentSerializable<RemoteConnectionProxy, SerializerTag> : public std::true_type {};


class RemoteConnectionPool
{
    friend RemoteConnectionProxy;
public:
    RemoteConnectionProxy createRemoteOutgoingConnection(const KnownFramework& address);

    RemoteConnectionProxy createRemoteIncomingConnection();

    void releaseStoppedConnections();

protected:
    mutable boost::recursive_mutex mConnectionsMutex;

    void stopConnection(RemoteConnection* connection);

    std::set<RemoteConnection*> mRemoteConnections;

    std::vector<std::unique_ptr<RemoteConnection>> mStoppedConnections;
};



} // namespace

#endif