iocore/net/quic/QUICStreamState.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 "QUICFrame.h"
#include "QUICTransferProgressProvider.h"

enum class QUICSendStreamState {
  Init,
  Ready,
  Send,
  DataSent,
  DataRecvd,
  ResetSent,
  ResetRecvd,
};

enum class QUICReceiveStreamState {
  Init,
  Recv,
  SizeKnown,
  DataRecvd,
  ResetRecvd,
  DataRead,
  ResetRead,
};

enum class QUICBidirectionalStreamState {
  Init,
  Idle,
  Open,
  HC_R,
  HC_L,
  Closed,
  Invalid,
};

template <class T> class QUICStreamStateMachine
{
public:
  virtual ~QUICStreamStateMachine() {}

  virtual T
  get() const
  {
    return this->_state;
  }

  virtual void update_with_sending_frame(const QUICFrame &frame)   = 0;
  virtual void update_with_receiving_frame(const QUICFrame &frame) = 0;

  virtual bool is_allowed_to_send(QUICFrameType type) const        = 0;
  virtual bool is_allowed_to_send(const QUICFrame &frame) const    = 0;
  virtual bool is_allowed_to_receive(QUICFrameType type) const     = 0;
  virtual bool is_allowed_to_receive(const QUICFrame &frame) const = 0;

protected:
  void
  _set_state(T s)
  {
    ink_assert(s != T::Init);
    this->_state = s;
  }

private:
  T _state = T::Init;
};

class QUICUnidirectionalStreamStateMachine
{
public:
  QUICUnidirectionalStreamStateMachine(QUICTransferProgressProvider *in, QUICTransferProgressProvider *out)
    : _in_progress(in), _out_progress(out)
  {
  }

protected:
  QUICTransferProgressProvider *_in_progress  = nullptr;
  QUICTransferProgressProvider *_out_progress = nullptr;
};

class QUICSendStreamStateMachine : public QUICUnidirectionalStreamStateMachine, public QUICStreamStateMachine<QUICSendStreamState>
{
public:
  QUICSendStreamStateMachine(QUICTransferProgressProvider *in, QUICTransferProgressProvider *out)
    : QUICUnidirectionalStreamStateMachine(in, out)
  {
    this->_set_state(QUICSendStreamState::Ready);
  }

  void update_with_sending_frame(const QUICFrame &frame) override;
  void update_with_receiving_frame(const QUICFrame &frame) override;
  void update_on_ack();

  bool is_allowed_to_send(QUICFrameType type) const override;
  bool is_allowed_to_send(const QUICFrame &frame) const override;
  bool is_allowed_to_receive(QUICFrameType type) const override;
  bool is_allowed_to_receive(const QUICFrame &frame) const override;

  void update(const QUICReceiveStreamState opposite_side);
};

class QUICReceiveStreamStateMachine : public QUICUnidirectionalStreamStateMachine,
                                      public QUICStreamStateMachine<QUICReceiveStreamState>
{
public:
  QUICReceiveStreamStateMachine(QUICTransferProgressProvider *in, QUICTransferProgressProvider *out)
    : QUICUnidirectionalStreamStateMachine(in, out)
  {
  }

  void update_with_sending_frame(const QUICFrame &frame) override;
  void update_with_receiving_frame(const QUICFrame &frame) override;
  void update_on_read();
  void update_on_eos();

  bool is_allowed_to_send(QUICFrameType type) const override;
  bool is_allowed_to_send(const QUICFrame &frame) const override;
  bool is_allowed_to_receive(QUICFrameType type) const override;
  bool is_allowed_to_receive(const QUICFrame &frame) const override;

  void update(const QUICSendStreamState opposite_side);
};

class QUICBidirectionalStreamStateMachine : public QUICStreamStateMachine<QUICBidirectionalStreamState>
{
public:
  QUICBidirectionalStreamStateMachine(QUICTransferProgressProvider *send_in, QUICTransferProgressProvider *send_out,
                                      QUICTransferProgressProvider *recv_in, QUICTransferProgressProvider *recv_out)
    : _send_stream_state(send_in, send_out), _recv_stream_state(recv_in, recv_out)
  {
    this->_recv_stream_state.update(this->_send_stream_state.get());
  };

  QUICBidirectionalStreamState get() const override;

  void update_with_sending_frame(const QUICFrame &frame) override;
  void update_with_receiving_frame(const QUICFrame &frame) override;
  void update_on_ack();
  void update_on_read();
  void update_on_eos();

  bool is_allowed_to_send(QUICFrameType type) const override;
  bool is_allowed_to_send(const QUICFrame &frame) const override;
  bool is_allowed_to_receive(QUICFrameType type) const override;
  bool is_allowed_to_receive(const QUICFrame &frame) const override;

private:
  QUICSendStreamStateMachine _send_stream_state;
  QUICReceiveStreamStateMachine _recv_stream_state;
};