Skip to content

Commit

Permalink
rpc_util: improve comment for the option function
Browse files Browse the repository at this point in the history
  • Loading branch information
hueypark committed Mar 15, 2023
1 parent b1c6496 commit 086dd28
Show file tree
Hide file tree
Showing 2 changed files with 6 additions and 4 deletions.
5 changes: 3 additions & 2 deletions dialoptions.go
Original file line number Diff line number Diff line change
Expand Up @@ -648,8 +648,9 @@ func WithResolvers(rs ...resolver.Builder) DialOption {
})
}

// WithSharedRecvBufferPool returns a DialOption that specifies shared buffer pool
// for parsing. Setting this will reduce the memory allocation in the parser.
// WithSharedRecvBufferPool returns a DialOption that configures the ClientConn
// to use the provided shared buffer pool for parsing incoming messages. Depending
// on the application's workload, this could result in reduced memory allocation.
//
// # Experimental
//
Expand Down
5 changes: 3 additions & 2 deletions server.go
Original file line number Diff line number Diff line change
Expand Up @@ -554,8 +554,9 @@ func NumStreamWorkers(numServerWorkers uint32) ServerOption {
})
}

// SharedRecvBufferPool returns a DialOption that specifies shared buffer pool
// for parsing. Setting this will reduce the memory allocation in the parser.
// SharedRecvBufferPool returns a ServerOption that configures the server
// to use the provided shared buffer pool for parsing incoming messages. Depending
// on the application's workload, this could result in reduced memory allocation.
//
// # Experimental
//
Expand Down

0 comments on commit 086dd28

Please sign in to comment.