2 * Copyright 2016 Facebook, Inc.
4 * Licensed to the Apache Software Foundation (ASF) under one
5 * or more contributor license agreements. See the NOTICE file
6 * distributed with this work for additional information
7 * regarding copyright ownership. The ASF licenses this file
8 * to you under the Apache License, Version 2.0 (the
9 * "License"); you may not use this file except in compliance
10 * with the License. You may obtain a copy of the License at
12 * http://www.apache.org/licenses/LICENSE-2.0
14 * Unless required by applicable law or agreed to in writing,
15 * software distributed under the License is distributed on an
16 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
17 * KIND, either express or implied. See the License for the
18 * specific language governing permissions and limitations
26 #include <folly/Function.h>
33 * Base interface to be implemented by all classes expecting to manage
34 * timeouts. AsyncTimeout will use implementations of this interface
35 * to schedule/cancel timeouts.
37 class TimeoutManager {
39 typedef std::chrono::milliseconds timeout_type;
40 using Func = folly::Function<void()>;
42 enum class InternalEnum {
49 virtual ~TimeoutManager();
52 * Attaches/detaches TimeoutManager to AsyncTimeout
54 virtual void attachTimeoutManager(AsyncTimeout* obj,
55 InternalEnum internal) = 0;
56 virtual void detachTimeoutManager(AsyncTimeout* obj) = 0;
59 * Schedules AsyncTimeout to fire after `timeout` milliseconds
61 virtual bool scheduleTimeout(AsyncTimeout* obj,
62 timeout_type timeout) = 0;
65 * Cancels the AsyncTimeout, if scheduled
67 virtual void cancelTimeout(AsyncTimeout* obj) = 0;
70 * This is used to mark the beginning of a new loop cycle by the
71 * first handler fired within that cycle.
73 virtual void bumpHandlingTime() = 0;
76 * Helper method to know whether we are running in the timeout manager
79 virtual bool isInTimeoutManagerThread() = 0;
82 * Runs the given Cob at some time after the specified number of
83 * milliseconds. (No guarantees exactly when.)
85 * Throws a std::system_error if an error occurs.
89 uint32_t milliseconds,
90 InternalEnum internal = InternalEnum::NORMAL);
93 * @see tryRunAfterDelay for more details
95 * @return true iff the cob was successfully registered.
97 bool tryRunAfterDelay(
99 uint32_t milliseconds,
100 InternalEnum internal = InternalEnum::NORMAL);
103 void clearCobTimeouts();
107 std::unique_ptr<CobTimeouts> cobTimeouts_;