WsfXIO_Subscription.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_SUBSCRIPTION_HPP
#define WSFXIO_SUBSCRIPTION_HPP
 
#include "wsf_export.h"
 
#include "UtCallbackHolder.hpp"
class WsfXIO_Connection;
class WsfXIO_Interface;
class WsfXIO_RequestDataPkt;
class WsfXIO_ResponsePkt;
class WsfXIO_Service;

typedef std::pair<int, int> WsfXIO_SubscriptionId;

class WSF_EXPORT WsfXIO_Subscription
{
public:
   WsfXIO_Subscription(WsfXIO_Connection* aConnectionPtr);
   WsfXIO_Subscription(WsfXIO_RequestDataPkt& aRequest);
 
   ~WsfXIO_Subscription();
 
   void Initialize(WsfXIO_Service* aProviderPtr);

   WsfXIO_SubscriptionId GetId() const { return mId; }

   int GetRequestId() const { return mId.second; }

   int GetConnectionId() const { return mId.first; }

   WsfXIO_Service* GetService() const { return mProviderPtr; }

   void SetUserCancelled(bool aHasCancelled) { mUserCancelled = aHasCancelled; }

   bool HasUserCancelled() const { return mUserCancelled; }

   WsfXIO_Connection* GetDataConnection() const { return mDataConnectionPtr; }

   WsfXIO_Connection& GetConnection() const { return *mConnectionPtr; }

   void SendResponse(WsfXIO_ResponsePkt& aPkt);
 
   WsfXIO_Interface& GetInterface() const;
 
private:
   WsfXIO_SubscriptionId mId;
   WsfXIO_Service*       mProviderPtr;
   int                   mSubscriptionId;
   WsfXIO_Connection*    mConnectionPtr;
   WsfXIO_Connection*    mDataConnectionPtr;
   bool                  mUserCancelled;
};
 
#endif