ClientInterfaceObjectManager.h

Go to the documentation of this file.

// Copyright 2015 Sensics, Inc.
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
//        http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.

#ifndef INCLUDED_ClientInterfaceObjectManager_h_GUID_DEA36722_2353_4980_2CF5_666C5D531004
#define INCLUDED_ClientInterfaceObjectManager_h_GUID_DEA36722_2353_4980_2CF5_666C5D531004

// Internal Includes
#include <osvr/Client/Export.h>
#include <osvr/Common/ClientInterfacePtr.h>
#include <osvr/Common/PathTreeObserverPtr.h>
#include <osvr/Util/Logger.h>
#include <osvr/Common/PathTree_fwd.h>
#include <osvr/Common/ClientContext_fwd.h>
#include <osvr/Client/InterfaceTree.h>

// Library/third-party includes
// - none

// Standard includes
#include <string>

namespace osvr {
namespace common {
    class PathTree;
    class PathTreeOwner;
} // namespace common
namespace client {
    class RemoteHandlerFactory;

    class ClientInterfaceObjectManager {
      public:
        OSVR_CLIENT_EXPORT
        ClientInterfaceObjectManager(common::PathTreeOwner &tree,
                                     RemoteHandlerFactory &handlerFactory,
                                     common::ClientContext &ctx);
        ClientInterfaceObjectManager &
        operator=(ClientInterfaceObjectManager const &) = delete;

        OSVR_CLIENT_EXPORT void
        addInterface(common::ClientInterfacePtr const &iface,
                     bool verboseFailure = true);
        OSVR_CLIENT_EXPORT void
        releaseInterface(common::ClientInterfacePtr const &iface);

        OSVR_CLIENT_EXPORT void updateHandlers();

      private:
        bool m_connectCallbacksOnPath(std::string const &path,
                                      bool verboseFailure = true);

        void m_removeCallbacksOnPath(std::string const &path);

        void m_connectNeededCallbacks();

        util::log::LoggerPtr const &logger() const;

        InterfaceTree m_interfaces;

        common::PathTree &m_pathTree;

        common::PathTreeObserverPtr m_treeObserver;

        RemoteHandlerFactory &m_factory;

        common::ClientContext *m_ctx;
    };
} // namespace client
} // namespace osvr

#endif // INCLUDED_ClientInterfaceObjectManager_h_GUID_DEA36722_2353_4980_2CF5_666C5D531004