FizzBase.h

Go to the documentation of this file.

/*
 *  Copyright (c) 2018-present, Facebook, Inc.
 *  All rights reserved.
 *
 *  This source code is licensed under the BSD-style license found in the
 *  LICENSE file in the root directory of this source tree.
 */

#pragma once

#include <fizz/protocol/Params.h>
#include <folly/Overload.h>

namespace fizz {

template <typename Derived, typename ActionMoveVisitor, typename StateMachine>
class FizzBase {
 public:
  FizzBase(
      const typename StateMachine::StateType& state,
      folly::IOBufQueue& transportReadBuf,
      ActionMoveVisitor& visitor,
      folly::DelayedDestructionBase* owner)
      : state_(state),
        transportReadBuf_(transportReadBuf),
        visitor_(visitor),
        owner_(owner) {}

  void writeNewSessionTicket(WriteNewSessionTicket writeNewSessionTicket);

  void appWrite(AppWrite appWrite);

  void earlyAppWrite(EarlyAppWrite appWrite);

  void appClose();

  void waitForData();

  void newTransportData();

  void moveToErrorState(const folly::AsyncSocketException& ex);

  bool inErrorState() const;

  bool actionProcessing() const;

  Buf getEkm(folly::StringPiece label, const Buf& context, uint16_t length)
      const;

 protected:
  void processActions(typename StateMachine::CompletedActions actions);

  void addProcessingActions(typename StateMachine::ProcessingActions actions);

  StateMachine machine_;
  const typename StateMachine::StateType& state_;
  folly::IOBufQueue& transportReadBuf_;

 private:
  void processPendingEvents();

  ActionMoveVisitor& visitor_;
  folly::DelayedDestructionBase* owner_;

  using PendingEvent =
      boost::variant<AppWrite, EarlyAppWrite, AppClose, WriteNewSessionTicket>;
  std::deque<PendingEvent> pendingEvents_;
  bool waitForData_{true};
  folly::Optional<folly::DelayedDestruction::DestructorGuard> actionGuard_;
  bool inProcessPendingEvents_{false};
  bool inErrorState_{false};
};
} // namespace fizz

#include <fizz/protocol/FizzBase-inl.h>