• Home
  • Line#
  • Scopes#
  • Navigate#
  • Raw
  • Download
1 //
2 //
3 // Copyright 2015 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_SRC_CORE_LIB_IOMGR_IOMGR_H
20 #define GRPC_SRC_CORE_LIB_IOMGR_IOMGR_H
21 
22 #include <grpc/support/port_platform.h>
23 #include <stdlib.h>
24 
25 #include "src/core/lib/iomgr/closure.h"
26 #include "src/core/lib/iomgr/port.h"
27 
28 /// Initializes the iomgr.
29 void grpc_iomgr_init();
30 
31 /// Starts any background threads for iomgr.
32 void grpc_iomgr_start();
33 
34 /// Signals the intention to shutdown the iomgr. Expects to be able to flush
35 /// exec_ctx.
36 void grpc_iomgr_shutdown();
37 
38 /// Signals the intention to shutdown all the closures registered in the
39 /// background poller.
40 void grpc_iomgr_shutdown_background_closure();
41 
42 // Returns true if polling engine runs in the background, false otherwise.
43 // Currently only 'epollbg' runs in the background.
44 //
45 bool grpc_iomgr_run_in_background();
46 
47 /// Returns true if the caller is a worker thread for any background poller.
48 bool grpc_iomgr_is_any_background_poller_thread();
49 
50 /// Returns true if the closure is registered into the background poller. Note
51 /// that the closure may or may not run yet when this function returns, and the
52 /// closure should not be blocking or long-running.
53 bool grpc_iomgr_add_closure_to_background_poller(grpc_closure* closure,
54                                                  grpc_error_handle error);
55 
56 // Exposed only for testing
57 size_t grpc_iomgr_count_objects_for_testing();
58 
59 #endif  // GRPC_SRC_CORE_LIB_IOMGR_IOMGR_H
60