iocore/net/quic/QUICContext.h

/** @file

  A brief file description

  @section license License

  Licensed to the Apache Software Foundation (ASF) under one
  or more contributor license agreements.  See the NOTICE file
  distributed with this work for additional information
  regarding copyright ownership.  The ASF licenses this file
  to you 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.
 */

#pragma once

#include "QUICConnection.h"
#include "QUICConfig.h"
#include "QUICEvents.h"
#include "QUICCongestionController.h"

class QUICRTTProvider;
class QUICCongestionController;
class QUICPacketProtectionKeyInfoProvider;
class QUICPathManager;
class QUICPacketR;
class QUICPacket;

class QUICNetVConnection;
struct QUICPacketInfo;

// this class is a connection between the callbacks. it should do something
// TODO: it should do something
class QUICCallbackContext
{
};

class QUICCallback
{
public:
  virtual ~QUICCallback() {}

  // callback on connection close event
  virtual void connection_close_callback(QUICCallbackContext &){};
  // callback on packet send event
  virtual void packet_send_callback(QUICCallbackContext &, const QUICPacket &p){};
  // callback on packet lost event
  virtual void packet_lost_callback(QUICCallbackContext &, const QUICPacketInfo &p){};
  // callback on packet receive event
  virtual void packet_recv_callback(QUICCallbackContext &, const QUICPacket &p){};
  // callback on packet acked event
  virtual void cc_metrics_update_callback(QUICCallbackContext &, uint64_t congestion_window, uint64_t bytes_in_flight,
                                          uint64_t sshresh){};
  // callback on packet receive event
  virtual void frame_packetize_callback(QUICCallbackContext &, const QUICFrame &p){};
  // callback on packet receive event
  virtual void frame_recv_callback(QUICCallbackContext &, const QUICFrame &p){};
  // callback on packet receive event
  virtual void congestion_state_updated_callback(QUICCallbackContext &, QUICCongestionController::State p){};
};

class QUICContext
{
public:
  QUICContext(QUICRTTProvider *rtt, QUICConnectionInfoProvider *info, QUICPacketProtectionKeyInfoProvider *key_info,
              QUICPathManager *path_manager);

  virtual ~QUICContext(){};
  virtual QUICConnectionInfoProvider *connection_info() const;
  virtual QUICConfig::scoped_config config() const;
  virtual QUICLDConfig &ld_config() const;
  virtual QUICPacketProtectionKeyInfoProvider *key_info() const;
  virtual QUICCCConfig &cc_config() const;
  virtual QUICRTTProvider *rtt_provider() const;
  virtual QUICPathManager *path_manager() const;

  // regist a callback which will be called when specified event happen.
  void
  regist_callback(std::shared_ptr<QUICCallback> cbs)
  {
    this->_callbacks.push_back(cbs);
  }

  enum class CallbackEvent : uint8_t {
    PACKET_LOST,
    PACKET_SEND,
    FRAME_PACKETIZE,
    PACKET_RECV,
    FRAME_RECV,
    METRICS_UPDATE,
    CONNECTION_CLOSE,
    CONGESTION_STATE_CHANGED,
  };

  // FIXME stupid trigger should be fix in more smart way.
  void
  trigger(CallbackEvent e, const QUICPacket *p = nullptr)
  {
    QUICCallbackContext ctx;
    switch (e) {
    case CallbackEvent::PACKET_RECV:
      for (auto &&it : this->_callbacks) {
        it->packet_recv_callback(ctx, *p);
      }
      break;
    case CallbackEvent::PACKET_SEND:
      for (auto &&it : this->_callbacks) {
        it->packet_send_callback(ctx, *p);
      }
      break;
    case CallbackEvent::CONNECTION_CLOSE:
      for (auto &&it : this->_callbacks) {
        it->connection_close_callback(ctx);
      }
      break;
    default:
      break;
    }
  }

  void
  trigger(CallbackEvent e, const QUICPacketInfo &p)
  {
    QUICCallbackContext ctx;
    for (auto &&it : this->_callbacks) {
      it->packet_lost_callback(ctx, p);
    }
  }

  void
  trigger(CallbackEvent e, uint64_t congestion_window, uint64_t bytes_in_flight, uint64_t sshresh)
  {
    QUICCallbackContext ctx;
    for (auto &&it : this->_callbacks) {
      it->cc_metrics_update_callback(ctx, congestion_window, bytes_in_flight, sshresh);
    }
  }

  void
  trigger(CallbackEvent e, QUICCongestionController::State state)
  {
    QUICCallbackContext ctx;
    for (auto &&it : this->_callbacks) {
      it->congestion_state_updated_callback(ctx, state);
    }
  }

  void
  trigger(CallbackEvent e, const QUICFrame &frame)
  {
    QUICCallbackContext ctx;
    switch (e) {
    case CallbackEvent::FRAME_PACKETIZE:

      for (auto &&it : this->_callbacks) {
        it->frame_packetize_callback(ctx, frame);
      }
      break;

    case CallbackEvent::FRAME_RECV:
      for (auto &&it : this->_callbacks) {
        it->frame_recv_callback(ctx, frame);
      }
      break;
    default:
      break;
    }
  }

protected:
  // For Mock
  QUICContext() {}

private:
  QUICConfig::scoped_config _config;
  QUICPacketProtectionKeyInfoProvider *_key_info = nullptr;
  QUICConnectionInfoProvider *_connection_info   = nullptr;
  QUICRTTProvider *_rtt_provider                 = nullptr;
  QUICPathManager *_path_manager                 = nullptr;

  std::unique_ptr<QUICLDConfig> _ld_config = nullptr;
  std::unique_ptr<QUICCCConfig> _cc_config = nullptr;

  std::vector<std::shared_ptr<QUICCallback>> _callbacks;
};