ChannelInfo.h

Go to the documentation of this file.

// Copyright 2019-2020 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_CHANNELINFO_H_
#define O2_FRAMEWORK_CHANNELINFO_H_
 
#include "Framework/RoutingIndices.h"
#include "Framework/TimesliceSlot.h"
#include <string>
#include <fairmq/Parts.h>
 
#include <fairmq/FwdDecls.h>
 
namespace o2::framework
{
 
enum struct InputChannelState {
  Running,
  Paused,
  Completed,
  Pull
};
 
enum struct ChannelAccountingType {
  Unknown,
  DPL,
  RAWFMQ
};
 
struct InputChannelInfo {
  InputChannelState state = InputChannelState::Running;
  uint32_t hasPendingEvents = 0;
  bool readPolled = false;
  fair::mq::Channel* channel = nullptr;
  fair::mq::Parts parts;
  bool normalOpsNotified = true;
  bool backpressureNotified = false;
  ChannelIndex id = {-1};
  ChannelAccountingType channelType = ChannelAccountingType::DPL;
  TimesliceId oldestForChannel;
  int pollerIndex = -1;
};
 
struct SendingPolicy;
struct ForwardingPolicy;
 
struct OutputChannelInfo {
  std::string name = "invalid";
  ChannelAccountingType channelType = ChannelAccountingType::DPL;
  fair::mq::Channel& channel;
  SendingPolicy const* policy;
  ChannelIndex index = {-1};
};
 
struct OutputChannelState {
  TimesliceId oldestForChannel = {0};
  // How many times sending on this channel failed
  int64_t droppedMessages = 0;
};
 
struct ForwardChannelInfo {
  std::string name = "invalid";
  ChannelAccountingType channelType = ChannelAccountingType::DPL;
  fair::mq::Channel& channel;
  ForwardingPolicy const* policy;
  ChannelIndex index = {-1};
};
 
struct ForwardChannelState {
  TimesliceId oldestForChannel = {0};
  int64_t droppedMessages = 0;
};
 
} // namespace o2::framework
 
#endif // O2_FRAMEWORK_CHANNELINFO_H_