WsfCommObserver.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 WSFCOMMOBSERVER_HPP
#define WSFCOMMOBSERVER_HPP
 
#include "wsf_export.h"
 
#include "UtCallback.hpp"
#include "WsfCommAddress.hpp"
#include "WsfPlatform.hpp"
class WsfMessage;
class WsfSimulation;
 
namespace wsf
{
namespace comm
{
class Address;
class Comm;
class Network;
class Result;
 
namespace router
{
class Router;
class ProtocolInterface;
} // namespace router
} // namespace comm
} // namespace wsf
 
namespace WsfObserver
{
using wsf::comm::Address;
using wsf::comm::Comm;
using wsf::comm::Network;
using wsf::comm::Result;
using wsf::comm::router::ProtocolInterface;
using wsf::comm::router::Router;
 
using CommFrequencyChangedCallback        = UtCallbackListN<void(double, Comm*)>;
using CommBrokenCallback                  = UtCallbackListN<void(double, Comm*)>;
using RouterBrokenCallback                = UtCallbackListN<void(double, Router*)>;
using CommNonOperationalCallback          = UtCallbackListN<void(double, Comm*)>;
using RouterNonOperationalCallback        = UtCallbackListN<void(double, Router*)>;
using CommOperationalCallback             = UtCallbackListN<void(double, Comm*)>;
using RouterOperationalCallback           = UtCallbackListN<void(double, Router*)>;
using CommTurnedOffCallback               = UtCallbackListN<void(double, Comm*)>;
using RouterTurnedOffCallback             = UtCallbackListN<void(double, Router*)>;
using CommTurnedOnCallback                = UtCallbackListN<void(double, Comm*)>;
using RouterTurnedOnCallback              = UtCallbackListN<void(double, Router*)>;
using MessageDeliveryAttemptCallback      = UtCallbackListN<void(double, Comm*, Comm*, const WsfMessage&, Result&)>;
using MessageDiscardedCallback            = UtCallbackListN<void(double, Comm*, const WsfMessage&, const std::string&)>;
using MessageFailedRoutingCallback        = UtCallbackListN<void(double, Comm*, WsfPlatform*, const WsfMessage&)>;
using MessageHopCallback                  = UtCallbackListN<void(double, Comm*, Comm*, const WsfMessage&)>;
using MessageQueuedCallback               = UtCallbackListN<void(double, Comm*, const WsfMessage&, size_t)>;
using MessageReceivedCallback             = UtCallbackListN<void(double, Comm*, Comm*, const WsfMessage&, Result&)>;
using MessageTransmittedCallback          = UtCallbackListN<void(double, Comm*, const WsfMessage&)>;
using MessageTransmitEndedCallback        = UtCallbackListN<void(double, Comm*, const WsfMessage&)>;
using MessageTransmittedHeartbeatCallback = UtCallbackListN<void(double, Comm*, const WsfMessage&)>;
using MessageUpdatedCallback              = UtCallbackListN<void(double, Comm*, const WsfMessage&, const WsfMessage&)>;
using CommAddedToManagerCallback          = UtCallbackListN<void(double, Comm*)>;
using CommRemovedFromManagerCallback      = UtCallbackListN<void(double, Comm*)>;
using LinkAddedToManagerCallback          = UtCallbackListN<void(double, Comm*, Comm*)>;
using LinkRemovedFromManagerCallback      = UtCallbackListN<void(double, Comm*, Comm*)>;
using LinkEnabledOnManagerCallback        = UtCallbackListN<void(double, Comm*, Comm*)>;
using LinkDisabledOnManagerCallback       = UtCallbackListN<void(double, Comm*, Comm*)>;
using CommAddedToLocalCallback            = UtCallbackListN<void(double, Router*, ProtocolInterface*, Address*)>;
using CommRemovedFromLocalCallback        = UtCallbackListN<void(double, Router*, ProtocolInterface*, Address*)>;
using LinkAddedToLocalCallback     = UtCallbackListN<void(double, Router*, ProtocolInterface*, Address*, Address*)>;
using LinkRemovedFromLocalCallback = UtCallbackListN<void(double, Router*, ProtocolInterface*, Address*, Address*)>;
using LinkEnabledOnLocalCallback   = UtCallbackListN<void(double, Router*, ProtocolInterface*, Address*, Address*)>;
using LinkDisabledOnLocalCallback  = UtCallbackListN<void(double, Router*, ProtocolInterface*, Address*, Address*)>;
using NetworkAddedCallback         = UtCallbackListN<void(double, Network*)>;
using NetworkRemovedCallback       = UtCallbackListN<void(double, Network*)>;
 
WSF_EXPORT CommFrequencyChangedCallback&        CommFrequencyChanged(const WsfSimulation* aSimulationPtr);
WSF_EXPORT CommTurnedOffCallback&               CommTurnedOff(const WsfSimulation* aSimulationPtr);
WSF_EXPORT CommTurnedOnCallback&                CommTurnedOn(const WsfSimulation* aSimulationPtr);
WSF_EXPORT CommNonOperationalCallback&          CommNonOperational(const WsfSimulation* aSimulationPtr);
WSF_EXPORT CommOperationalCallback&             CommOperational(const WsfSimulation* aSimulationPtr);
WSF_EXPORT CommBrokenCallback&                  CommBroken(const WsfSimulation* aSimulationPtr);
WSF_EXPORT MessageDeliveryAttemptCallback&      MessageDeliveryAttempt(const WsfSimulation* aSimulationPtr);
WSF_EXPORT MessageDiscardedCallback&            MessageDiscarded(const WsfSimulation* aSimulationPtr);
WSF_EXPORT MessageHopCallback&                  MessageHop(const WsfSimulation* aSimulationPtr);
WSF_EXPORT MessageFailedRoutingCallback&        MessageFailedRouting(const WsfSimulation* aSimulationPtr);
WSF_EXPORT MessageQueuedCallback&               MessageQueued(const WsfSimulation* aSimulationPtr);
WSF_EXPORT MessageReceivedCallback&             MessageReceived(const WsfSimulation* aSimulationPtr);
WSF_EXPORT MessageTransmittedCallback&          MessageTransmitted(const WsfSimulation* aSimulationPtr);
WSF_EXPORT MessageTransmitEndedCallback&        MessageTransmitEnded(const WsfSimulation* aSimulationPtr);
WSF_EXPORT MessageTransmittedHeartbeatCallback& MessageTransmittedHeartbeat(const WsfSimulation* aSimulationPtr);
WSF_EXPORT MessageUpdatedCallback&              MessageUpdated(const WsfSimulation* aSimulationPtr);
WSF_EXPORT CommAddedToManagerCallback&          CommAddedToManager(const WsfSimulation* aSimulationPtr);
WSF_EXPORT CommRemovedFromManagerCallback&      CommRemovedFromManager(const WsfSimulation* aSimulationPtr);
WSF_EXPORT LinkAddedToManagerCallback&          LinkAddedToManager(const WsfSimulation* aSimulationPtr);
WSF_EXPORT LinkRemovedFromManagerCallback&      LinkRemovedFromManager(const WsfSimulation* aSimulationPtr);
WSF_EXPORT LinkEnabledOnManagerCallback&        LinkEnabledOnManager(const WsfSimulation* aSimulationPtr);
WSF_EXPORT LinkDisabledOnManagerCallback&       LinkDisabledOnManager(const WsfSimulation* aSimulationPtr);
WSF_EXPORT CommAddedToLocalCallback&            CommAddedToLocal(const WsfSimulation* aSimulationPtr);
WSF_EXPORT CommRemovedFromLocalCallback&        CommRemovedFromLocal(const WsfSimulation* aSimulationPtr);
WSF_EXPORT LinkAddedToLocalCallback&            LinkAddedToLocal(const WsfSimulation* aSimulationPtr);
WSF_EXPORT LinkRemovedFromLocalCallback&        LinkRemovedFromLocal(const WsfSimulation* aSimulationPtr);
WSF_EXPORT LinkEnabledOnLocalCallback&          LinkEnabledOnLocal(const WsfSimulation* aSimulationPtr);
WSF_EXPORT LinkDisabledOnLocalCallback&         LinkDisabledOnLocal(const WsfSimulation* aSimulationPtr);
WSF_EXPORT NetworkAddedCallback&                NetworkAdded(const WsfSimulation* aSimulationPtr);
WSF_EXPORT NetworkRemovedCallback&              NetworkRemoved(const WsfSimulation* aSimulationPtr);
WSF_EXPORT RouterBrokenCallback&                RouterBroken(const WsfSimulation* aSimulationPtr);
WSF_EXPORT RouterNonOperationalCallback&        RouterNonOperational(const WsfSimulation* aSimulationPtr);
WSF_EXPORT RouterOperationalCallback&           RouterOperational(const WsfSimulation* aSimulationPtr);
WSF_EXPORT RouterTurnedOffCallback&             RouterTurnedOff(const WsfSimulation* aSimulationPtr);
WSF_EXPORT RouterTurnedOnCallback&              RouterTurnedOn(const WsfSimulation* aSimulationPtr);
} // namespace WsfObserver

