VrpnBasedConnection.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_VrpnBasedConnection_h_GUID_49F2C30F_D807_43B1_A754_9B645D3A1809
#define INCLUDED_VrpnBasedConnection_h_GUID_49F2C30F_D807_43B1_A754_9B645D3A1809

// Internal Includes
#include <osvr/Connection/Connection.h>
#include <osvr/Common/NetworkingSupport.h>

// Library/third-party includes
#include <vrpn_Connection.h>
#include <vrpn_ConnectionPtr.h>

// Standard includes
// - none

namespace osvr {
namespace connection {
    namespace messageid {
        const char *vrpnPing();
    } // namespace messageid
    class VrpnBasedConnection : public Connection {
      public:
        enum ConnectionType { VRPN_LOCAL_ONLY, VRPN_SHARED, VRPN_LOOPBACK };

        VrpnBasedConnection(ConnectionType type);

        VrpnBasedConnection(boost::optional<std::string const &> iface,
                            boost::optional<int> port);

        virtual void *getUnderlyingObject();
        virtual const char *getConnectionKindID();
        virtual ~VrpnBasedConnection();

      private:
        void m_initConnection(const char NIC[] = nullptr, int port = 0);

        virtual MessageTypePtr
        m_registerMessageType(std::string const &messageId);
        virtual ConnectionDevicePtr
        m_createConnectionDevice(DeviceInitObject &init);
        virtual void m_registerConnectionHandler(std::function<void()> handler);
        virtual void m_process();

        static int VRPN_CALLBACK m_connectionHandler(void *userdata,
                                                     vrpn_HANDLERPARAM);

        vrpn_ConnectionPtr m_vrpnConnection;
        std::vector<std::function<void()> > m_connectionHandlers;
        common::NetworkingSupport m_network;
    };

} // namespace connection
} // namespace osvr
#endif // INCLUDED_VrpnBasedConnection_h_GUID_49F2C30F_D807_43B1_A754_9B645D3A1809