WsfCommProtocolIGMP.hpp

Go to the documentation of this file.

// ****************************************************************************
// CUI
//
// The Advanced Framework for Simulation, Integration, and Modeling (AFSIM)
//
// Copyright 2018 Infoscitex, a DCS 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 WSFCOMMPROTOCOLIGMP_HPP
#define WSFCOMMPROTOCOLIGMP_HPP
 
#include "wsf_export.h"
 
#include <unordered_set>
 
#include "UtScriptBasicTypes.hpp"
#include "WsfCommAddress.hpp"
#include "WsfCommGraph.hpp"
#include "WsfCommProtocolInterface.hpp"
#include "WsfEvent.hpp"
#include "WsfRandomVariable.hpp"
 
namespace wsf
{
namespace comm
{

class WSF_EXPORT ProtocolIGMP : public ProtocolInterface
{
public:
   static ProtocolIGMP* Find(const Comm& aParent);
   static ProtocolIGMP* FindOrCreate(Comm& aParent);
 
   ProtocolIGMP()           = default;
   ~ProtocolIGMP() override = default;


   WsfComponent*    CloneComponent() const override;
   const int*       GetComponentRoles() const override;
   void*            QueryInterface(int aRole) override;
   ProtocolPriority GetPriority() const override;
   ProtocolIGMP*    Clone() const override;
   void             Setup() override;
   const char*      GetScriptClassName() const override { return "WsfCommProtocolIGMP"; }
 
   bool Initialize(double aSimTime) override;
   bool ProcessInput(UtInput& aInput) override;


   Address      GetQuerier() const;
   virtual void LeaveGroup(double aSimTime, const Address& aAddress);
   virtual void JoinGroup(double aSimTime, const Address& aAddress);


   ProcessResult NetworkSend(double aSimTime, size_t aLayerIndex, Message& aMessage) override;
   ProcessResult NetworkReceive(double aSimTime, size_t aLayerIndex, Message& aMessage) override;
   ProcessResult PhysicalReceive(double aSimTime, size_t aLayerIndex, Message& aMessage) override;
 
   std::vector<Address> GetGroups() const { return mJoinGroups; }
 
protected:
   struct RouteData
   {
      Address                     mNextHop;
      size_t                      mHops;
      double                      mCost;
      graph::AddressList          mFullPath;
      std::unordered_set<Address> mDestinationSet;
   };
 
   Address GetMessageAddressFromAux(Message& aMessage);


   void JoinGroup(const Address& aAddress) { mJoinGroups.push_back(aAddress); }
   void LeaveGroup(const Address& aAddress);
 
private:
   std::vector<Address> mJoinGroups{};

   WsfRandomVariable mJoinDelay{0.0, WsfRandomVariable::cNON_NEGATIVE};

   WsfRandomVariable mLeaveDelay{0.0, WsfRandomVariable::cNON_NEGATIVE};
};

class WSF_EXPORT IGMP_SubscriptionEvent : public WsfEvent
{
public:
   enum class EventType : size_t
   {
      cJOIN,
      cLEAVE
   };
 
   IGMP_SubscriptionEvent(double         aSimTime,
                          EventType      aEventType,
                          const Address& aCommAddress,
                          const Address& aMulticastGroupAddress);
 
   ~IGMP_SubscriptionEvent() override = default;
 
   EventDisposition Execute() override;
 
private:
   EventType mEventType;
   Address   mCommAddress;
   Address   mMulticastAddress;
};

class WSF_EXPORT ScriptProtocolClassIGMP : public ScriptProtocolClass
{
public:
   ScriptProtocolClassIGMP(const std::string& aClassName, UtScriptTypes* aTypesPtr);
 
   ~ScriptProtocolClassIGMP() override = default;
 
   UT_DECLARE_SCRIPT_METHOD(JoinMulticastGroup);
   UT_DECLARE_SCRIPT_METHOD(LeaveMulticastGroup);
};
 
} // namespace comm
} // namespace wsf
 
WSF_DECLARE_COMPONENT_ROLE_TYPE(wsf::comm::ProtocolIGMP, cWSF_COMPONENT_COMM_PROTOCOL_IGMP);
 
#endif