collector.hpp

Go to the documentation of this file.

// Copyright 2019 Amazon.com, Inc. or its affiliates. All Rights Reserved.
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
//     http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.
 
#ifndef LIBSTATISTICS_COLLECTOR__COLLECTOR__COLLECTOR_HPP_
#define LIBSTATISTICS_COLLECTOR__COLLECTOR__COLLECTOR_HPP_
 
#include <mutex>
#include <string>
 
#include "libstatistics_collector/visibility_control.hpp"
#include "libstatistics_collector/moving_average_statistics/moving_average.hpp"
#include "libstatistics_collector/moving_average_statistics/types.hpp"
 
#include "metric_details_interface.hpp"
 
#include "rcpputils/thread_safety_annotations.hpp"
 
namespace libstatistics_collector
{
namespace collector
{
 
class Collector : public MetricDetailsInterface
{
public:
  LIBSTATISTICS_COLLECTOR_PUBLIC
  Collector() = default;
 
  LIBSTATISTICS_COLLECTOR_PUBLIC
  virtual ~Collector() = default;
 
  LIBSTATISTICS_COLLECTOR_PUBLIC
  virtual void AcceptData(const double measurement);
 
  LIBSTATISTICS_COLLECTOR_PUBLIC
  virtual moving_average_statistics::StatisticData GetStatisticsResults() const;
 
  LIBSTATISTICS_COLLECTOR_PUBLIC
  virtual void ClearCurrentMeasurements();
 
  LIBSTATISTICS_COLLECTOR_PUBLIC
  bool IsStarted() const;
 
  LIBSTATISTICS_COLLECTOR_PUBLIC
  virtual std::string GetStatusString() const;
 
  // TODO(dabonnie): uptime (once start has been called)
 
  LIBSTATISTICS_COLLECTOR_PUBLIC
  virtual bool Start();
 
  LIBSTATISTICS_COLLECTOR_PUBLIC
  virtual bool Stop();
 
private:
  virtual bool SetupStart() RCPPUTILS_TSA_REQUIRES(mutex_) = 0;
 
  virtual bool SetupStop() RCPPUTILS_TSA_REQUIRES(mutex_) = 0;
 
  mutable std::mutex mutex_;
 
  moving_average_statistics::MovingAverageStatistics collected_data_;
 
  bool started_ RCPPUTILS_TSA_GUARDED_BY(mutex_) = false;
};
 
}  // namespace collector
}  // namespace libstatistics_collector
 
#endif  // LIBSTATISTICS_COLLECTOR__COLLECTOR__COLLECTOR_HPP_