xref: /aosp_15_r20/external/grpc-grpc/test/core/util/port.h (revision cc02d7e222339f7a4f6ba5f422e6413f4bd931f2)
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_TEST_CORE_UTIL_PORT_H
20 #define GRPC_TEST_CORE_UTIL_PORT_H
21 
22 typedef struct grpc_pick_port_functions {
23   int (*pick_unused_port_or_die_fn)(void);
24   void (*recycle_unused_port_fn)(int port);
25 } grpc_pick_port_functions;
26 
27 // pick a port number that is currently unused by either tcp or udp. abort
28 // on failure.
29 int grpc_pick_unused_port_or_die(void);
30 
31 // Return a port which was previously returned by grpc_pick_unused_port().
32 // Implementations of grpc_pick_unused_port() backed by a portserver may limit
33 // the total number of ports available; this lets a binary return its allocated
34 // ports back to the server if it is going to allocate a large number.
35 void grpc_recycle_unused_port(int port);
36 
37 /// Request the family of pick_port functions in \a functions be used.
38 /// Returns the current set so they can be restored later.
39 grpc_pick_port_functions grpc_set_pick_port_functions(
40     grpc_pick_port_functions functions);
41 
42 #endif  // GRPC_TEST_CORE_UTIL_PORT_H
43