Monitoring.h

/*=======================================================================
 *** THE CONTENT OF THIS WORK IS PROPRIETARY TO FEI S.A.S, (FEI S.A.S.),            ***
 ***              AND IS DISTRIBUTED UNDER A LICENSE AGREEMENT.                     ***
 ***                                                                                ***
 ***  REPRODUCTION, DISCLOSURE,  OR USE,  IN WHOLE OR IN PART,  OTHER THAN AS       ***
 ***  SPECIFIED  IN THE LICENSE ARE  NOT TO BE  UNDERTAKEN  EXCEPT WITH PRIOR       ***
 ***  WRITTEN AUTHORIZATION OF FEI S.A.S.                                           ***
 ***                                                                                ***
 ***                        RESTRICTED RIGHTS LEGEND                                ***
 ***  USE, DUPLICATION, OR DISCLOSURE BY THE GOVERNMENT OF THE CONTENT OF THIS      ***
 ***  WORK OR RELATED DOCUMENTATION IS SUBJECT TO RESTRICTIONS AS SET FORTH IN      ***
 ***  SUBPARAGRAPH (C)(1) OF THE COMMERCIAL COMPUTER SOFTWARE RESTRICTED RIGHT      ***
 ***  CLAUSE  AT FAR 52.227-19  OR SUBPARAGRAPH  (C)(1)(II)  OF  THE RIGHTS IN      ***
 ***  TECHNICAL DATA AND COMPUTER SOFTWARE CLAUSE AT DFARS 52.227-7013.             ***
 ***                                                                                ***
 ***                   COPYRIGHT (C) 1996-2021 BY FEI S.A.S,                        ***
 ***                        BORDEAUX, FRANCE                                        ***
 ***                      ALL RIGHTS RESERVED                                       ***
**=======================================================================*/
 
#pragma once
 
#include <Inventor/sys/port.h>
#include <memory>
 
namespace RemoteViz
{
  namespace Rendering
  {
 
    class MonitoringImpl;
    class MetricsListener;

    class RENDERSERVICE_API Monitoring
    {
      friend class ServiceSettingsImpl;
      friend class ConnectionImpl;
      friend class ServiceImpl;
      friend class RenderAreaImpl;
 
    public:
      enum MetricType
      {
        NONE = 0x00,
        NETWORK_LATENCY = 0x1, // 2^0, bit 0
        DECODING_TIME = 0x2, // 2^1, bit 1
        RENDERING_TIME = 0x4, // 2^2, bit 2
        ENCODING_TIME = 0x8, // 2^3, bit 3
        NUM_CLIENTS = 0x10, // 2^4, bit 4
        NUM_CONNECTIONS = 0x20, // 2^5, bit 5
        NUM_RENDERAREAS = 0x40, // 2^6, bit 6
        ALL = 0xFFFF
      };

      void addListener(std::shared_ptr<MetricsListener> listener);

      void removeListener(std::shared_ptr<MetricsListener> listener);

      unsigned int getNumListeners() const;

      void enableMetrics( unsigned int mask );

      bool isMetricEnabled( MetricType metric ) const;
 
    private:
      std::shared_ptr<MonitoringImpl> getImpl() const;
 
    private:
      Monitoring();

      std::shared_ptr<MonitoringImpl> pImpl;
    };
  }
}