OpenSpace/include/openspace/network/parallelconnection.h

/*****************************************************************************************
 *                                                                                       *
 * OpenSpace                                                                             *
 *                                                                                       *
 * Copyright (c) 2014-2016                                                               *
 *                                                                                       *
 * Permission is hereby granted, free of charge, to any person obtaining a copy of this  *
 * software and associated documentation files (the "Software"), to deal in the Software *
 * without restriction, including without limitation the rights to use, copy, modify,    *
 * merge, publish, distribute, sublicense, and/or sell copies of the Software, and to    *
 * permit persons to whom the Software is furnished to do so, subject to the following   *
 * conditions:                                                                           *
 *                                                                                       *
 * The above copyright notice and this permission notice shall be included in all copies *
 * or substantial portions of the Software.                                              *
 *                                                                                       *
 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED,   *
 * INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A         *
 * PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT    *
 * HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF  *
 * CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE  *
 * OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.                                         *
 ****************************************************************************************/

#ifndef __PARALLELCONNECTION_H__
#define __PARALLELCONNECTION_H__

//openspace includes
#include <openspace/scripting/scriptengine.h>
#include <openspace/util/powerscaledcoordinate.h>
#include <openspace/network/messagestructures.h>

//glm includes
#include <glm/gtx/quaternion.hpp>

//std includes
#include <string>
#include <vector>
#include <atomic>
#include <thread>
#include <sstream>
#include <mutex>
#include <map>
#include <condition_variable>

#ifdef WIN32
#ifndef WIN32_LEAN_AND_MEAN
#define WIN32_LEAN_AND_MEAN
#endif
#include <winsock2.h>
#include <windows.h>
#include <ws2tcpip.h>
#endif

#if defined(WIN32) || defined(__MING32__) || defined(__MING64__)
typedef size_t _SOCKET;
#else
typedef int _SOCKET;
#include <netdb.h>
#endif

namespace openspace{
    
    namespace network{
        
        class ParallelConnection{
        public:
            
            ParallelConnection();
            
            ~ParallelConnection();
            
            void clientConnect();
            
            void setPort(const std::string &port);
            
            void setAddress(const std::string &address);
            
            void setName(const std::string& name);
            
            bool isHost();
            
            void requestHostship(const std::string &password);

            void setPassword(const std::string &password);
            
            void signalDisconnect();
            
            void preSynchronization();
            
            void scriptMessage(const std::string propIdentifier, const std::string propValue);
            
            enum MessageTypes{
                Authentication=0,
                Initialization,
                Data,
                Script, //obsolete now 
                HostInfo,
                InitializationRequest,
                HostshipRequest,
                InitializationCompleted
            };
            
            /**
             * Returns the Lua library that contains all Lua functions available to affect the
             * remote OS parallel connection. The functions contained are
             * -
             * \return The Lua library that contains all Lua functions available to affect the
             * interaction
             */
            static scripting::LuaLibrary luaLibrary();
            
        protected:
            
        private:
            //@TODO change this into the ghoul hasher for client AND server
            uint32_t hash(const std::string &val){
                uint32_t hashVal = 0, i;
                size_t len = val.length();

                for (hashVal = i = 0; i < len; ++i){
                    hashVal += val.c_str()[i];
                    hashVal += (hashVal << 10);
                    hashVal ^= (hashVal >> 6);
                }

                hashVal += (hashVal << 3);
                hashVal ^= (hashVal >> 11);
                hashVal += (hashVal << 15);

                return hashVal;
            };
            
            void queueMessage(std::vector<char> message);
            
            void disconnect();
            
            void writeHeader(std::vector<char> &buffer, uint32_t messageType);

            void closeSocket();

            bool initNetworkAPI();

            void establishConnection(addrinfo *info);

            void sendAuthentication();

            void listenCommunication();

            void delegateDecoding(uint32_t type);

            void initializationMessageReceived();

            void dataMessageReceived();

            void hostInfoMessageReceived();
            
            void initializationRequestMessageReceived();

            void broadcast();
            
            int headerSize();

            int receiveData(_SOCKET & socket, std::vector<char> &buffer, int length, int flags);
            
            void sendFunc();
            
            bool parseHints(addrinfo &info);
            
            void threadManagement();
            
            std::string scriptFromPropertyAndValue(const std::string property, const std::string value);
            
            uint32_t _passCode;
            std::string _port;
            std::string _address;
            std::string _name;
            _SOCKET _clientSocket;
            std::thread *_connectionThread;
            std::thread *_broadcastThread;
            std::thread *_sendThread;
            std::thread *_listenThread;
            std::thread *_handlerThread;
            std::atomic<bool> _isHost;
            std::atomic<bool> _isConnected;
            std::atomic<bool> _performDisconnect;
            std::atomic<bool> _isRunning;
            std::atomic<bool> _tryConnect;
            std::atomic<bool> _initializationTimejumpRequired;

            std::condition_variable _disconnectCondition;
            std::mutex _disconnectMutex;
            
            std::vector<std::vector<char>> _sendBuffer;
            std::mutex _sendBufferMutex;
            std::condition_variable _sendCondition;
            
            network::datamessagestructures::TimeKeyframe _latestTimeKeyframe;
            std::mutex _timeKeyframeMutex;
            std::atomic<bool> _latestTimeKeyframeValid;
            std::map<std::string, std::string> _currentState;
            std::mutex _currentStateMutex;
        };
    } // namespace network
    
} // namespace openspace

#endif // __OSPARALLELCONNECTION_H__