struct WSF_EXPORT WsfCommObserver
{
   //-----------------------------------------------------------------------
   // Callback attributes
   //-----------------------------------------------------------------------

   WsfObserver::CommFrequencyChangedCallback CommFrequencyChanged;

   WsfObserver::CommTurnedOffCallback CommTurnedOff;

   WsfObserver::RouterTurnedOffCallback RouterTurnedOff;

   WsfObserver::CommTurnedOnCallback CommTurnedOn;

   WsfObserver::RouterTurnedOnCallback RouterTurnedOn;

   WsfObserver::CommNonOperationalCallback CommNonOperational;

   WsfObserver::RouterNonOperationalCallback RouterNonOperational;

   WsfObserver::CommOperationalCallback CommOperational;

   WsfObserver::RouterOperationalCallback RouterOperational;

   WsfObserver::CommBrokenCallback CommBroken;

   WsfObserver::RouterBrokenCallback RouterBroken;

   WsfObserver::MessageDeliveryAttemptCallback MessageDeliveryAttempt;

   WsfObserver::MessageDiscardedCallback MessageDiscarded;

   WsfObserver::MessageHopCallback MessageHop;

   WsfObserver::MessageFailedRoutingCallback MessageFailedRouting;

   WsfObserver::MessageUpdatedCallback MessageUpdated;

