From 82f19ce44aa8a662c3c0c7a99237a2a27084a003 Mon Sep 17 00:00:00 2001 From: Yanjun Xiang Date: Fri, 21 Feb 2025 17:22:56 +0000 Subject: [PATCH] fix doc Signed-off-by: Yanjun Xiang --- .../service/ext_proc/v3/external_processor.proto | 16 +++++++++++----- 1 file changed, 11 insertions(+), 5 deletions(-) diff --git a/api/envoy/service/ext_proc/v3/external_processor.proto b/api/envoy/service/ext_proc/v3/external_processor.proto index e1268abe1e0c..2f9919d40410 100644 --- a/api/envoy/service/ext_proc/v3/external_processor.proto +++ b/api/envoy/service/ext_proc/v3/external_processor.proto @@ -58,22 +58,28 @@ service ExternalProcessor { // This message specifies the filter protocol configurations which will be sent to the ext_proc // server in a :ref:`ProcessingRequest `. +// If the server does not support these protocol configurations, it may choose to close the gRPC stream. +// If the server supports these protocol configurations, they should respond based on the API specification. message ProtocolConfiguration { // Specify whether the filter // :ref:`request_body_mode ` - // is set to FULL_DUPLEX_STREAMED. This helps the server to take appropriate actions after receiving a - // ``ProcessingRequest`` from the request direction. + // is set to FULL_DUPLEX_STREAMED. A "true" means Envoy is operating in the FULL_DUPLEX_STREAMED + // body mode in the request direction. The server need to operate in that mode as well. + // A "false" means Envoy is expecting a response for each request it sends. bool is_request_body_mode_full_duplex = 1; // Specify whether the filter // :ref:`response_body_mode ` - // is set to FULL_DUPLEX_STREAMED. This helps the server to take appropriate actions after receiving a - // ``ProcessingRequest`` from the response direction. + // is set to FULL_DUPLEX_STREAMED. A "true" means Envoy is operating in the FULL_DUPLEX_STREAMED + // body mode in the response direction. The server need to operate in that mode as well. + // A "false" means Envoy is expecting a response for each request it sends. + bool is_response_body_mode_full_duplex = 2; // Specify whether the filter :ref:`send_body_without_waiting_for_header_response // ` - // flag is set. + // flag is set. If Envoy is waiting for a header response for the server, a "true" means Envoy will send body to the server + // as they arrive. A "false" means Envoy will buffer the arrived data and not send it to the server. bool send_body_without_waiting_for_header_response = 3; }