Skip to content

Commit

Permalink
Update the comment for 'MaxCallSendMsgSize' and 'MaxCallRecvMsgSize'
Browse files Browse the repository at this point in the history
Signed-off-by: Benjamin Wang <benjamin.ahrtr@gmail.com>
  • Loading branch information
ahrtr committed Oct 16, 2024
1 parent 6779a89 commit 1b43f85
Showing 1 changed file with 6 additions and 6 deletions.
12 changes: 6 additions & 6 deletions client/v3/config.go
Original file line number Diff line number Diff line change
Expand Up @@ -45,16 +45,16 @@ type Config struct {
DialKeepAliveTimeout time.Duration `json:"dial-keep-alive-timeout"`

// MaxCallSendMsgSize is the client-side request send limit in bytes.
// If 0, it defaults to 2.0 MiB (2 * 1024 * 1024).
// Make sure that "MaxCallSendMsgSize" < server-side default send/recv limit.
// Defaults to `math.MaxInt32` if not set.
// Refer to https://pkg.go.dev/google.golang.org/grpc@v1.67.1#MaxCallSendMsgSize.
// Make sure that "MaxCallSendMsgSize" < server-side default recv limit.
// ("--max-request-bytes" flag to etcd or "embed.Config.MaxRequestBytes").
MaxCallSendMsgSize int

// MaxCallRecvMsgSize is the client-side response receive limit.
// If 0, it defaults to "math.MaxInt32", because range response can
// easily exceed request send limits.
// Make sure that "MaxCallRecvMsgSize" >= server-side default send/recv limit.
// ("--max-recv-bytes" flag to etcd).
// Defaults to 4MB if not set.
// Refer to https://pkg.go.dev/google.golang.org/grpc@v1.67.1#MaxCallRecvMsgSize.
// Make sure that "MaxCallRecvMsgSize" >= server-side default send limit.
MaxCallRecvMsgSize int

// TLS holds the client secure credentials, if any.
Expand Down

0 comments on commit 1b43f85

Please sign in to comment.