WsfXIO_Connection.hpp

Go to the documentation of this file.

// ****************************************************************************
// CUI
//
// The Advanced Framework for Simulation, Integration, and Modeling (AFSIM)
//
// Copyright 2003-2015 The Boeing Company. All rights reserved.
//
// The use, dissemination or disclosure of data in this file is subject to
// limitation or restriction. See accompanying README and LICENSE for details.
// ****************************************************************************
 
#ifndef WSFXIO_CONNECTION_HPP
#define WSFXIO_CONNECTION_HPP
 
#include "wsf_export.h"
 
#include <memory>
#include <string>
 
#include "GenUniqueId.hpp"
#include "PakConnection.hpp"
class PakSocketIO;
class PakTCP_IO;
class PakUDP_IO;
#include "UtReferenceTracked.hpp"
class UtScriptClass;
class UtScriptTypes;
#include "WsfXIO.hpp"
class WsfXIO_Packet;
class WsfXIO_InitPkt;
class WsfXIO_Interface;

class WSF_EXPORT WsfXIO_Connection : public PakConnection, public UtReferenceTracked
{
public:
   friend class WsfXIO_Interface;

   WsfXIO_Connection* GetLinkedConnection() const { return mLinkedConnectionPtr; }

   void SetLinkedConnection(WsfXIO_Connection* aConnectionPtr) { mLinkedConnectionPtr = aConnectionPtr; }

   PakSocketIO& GetIO() const { return *mIOPtr; }

   PakTCP_IO* GetTCP_IO() const { return mTCP_IO_Ptr; }

   PakUDP_IO* GetUDP_IO() const { return mUDP_IO_Ptr; }

   WsfXIO_Interface& GetInterface() { return *mInterfacePtr; }

   wsf::xio::ApplicationType GetApplicationType() const { return mApplicationType; }

   void SetApplicationType(wsf::xio::ApplicationType aApplicationType) { mApplicationType = aApplicationType; }

   void Send(WsfXIO_Packet& aPkt);

   int GetConnectionId() const { return mConnectionId; }

   const std::string& GetApplicationName() const { return mApplicationName; }

   void SetApplicationName(const std::string& aApplicationName) { mApplicationName = aApplicationName; }

   void SetApplicationId(GenUniqueId& aApplicationId) { mApplicationId = aApplicationId; }

   GenUniqueId GetApplicationId() const { return mApplicationId; }

   bool IsReliable() const { return mTCP_IO_Ptr != nullptr; }

   void SetInitialized() { mIsInitialized = true; }

   bool IsInitialized() const { return mIsInitialized; }

   bool IsDisconnecting() const { return mDisconnecting; }
 
   void SetDisconnecting() { mDisconnecting = true; }
 
   void SetClockOffset(double aRecvOffset);
 
   double GetClockOffset() const;

   bool HasClockTranslation() { return mHasClockTranslation; }
   void SetHasClockTranslation(bool aUseTranslation) { mHasClockTranslation = aUseTranslation; }

   double GetLastTimeStamp() const { return mLastTimeStamp; }
   void   SetLastTimeStamp(double aTimeStamp) { mLastTimeStamp = aTimeStamp; }
 
   static std::unique_ptr<UtScriptClass> CreateScriptClass(UtScriptTypes* aScriptTypesPtr);
   static UtScriptClass*                 GetScriptClass() { return mScriptClassPtr; }
 
   static UtScriptClass* mScriptClassPtr;
 
protected:
   // Connections are created and deleted by WsfXIO_Interface
 
   WsfXIO_Connection(WsfXIO_Interface* aInterfacePtr, PakSocketIO* aIOPtr);
 
   ~WsfXIO_Connection() override;
 
private:
   std::string               mApplicationName;
   GenUniqueId               mApplicationId;
   int                       mConnectionId;
   WsfXIO_Interface*         mInterfacePtr;
   WsfXIO_Connection*        mLinkedConnectionPtr;
   PakSocketIO*              mIOPtr;
   PakTCP_IO*                mTCP_IO_Ptr;
   PakUDP_IO*                mUDP_IO_Ptr;
   wsf::xio::ApplicationType mApplicationType;
   bool                      mIsServer;
   bool                      mIsInitialized;
   bool                      mDisconnecting;
   bool                      mHasClockTranslation;
   double                    mRecvClockOffset;
   double                    mLastTimeStamp;
};
 
#endif