TimeoutManager.h

Go to the documentation of this file.

/*
 * Copyright 2014-present Facebook, Inc.
 *
 * Licensed 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 <chrono>
#include <cstdint>

#include <folly/Function.h>

namespace folly {

class AsyncTimeout;

class TimeoutManager {
 public:
  typedef std::chrono::milliseconds timeout_type;
  using Func = folly::Function<void()>;

  enum class InternalEnum { INTERNAL, NORMAL };

  TimeoutManager();

  virtual ~TimeoutManager();

  virtual void attachTimeoutManager(
      AsyncTimeout* obj,
      InternalEnum internal) = 0;
  virtual void detachTimeoutManager(AsyncTimeout* obj) = 0;

  virtual bool scheduleTimeout(AsyncTimeout* obj, timeout_type timeout) = 0;

  virtual void cancelTimeout(AsyncTimeout* obj) = 0;

  virtual void bumpHandlingTime() = 0;

  virtual bool isInTimeoutManagerThread() = 0;

  void runAfterDelay(
      Func cob,
      uint32_t milliseconds,
      InternalEnum internal = InternalEnum::NORMAL);

  bool tryRunAfterDelay(
      Func cob,
      uint32_t milliseconds,
      InternalEnum internal = InternalEnum::NORMAL);

 protected:
  void clearCobTimeouts();

 private:
  struct CobTimeouts;
  std::unique_ptr<CobTimeouts> cobTimeouts_;
};

} // namespace folly