blob: a334a11350759b8866f07f200c46f1f5d27d5cf1 [file] [log] [blame]
yang-g42879982016-10-13 15:58:31 -07001/*
2 *
David Garcia Quintasf31f0962017-02-10 14:53:58 -08003 * Copyright 2017, Google Inc.
yang-g42879982016-10-13 15:58:31 -07004 * All rights reserved.
5 *
6 * Redistribution and use in source and binary forms, with or without
7 * modification, are permitted provided that the following conditions are
8 * met:
9 *
10 * * Redistributions of source code must retain the above copyright
11 * notice, this list of conditions and the following disclaimer.
12 * * Redistributions in binary form must reproduce the above
13 * copyright notice, this list of conditions and the following disclaimer
14 * in the documentation and/or other materials provided with the
15 * distribution.
16 * * Neither the name of Google Inc. nor the names of its
17 * contributors may be used to endorse or promote products derived from
18 * this software without specific prior written permission.
19 *
20 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
21 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
22 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
23 * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
24 * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
25 * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
26 * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
27 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
28 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
29 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
30 * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
31 *
32 */
33
David Garcia Quintasf31f0962017-02-10 14:53:58 -080034#ifndef GRPC_LOAD_REPORTING_H
35#define GRPC_LOAD_REPORTING_H
yang-g42879982016-10-13 15:58:31 -070036
David Garcia Quintasf31f0962017-02-10 14:53:58 -080037#include <grpc/impl/codegen/port_platform.h>
yang-g42879982016-10-13 15:58:31 -070038
David Garcia Quintasf31f0962017-02-10 14:53:58 -080039#ifdef __cplusplus
40extern "C" {
41#endif
42
43/** Metadata key for the gRPC LB load balancer token.
44 *
45 * The value corresponding to this key is an opaque token that is given to the
46 * frontend as part of each pick; the frontend sends this token to the backend
47 * in each request it sends when using that pick. The token is used by the
48 * backend to verify the request and to allow the backend to report load to the
49 * gRPC LB system. */
50#define GRPC_LB_TOKEN_MD_KEY "lb-token"
51
David Garcia Quintasa818f722017-04-14 16:01:14 -070052/** Metadata key for gRPC LB cost reporting.
53 *
54 * The value corresponding to this key is an opaque binary blob reported by the
55 * backend as part of its trailing metadata containing cost information for the
56 * call. */
57#define GRPC_LB_COST_MD_KEY "lb-cost-bin"
David Garcia Quintasf31f0962017-02-10 14:53:58 -080058
59#ifdef __cplusplus
yang-g42879982016-10-13 15:58:31 -070060}
David Garcia Quintasf31f0962017-02-10 14:53:58 -080061#endif
yang-g42879982016-10-13 15:58:31 -070062
David Garcia Quintasf31f0962017-02-10 14:53:58 -080063#endif /* GRPC_LOAD_REPORTING_H */