StatusWebSocketHandler.h

Go to the documentation of this file.

// Copyright 2019-2026 CERN and copyright holders of ALICE O2.
// See https://alice-o2.web.cern.ch/copyright for details of the copyright holders.
// All rights not expressly granted are reserved.
//
// This software is distributed under the terms of the GNU General Public
// License v3 (GPL Version 3), copied verbatim in the file "COPYING".
//
// In applying this license CERN does not waive the privileges and immunities
// granted to it by virtue of its status as an Intergovernmental Organization
// or submit itself to any jurisdiction.
#ifndef O2_FRAMEWORK_STATUSWEBSOCKETHANDLER_H_
#define O2_FRAMEWORK_STATUSWEBSOCKETHANDLER_H_
 
#include "HTTPParser.h"
#include <map>
#include <string>
#include <unordered_set>
#include <vector>
#include <cstddef>
 
namespace o2::framework
{
struct DriverServerContext;
struct WSDPLHandler;
 
struct StatusWebSocketHandler : public WebSocketHandler {
  StatusWebSocketHandler(DriverServerContext& context, WSDPLHandler* handler);
  ~StatusWebSocketHandler() override;
 
  void headers(std::map<std::string, std::string> const& headers) override;
  void frame(char const* data, size_t s) override;
  void beginChunk() override {}
  void endChunk() override {}
  void beginFragmentation() override {}
  void endFragmentation() override {}
  void control(char const* frame, size_t s) override {}
 
  void sendSnapshot();
  void sendUpdate(size_t deviceIndex);
  void sendNewLogs(size_t deviceIndex);
 
 private:
  void sendText(std::string const& json);
  void handleListMetrics(std::string_view deviceName);
  void handleSubscribe(std::string_view deviceName, std::string_view metricsJson);
  void handleUnsubscribe(std::string_view deviceName, std::string_view metricsJson);
  void handleSubscribeLogs(std::string_view deviceName);
  void handleUnsubscribeLogs(std::string_view deviceName);
  void handleStartDevices();
  void handleEnableSignpost(std::string_view deviceName, std::string_view streamsArr);
  void handleDisableSignpost(std::string_view deviceName, std::string_view streamsArr);
  size_t findDeviceIndex(std::string_view name) const;
 
  DriverServerContext& mContext;
  WSDPLHandler* mHandler;
  std::vector<std::unordered_set<std::string>> mSubscribedMetrics;
  std::vector<size_t> mLastLogSeq;
  std::unordered_set<size_t> mLogSubscriptions;
};
 
} // namespace o2::framework
#endif // O2_FRAMEWORK_STATUSWEBSOCKETHANDLER_H_