AGENTS.md

1# gRPC Core Filter
2 
3This directory contains the fundamental building blocks for the gRPC channel filter mechanism.
4 
5See also: [gRPC Core overview](../AGENTS.md)
6 
7## Overarching Purpose
8 
9The code in this directory provides the infrastructure for creating, composing, and managing channel filters. It defines the interfaces that filters must implement and provides the machinery for invoking them in the correct order. Filters are used to intercept and modify RPCs as they flow through the client and server channel stacks.
10 
11## Core Concepts
12 
13*   **`FilterArgs`**: The `FilterArgs` class provides arguments to filters that are independent of channel args. This includes things like the filter's instance ID.
14*   **Fused Filters**: Fused filters are an optimization that allows multiple filters to be combined into a single filter. This can reduce the overhead of the filter chain, and it is particularly useful for filters that are very simple and have low overhead. This is an experimental feature.
15 
16## Files
17 
18*   **`filter_args.h`**: Defines the `FilterArgs` class.
19*   **`fused_filters.cc`**: Contains an optimization to fuse multiple filters together to reduce overhead.
20*   **`auth/`**: This subdirectory contains authentication-related filters.
21 
22## Notes
23 
24*   The filter mechanism is a powerful tool for extending gRPC's functionality. It's used to implement features like authentication, retry, and compression.
25*   Filters are arranged in a stack, and each filter can pass the RPC on to the next filter in the stack, or it can terminate the RPC.
26*   Filters are used in both client and server channel stacks. See `../client_channel/AGENTS.md` and `../server/AGENTS.md` for more details about how filters are used in those stacks.
27*   Filters are registered with the `CoreConfiguration`. See `../config/AGENTS.md` for more details about how the `CoreConfiguration` works.
28