rpc_util: add limitation comment for the shared buffer pool

grpc · Apr 19, 2023 · ca9f6de · ca9f6de
1 parent 7f6fdb2
commit ca9f6de
Show file tree

Hide file tree

Showing 2 changed files with 8 additions and 0 deletions.
diff --git a/dialoptions.go b/dialoptions.go
@@ -665,6 +665,10 @@ func WithResolvers(rs ...resolver.Builder) DialOption {
 // If you are unsure about how to implement a memory pool but want to utilize one,
 // begin with grpc.NewSimpleSharedBufferPool.
 //
+// Note: The shared buffer pool feature will not be active if any of the following
+// options are used: WithStatsHandler, EnableTracing, or binary logging. In such
+// cases, the shared buffer pool will be ignored.
+//
 // # Experimental
 //
 // Notice: This API is EXPERIMENTAL and may be changed or removed in a

diff --git a/server.go b/server.go
@@ -561,6 +561,10 @@ func NumStreamWorkers(numServerWorkers uint32) ServerOption {
 // If you are unsure about how to implement a memory pool but want to utilize one,
 // begin with grpc.NewSimpleSharedBufferPool.
 //
+// Note: The shared buffer pool feature will not be active if any of the following
+// options are used: StatsHandler, EnableTracing, or binary logging. In such
+// cases, the shared buffer pool will be ignored.
+//
 // # Experimental
 //
 // Notice: This API is EXPERIMENTAL and may be changed or removed in a