xref: /aosp_15_r20/external/grpc-grpc/include/grpc/fork.h (revision cc02d7e222339f7a4f6ba5f422e6413f4bd931f2)
1*cc02d7e2SAndroid Build Coastguard Worker /*
2*cc02d7e2SAndroid Build Coastguard Worker  *
3*cc02d7e2SAndroid Build Coastguard Worker  * Copyright 2017 gRPC authors.
4*cc02d7e2SAndroid Build Coastguard Worker  *
5*cc02d7e2SAndroid Build Coastguard Worker  * Licensed under the Apache License, Version 2.0 (the "License");
6*cc02d7e2SAndroid Build Coastguard Worker  * you may not use this file except in compliance with the License.
7*cc02d7e2SAndroid Build Coastguard Worker  * You may obtain a copy of the License at
8*cc02d7e2SAndroid Build Coastguard Worker  *
9*cc02d7e2SAndroid Build Coastguard Worker  *     http://www.apache.org/licenses/LICENSE-2.0
10*cc02d7e2SAndroid Build Coastguard Worker  *
11*cc02d7e2SAndroid Build Coastguard Worker  * Unless required by applicable law or agreed to in writing, software
12*cc02d7e2SAndroid Build Coastguard Worker  * distributed under the License is distributed on an "AS IS" BASIS,
13*cc02d7e2SAndroid Build Coastguard Worker  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
14*cc02d7e2SAndroid Build Coastguard Worker  * See the License for the specific language governing permissions and
15*cc02d7e2SAndroid Build Coastguard Worker  * limitations under the License.
16*cc02d7e2SAndroid Build Coastguard Worker  *
17*cc02d7e2SAndroid Build Coastguard Worker  */
18*cc02d7e2SAndroid Build Coastguard Worker 
19*cc02d7e2SAndroid Build Coastguard Worker #ifndef GRPC_FORK_H
20*cc02d7e2SAndroid Build Coastguard Worker #define GRPC_FORK_H
21*cc02d7e2SAndroid Build Coastguard Worker 
22*cc02d7e2SAndroid Build Coastguard Worker #include <grpc/support/port_platform.h>
23*cc02d7e2SAndroid Build Coastguard Worker 
24*cc02d7e2SAndroid Build Coastguard Worker /**
25*cc02d7e2SAndroid Build Coastguard Worker  * gRPC applications should call this before calling fork().  There should be no
26*cc02d7e2SAndroid Build Coastguard Worker  * active gRPC function calls between calling grpc_prefork() and
27*cc02d7e2SAndroid Build Coastguard Worker  * grpc_postfork_parent()/grpc_postfork_child().
28*cc02d7e2SAndroid Build Coastguard Worker  *
29*cc02d7e2SAndroid Build Coastguard Worker  *
30*cc02d7e2SAndroid Build Coastguard Worker  * Typical use:
31*cc02d7e2SAndroid Build Coastguard Worker  * grpc_prefork();
32*cc02d7e2SAndroid Build Coastguard Worker  * int pid = fork();
33*cc02d7e2SAndroid Build Coastguard Worker  * if (pid) {
34*cc02d7e2SAndroid Build Coastguard Worker  *  grpc_postfork_parent();
35*cc02d7e2SAndroid Build Coastguard Worker  *  // Parent process..
36*cc02d7e2SAndroid Build Coastguard Worker  * } else {
37*cc02d7e2SAndroid Build Coastguard Worker  *  grpc_postfork_child();
38*cc02d7e2SAndroid Build Coastguard Worker  *  // Child process...
39*cc02d7e2SAndroid Build Coastguard Worker  * }
40*cc02d7e2SAndroid Build Coastguard Worker  */
41*cc02d7e2SAndroid Build Coastguard Worker 
42*cc02d7e2SAndroid Build Coastguard Worker void grpc_prefork(void);
43*cc02d7e2SAndroid Build Coastguard Worker 
44*cc02d7e2SAndroid Build Coastguard Worker void grpc_postfork_parent(void);
45*cc02d7e2SAndroid Build Coastguard Worker 
46*cc02d7e2SAndroid Build Coastguard Worker void grpc_postfork_child(void);
47*cc02d7e2SAndroid Build Coastguard Worker 
48*cc02d7e2SAndroid Build Coastguard Worker void grpc_fork_handlers_auto_register(void);
49*cc02d7e2SAndroid Build Coastguard Worker 
50*cc02d7e2SAndroid Build Coastguard Worker #endif /* GRPC_FORK_H */
51