xref: /aosp_15_r20/external/grpc-grpc/src/core/load_balancing/pick_first/pick_first.h (revision cc02d7e222339f7a4f6ba5f422e6413f4bd931f2)
1 //
2 // Copyright 2023 gRPC authors.
3 //
4 // Licensed under the Apache License, Version 2.0 (the "License");
5 // you may not use this file except in compliance with the License.
6 // You may obtain a copy of the License at
7 //
8 //     http://www.apache.org/licenses/LICENSE-2.0
9 //
10 // Unless required by applicable law or agreed to in writing, software
11 // distributed under the License is distributed on an "AS IS" BASIS,
12 // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13 // See the License for the specific language governing permissions and
14 // limitations under the License.
15 //
16 
17 #ifndef GRPC_SRC_CORE_LOAD_BALANCING_PICK_FIRST_PICK_FIRST_H
18 #define GRPC_SRC_CORE_LOAD_BALANCING_PICK_FIRST_PICK_FIRST_H
19 
20 #include <grpc/support/port_platform.h>
21 
22 #include "src/core/resolver/endpoint_addresses.h"
23 
24 // Internal channel arg to enable health checking in pick_first.
25 // Intended to be used by petiole policies (e.g., round_robin) that
26 // delegate to pick_first.
27 #define GRPC_ARG_INTERNAL_PICK_FIRST_ENABLE_HEALTH_CHECKING \
28   GRPC_ARG_NO_SUBCHANNEL_PREFIX "pick_first_enable_health_checking"
29 
30 // Internal channel arg to tell pick_first to omit the prefix it normally
31 // adds to error status messages.  Intended to be used by petiole policies
32 // (e.g., round_robin) that want to add their own prefixes.
33 #define GRPC_ARG_INTERNAL_PICK_FIRST_OMIT_STATUS_MESSAGE_PREFIX \
34   GRPC_ARG_NO_SUBCHANNEL_PREFIX "pick_first_omit_status_message_prefix"
35 
36 #endif  // GRPC_SRC_CORE_LOAD_BALANCING_PICK_FIRST_PICK_FIRST_H
37