   WsfObserver::MessageQueuedCallback MessageQueued;

   WsfObserver::MessageReceivedCallback MessageReceived;

   WsfObserver::MessageTransmittedCallback MessageTransmitted;

   WsfObserver::MessageTransmitEndedCallback MessageTransmitEnded;

   WsfObserver::MessageTransmittedHeartbeatCallback MessageTransmittedHeartbeat;

   WsfObserver::CommAddedToManagerCallback CommAddedToManager;

   WsfObserver::CommRemovedFromManagerCallback CommRemovedFromManager;

   WsfObserver::LinkAddedToManagerCallback LinkAddedToManager;

   WsfObserver::LinkRemovedFromManagerCallback LinkRemovedFromManager;

   WsfObserver::LinkEnabledOnManagerCallback LinkEnabledOnManager;

   WsfObserver::LinkDisabledOnManagerCallback LinkDisabledOnManager;

   WsfObserver::CommAddedToLocalCallback CommAddedToLocal;

   WsfObserver::CommRemovedFromLocalCallback CommRemovedFromLocal;

   WsfObserver::LinkAddedToLocalCallback LinkAddedToLocal;

   WsfObserver::LinkRemovedFromLocalCallback LinkRemovedFromLocal;

   WsfObserver::LinkEnabledOnLocalCallback LinkEnabledOnLocal;

   WsfObserver::LinkDisabledOnLocalCallback LinkDisabledOnLocal;

   WsfObserver::NetworkAddedCallback NetworkAdded;

   WsfObserver::NetworkRemovedCallback NetworkRemoved;
};
 
#endif