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_fn)(void); 24 int (*pick_unused_port_or_die_fn)(void); 25 void (*recycle_unused_port_fn)(int port); 26 } grpc_pick_port_functions; 27 28 /* pick a port number that is currently unused by either tcp or udp. return 29 0 on failure. */ 30 int grpc_pick_unused_port(void); 31 /* pick a port number that is currently unused by either tcp or udp. abort 32 on failure. */ 33 int grpc_pick_unused_port_or_die(void); 34 35 /* Return a port which was previously returned by grpc_pick_unused_port(). 36 * Implementations of grpc_pick_unused_port() backed by a portserver may limit 37 * the total number of ports available; this lets a binary return its allocated 38 * ports back to the server if it is going to allocate a large number. */ 39 void grpc_recycle_unused_port(int port); 40 41 /** Request the family of pick_port functions in \a functions be used. */ 42 void grpc_set_pick_port_functions(grpc_pick_port_functions functions); 43 44 #endif /* GRPC_TEST_CORE_UTIL_PORT_H */ 45