/************************************************************************************

Filename    :   Service_NetSessionCommon.h
Content     :   Shared networking for service
Created     :   June 12, 2014
Authors     :   Kevin Jenkins, Chris Taylor

Copyright   :   Copyright 2014 Oculus VR, Inc. All Rights reserved.

Licensed under the Oculus VR Rift SDK License Version 3.1 (the "License"); 
you may not use the Oculus VR Rift SDK except in compliance with the License, 
which is provided at the time of installation or download, or which 
otherwise accompanies this software in either electronic or hard copy form.

You may obtain a copy of the License at

http://www.oculusvr.com/licenses/LICENSE-3.1 

Unless required by applicable law or agreed to in writing, the Oculus VR SDK 
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 OVR_Service_NetSessionCommon_h
#define OVR_Service_NetSessionCommon_h

#include "../OVR_CAPI.h"
#include "../Net/OVR_RPC1.h"
#include "../Kernel/OVR_Threads.h"
#include "../Net/OVR_BitStream.h"
#include "../Kernel/OVR_System.h"

namespace OVR {

class HMDInfo;

namespace Service {


//-----------------------------------------------------------------------------
// VirtualHmdId

// This is an identifier that is unique to each VirtualHmd object on the server
// side.  The client side uses this to opaquely reference those objects.

typedef int32_t VirtualHmdId;
static const int32_t InvalidVirtualHmdId = -1;

// Localhost-bound TCP port that the service listens on for VR apps
static const int VRServicePort = 30322; // 0x7672 = "vr" little-endian

// HMDInfo section related to networking
struct HMDNetworkInfo
{
	HMDNetworkInfo() :
		NetId(InvalidVirtualHmdId)
	{
	}

	// Network identifier for HMD
	VirtualHmdId NetId;

	// Name of the shared memory object
	String       SharedMemoryName;

	void Serialize(Net::BitStream* bs)
	{
		bs->Write(NetId);
		bs->Write(SharedMemoryName);
	}
	bool Deserialize(Net::BitStream* bs)
	{
		bs->Read(NetId);
		return bs->Read(SharedMemoryName);
	}
};


//-------------------------------------------------------------------------------------
// ***** NetSessionCommon

// Common part networking session/RPC implementation shared between client and server.

class NetSessionCommon : public Thread
{
protected:
    virtual void onSystemDestroy();
    virtual void onThreadDestroy();

public:
    NetSessionCommon();
    virtual ~NetSessionCommon();

	Net::Plugins::RPC1* GetRPC1() const
    {
        return pRPC;
    }
	Net::Session* GetSession() const
    {
        return pSession;
    }

	static void SerializeHMDInfo(Net::BitStream* bitStream, HMDInfo* hmdInfo);
	static bool DeserializeHMDInfo(Net::BitStream* bitStream, HMDInfo* hmdInfo);

public:
    // Getter/setter tools
    enum EGetterSetters
    {
        // Note: If this enumeration changes, then the Servce_NetSessionCommon.cpp
        // IsServiceProperty() function should be updated.

        EGetStringValue,
        EGetBoolValue,
        EGetIntValue,
        EGetNumberValue,
        EGetNumberValues,
        ESetStringValue,
        ESetBoolValue,
        ESetIntValue,
        ESetNumberValue,
        ESetNumberValues,

        ENumTypes
    };

    static const char* FilterKeyPrefix(const char* key);
    static bool IsServiceProperty(EGetterSetters e, const char* key);

protected:
    bool                Terminated; // Thread termination flag
    Net::Session*       pSession;   // Networking session
	Net::Plugins::RPC1* pRPC;       // Remote procedure calls object
};


}} // namespace OVR::Service

#endif // OVR_Service_NetSessionCommon_h