legacy-libs/grpc/deps/grpc/src/core/lib/iomgr/timer_manager.h

   1 /*
   2  *
   3  * Copyright 2017 gRPC authors.
   4  *
   5  * Licensed under the Apache License, Version 2.0 (the "License");
   6  * you may not use this file except in compliance with the License.
   7  * You may obtain a copy of the License at
   8  *
   9  *     http://www.apache.org/licenses/LICENSE-2.0
  10  *
  11  * Unless required by applicable law or agreed to in writing, software
  12  * distributed under the License is distributed on an "AS IS" BASIS,
  13  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  14  * See the License for the specific language governing permissions and
  15  * limitations under the License.
  16  *
  17  */
  18
  19 #ifndef GRPC_CORE_LIB_IOMGR_TIMER_MANAGER_H
  20 #define GRPC_CORE_LIB_IOMGR_TIMER_MANAGER_H
  21
  22 #include <grpc/support/port_platform.h>
  23
  24 #include <stdbool.h>
  25
  26 /* Timer Manager tries to keep only one thread waiting for the next timeout at
  27    all times, and thus effectively preventing the thundering herd problem. */
  28
  29 void grpc_timer_manager_init(void);
  30 void grpc_timer_manager_shutdown(void);
  31
  32 /* enable/disable threading - must be called after grpc_timer_manager_init and
  33  * before grpc_timer_manager_shutdown */
  34 void grpc_timer_manager_set_threading(bool enabled);
  35 /* explicitly perform one tick of the timer system - for when threading is
  36  * disabled */
  37 void grpc_timer_manager_tick(void);
  38 /* get global counter that tracks timer wakeups */
  39 uint64_t grpc_timer_manager_get_wakeups_testonly(void);
  40
  41 #endif /* GRPC_CORE_LIB_IOMGR_TIMER_MANAGER_H */