DeviceToken.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_DeviceToken_h_GUID_428B015C_19A2_46B0_CFE6_CC100763D387
#define INCLUDED_DeviceToken_h_GUID_428B015C_19A2_46B0_CFE6_CC100763D387

// Internal Includes
#include <osvr/Connection/DeviceTokenPtr.h>
#include <osvr/Connection/MessageTypePtr.h>
#include <osvr/Connection/Export.h>
#include <osvr/Connection/DeviceInitObject_fwd.h>
#include <osvr/Connection/ConnectionPtr.h>
#include <osvr/Connection/ConnectionDevicePtr.h>
#include <osvr/Util/DeviceCallbackTypesC.h>
#include <osvr/Util/TimeValue.h>
#include <osvr/Util/GuardPtr.h>
#include <osvr/Connection/ServerInterfaceList.h>
#include <osvr/Util/KeyedOwnershipContainer.h>

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

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

namespace osvr {
namespace connection {
    typedef std::function<OSVR_ReturnCode()> DeviceUpdateCallback;
} // namespace connection
} // namespace osvr

struct OSVR_DeviceTokenObject : boost::noncopyable {
  public:
    OSVR_CONNECTION_EXPORT static osvr::connection::DeviceTokenPtr
    createAsyncDevice(osvr::connection::DeviceInitObject &init);
    OSVR_CONNECTION_EXPORT static osvr::connection::DeviceTokenPtr
    createSyncDevice(osvr::connection::DeviceInitObject &init);
    OSVR_CONNECTION_EXPORT static osvr::connection::DeviceTokenPtr
    createVirtualDevice(std::string const &name,
                        osvr::connection::ConnectionPtr const &conn);

    using EventFunction = std::function<void()>;

    virtual ~OSVR_DeviceTokenObject();

    OSVR_CONNECTION_EXPORT std::string const &getName() const;

    OSVR_CONNECTION_EXPORT void
    setUpdateCallback(osvr::connection::DeviceUpdateCallback const &cb);

    OSVR_CONNECTION_EXPORT void
    setPreConnectionInteract(EventFunction const &f);

    OSVR_CONNECTION_EXPORT void sendData(osvr::connection::MessageType *type,
                                         const char *bytestream, size_t len);

    OSVR_CONNECTION_EXPORT void
    sendData(osvr::util::time::TimeValue const &timestamp,
             osvr::connection::MessageType *type, const char *bytestream,
             size_t len);

    OSVR_CONNECTION_EXPORT osvr::util::GuardPtr getSendGuard();

    void connectionInteract();

    void stopThreads();

    OSVR_CONNECTION_EXPORT void
    setDeviceDescriptor(std::string const &jsonString);

    template <typename T> void *acquireObject(T obj) {
        return m_ownedObjects.acquire(obj);
    }

    OSVR_CONNECTION_EXPORT bool releaseObject(void *obj);

  protected:
    OSVR_DeviceTokenObject(std::string const &name);
    osvr::connection::ConnectionPtr m_getConnection();
    osvr::connection::ConnectionDevicePtr m_getConnectionDevice();
    virtual void
    m_setUpdateCallback(osvr::connection::DeviceUpdateCallback const &cb) = 0;
    virtual void m_sendData(osvr::util::time::TimeValue const &timestamp,
                            osvr::connection::MessageType *type,
                            const char *bytestream, size_t len) = 0;
    virtual osvr::util::GuardPtr m_getSendGuard() = 0;
    virtual void m_connectionInteract() = 0;
    virtual void m_stopThreads();

  private:
    void m_sharedInit(osvr::connection::DeviceInitObject &init);
    std::string const m_name;
    osvr::connection::ConnectionPtr m_conn;
    osvr::connection::ConnectionDevicePtr m_dev;
    osvr::connection::ServerInterfaceList m_serverInterfaces;
    EventFunction m_preConnectionInteract;
    osvr::util::MultipleKeyedOwnershipContainer m_ownedObjects;
};

#endif // INCLUDED_DeviceToken_h_GUID_428B015C_19A2_46B0_CFE6_CC100763D387