AGENTS.md

1# Message Size Filter
2 
3This directory contains the implementation of the message size filter, which is
4a channel filter that enforces limits on the size of incoming and outgoing
5messages.
6 
7## Overarching Purpose
8 
9The message size filter can be used to prevent clients and servers from sending
10or receiving messages that are too large, which can help to prevent
11denial-of-service attacks and other resource exhaustion issues.
12 
13## Files
14 
15*   **`message_size_filter.h`, `message_size_filter.cc`**: These files
16    contain the implementation of the `MessageSizeFilter`, which is a channel
17    filter that checks the size of each message against the configured limits.
18 
19## Major Classes
20 
21*   **`grpc_core::MessageSizeFilter`**: The channel filter implementation.
22*   **`grpc_core::MessageSizeParsedConfig`**: A class that holds the parsed
23    message size limits from the service config or channel arguments.
24 
25## Notes
26 
27*   The message size limits can be configured on both the client and the
28    server.
29*   The limits can be set via channel arguments (e.g.,
30    `GRPC_ARG_MAX_RECEIVE_MESSAGE_LENGTH`) or through the service config.
31*   If a message exceeds the configured limit, the filter will fail the RPC
32    with a `RESOURCE_EXHAUSTED` status.
33