Server.h

Go to the documentation of this file.

// Copyright 2014 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_Server_h_GUID_453158B3_45B7_478D_FB83_F2F694CA5367
#define INCLUDED_Server_h_GUID_453158B3_45B7_478D_FB83_F2F694CA5367

// Internal Includes
#include <osvr/Server/Export.h>
#include <osvr/Server/ServerPtr.h>
#include <osvr/Connection/ConnectionPtr.h>
#include <osvr/Common/PathElementTypes_fwd.h>
#include <osvr/Util/UniquePtr.h>

// Library/third-party includes
#include <boost/noncopyable.hpp>
#include <boost/optional.hpp>

// Standard includes
#include <string>
#include <functional>
#include <stdexcept>

namespace Json {
class Value;
}

namespace osvr {
namespace server {
    // Forward declaration for pimpl idiom.
    class ServerImpl;

    typedef std::function<void()> MainloopMethod;

    struct ServerCreationFailure : std::runtime_error {
        ServerCreationFailure()
            : std::runtime_error("Could not create server - there is probably "
                                 "another instance of the server or a VRPN "
                                 "server running already.") {}
    };

    class Server : boost::noncopyable {
        struct private_constructor {};

      public:
        Server(connection::ConnectionPtr const &conn,
               boost::optional<std::string> const &host,
               boost::optional<int> const &port, private_constructor const &);

        OSVR_SERVER_EXPORT ~Server();

        OSVR_SERVER_EXPORT static ServerPtr createLocal();

        OSVR_SERVER_EXPORT static ServerPtr
        create(connection::ConnectionPtr const &conn);

        OSVR_SERVER_EXPORT static ServerPtr
        create(connection::ConnectionPtr const &conn,
               boost::optional<std::string> const &host,
               boost::optional<int> const &port);

        OSVR_SERVER_EXPORT static ServerPtr
        createNonListening(connection::ConnectionPtr const &conn);

        OSVR_SERVER_EXPORT void update();

        OSVR_SERVER_EXPORT void start();

        OSVR_SERVER_EXPORT void startAndAwaitShutdown();

        OSVR_SERVER_EXPORT void awaitShutdown();

        OSVR_SERVER_EXPORT void stop();

        OSVR_SERVER_EXPORT void signalStop();

        OSVR_SERVER_EXPORT void loadPlugin(std::string const &plugin);

        OSVR_SERVER_EXPORT void loadAutoPlugins();

        OSVR_SERVER_EXPORT void setHardwareDetectOnConnection();

        OSVR_SERVER_EXPORT void
        instantiateDriver(std::string const &plugin, std::string const &driver,
                          std::string const &params = std::string());

        OSVR_SERVER_EXPORT void triggerHardwareDetect();

        OSVR_SERVER_EXPORT void registerMainloopMethod(MainloopMethod f);

        OSVR_SERVER_EXPORT bool addRoute(std::string const &routingDirective);

        OSVR_SERVER_EXPORT bool
        addAlias(std::string const &path, std::string const &source,
                 common::AliasPriority priority = common::ALIASPRIORITY_MANUAL);

        OSVR_SERVER_EXPORT bool addString(std::string const &path,
                                          std::string const &value);

        OSVR_SERVER_EXPORT bool addAliases(
            Json::Value const &aliases,
            common::AliasPriority priority = common::ALIASPRIORITY_MANUAL);

        OSVR_SERVER_EXPORT void addExternalDevice(
            std::string const &path, std::string const &deviceName,
            std::string const &server, std::string const &descriptor);

        OSVR_SERVER_EXPORT void setSleepTime(int microseconds);

#if 0
        OSVR_SERVER_EXPORT int getSleepTime() const;
#endif
      private:
        unique_ptr<ServerImpl> m_impl;
    };
} // namespace server
} // namespace osvr

#endif // INCLUDED_Server_h_GUID_453158B3_45B7_478D_FB83_F2F694CA5367