Repository: grpc/grpc-go
File: experimental/experimental.go (Go)

Code before:
 */

// Package experimental is a collection of experimental features that might
// have some rough edges to them. Housing experimental features in this package
// results in a user accessing these APIs as `experimental.Foo`, thereby making
// it explicit that the feature is experimental and using them in production
// code is at their own risk.
//
// All APIs in this package are experimental.
package experimental

import (
	"google.golang.org/grpc"
	"google.golang.org/grpc/internal"
	"google.golang.org/grpc/mem"
)

// SetDefaultBufferPool sets the default buffer pool used by all grpc clients
// and servers that do not have a buffer pool configured via WithBufferPool or
// BufferPool. It also changes the buffer pool used by the proto codec, which
// can't be changed otherwise. The provided buffer pool must be non-nil. This
// must be called before creating any grpc clients or servers. The default value
// is mem.DefaultBufferPool.
func SetDefaultBufferPool(bufferPool mem.BufferPool) {
	internal.SetDefaultBufferPool.(func(mem.BufferPool))(bufferPool)
}

// WithBufferPool returns a grpc.DialOption that configures the use of bufferPool
// for parsing incoming messages on a grpc.ClientConn, and for temporary buffers
// when marshaling outgoing messages. By default, mem.DefaultBufferPool is used,
// and this option only exists to provide alternative buffer pool implementations
// to the client, such as more optimized size allocations etc. However, the
// default buffer pool is already tuned to account for many different use-cases.
//
// Note: The following options will interfere with the buffer pool because they
// require a fully materialized buffer instead of a sequence of buffers:
// EnableTracing, and binary logging. In such cases, materializing the buffer
// will generate a lot of garbage, reducing the overall benefit from using a
// pool.
func WithBufferPool(bufferPool mem.BufferPool) grpc.DialOption {
	return internal.WithBufferPool.(func(mem.BufferPool) grpc.DialOption)(bufferPool)
}

// BufferPool returns a grpc.ServerOption that configures the server to use the
// provided buffer pool for parsing incoming messages and for temporary buffers
// when marshaling outgoing messages. By default, mem.DefaultBufferPool is used,
// and this option only exists to provide alternative buffer pool implementations
// to the server, such as more optimized size allocations etc. However, the
// default buffer pool is already tuned to account for many different use-cases.
//
// Note: The following options will interfere with the buffer pool because they

Review comment (bug):
Instead of requiring users to set this before making RPCs, we recommend calling these functions within an `init()` function. This prevents data races that can occur when multiple packages invoke the same method simultaneously. For example, the [balancer.Register](https://pkg.go.dev/google.golang.org/grpc@v1.78.0/balancer#Register) function includes the following requirement:

> NOTE: this function must only be called during initialization time (i.e., in an init() function) and is not thread-safe...

Can you please add a similar note here?

Code after:
 */

// Package experimental is a collection of experimental features that might
// have some rough edges to them. Housing experimental features in this package
// results in a user accessing these APIs as `experimental.Foo`, thereby making
// it explicit that the feature is experimental and using them in production
// code is at their own risk.
//
// All APIs in this package are experimental.
package experimental

import (
	"google.golang.org/grpc"
	"google.golang.org/grpc/internal"
	"google.golang.org/grpc/mem"
)

// SetDefaultBufferPool sets the default buffer pool used by all grpc clients
// and servers that do not have a buffer pool configured via WithBufferPool or
// BufferPool. It also changes the buffer pool used by the proto codec, which
// can't be changed otherwise. The provided buffer pool must be non-nil. The
// default value is mem.DefaultBufferPool.
//
// NOTE: this function must only be called during initialization time (i.e. in
// an init() function), and is not thread-safe. The last caller wins.
func SetDefaultBufferPool(bufferPool mem.BufferPool) {
	internal.SetDefaultBufferPool.(func(mem.BufferPool))(bufferPool)
}

// WithBufferPool returns a grpc.DialOption that configures the use of bufferPool
// for parsing incoming messages on a grpc.ClientConn, and for temporary buffers
// when marshaling outgoing messages. By default, mem.DefaultBufferPool is used,
// and this option only exists to provide alternative buffer pool implementations
// to the client, such as more optimized size allocations etc. However, the
// default buffer pool is already tuned to account for many different use-cases.
//
// Note: The following options will interfere with the buffer pool because they
// require a fully materialized buffer instead of a sequence of buffers:
// EnableTracing, and binary logging. In such cases, materializing the buffer
// will generate a lot of garbage, reducing the overall benefit from using a
// pool.
func WithBufferPool(bufferPool mem.BufferPool) grpc.DialOption {
	return internal.WithBufferPool.(func(mem.BufferPool) grpc.DialOption)(bufferPool)
}

// BufferPool returns a grpc.ServerOption that configures the server to use the
// provided buffer pool for parsing incoming messages and for temporary buffers
// when marshaling outgoing messages. By default, mem.DefaultBufferPool is used,
// and this option only exists to provide alternative buffer pool implementations
// to the server, such as more optimized size allocations etc. However, the
// default buffer pool is already tuned to account for many different use-cases.