AGENTS.md

1# HTTP Client Filter
2 
3This directory contains a client-side filter for setting HTTP/2 pseudo-headers.
4 
5See also: [gRPC HTTP Filters overview](../AGENTS.md)
6 
7## Overarching Purpose
8 
9The HTTP client filter is responsible for setting various HTTP/2 pseudo-headers that are required for gRPC calls to function correctly. It also performs some basic validation of the server's response headers.
10 
11## Files
12 
13*   `http_client_filter.h`, `http_client_filter.cc`: These files define the `HttpClientFilter` class, a client-side filter that sets the `:method`, `:scheme`, `te`, `content-type`, and `user-agent` headers on outgoing requests.
14 
15## Major Classes
16 
17*   `grpc_core::HttpClientFilter`: The channel filter implementation.
18 
19## Notes
20 
21*   This filter is an essential part of the gRPC client-side channel stack. Without it, gRPC calls would not be compliant with the HTTP/2 specification.
22*   The filter's behavior can be customized using various channel arguments, such as those for setting the user agent and scheme.
23*   The `GRPC_ARG_TEST_ONLY_USE_PUT_REQUESTS` channel argument can be used to force the filter to use `PUT` requests instead of `POST`. This is intended for testing purposes only, and should not be used in production.
24