Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

doc: mark CustomCodec as deprecated #3698

Merged
merged 3 commits into from Jun 26, 2020
Merged

doc: mark CustomCodec as deprecated #3698

Show file tree
Hide file tree
Changes from 2 commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
3f1327e
[custom_codec_deprecated] doc: mark CustomCodec as deprecated
menghanl Jun 18, 2020
4224ab1
[custom_codec_deprecated] vet ignore customcodec
menghanl Jun 25, 2020
9ee17b3
[custom_codec_deprecated] throughout 1.x
menghanl Jun 26, 2020
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
5 changes: 5 additions & 0 deletions server.go
View file
Open in desktop
Expand Up @@ -242,6 +242,11 @@ func KeepaliveEnforcementPolicy(kep keepalive.EnforcementPolicy) ServerOption {
// CustomCodec returns a ServerOption that sets a codec for message marshaling and unmarshaling.
//
// This will override any lookups by content-subtype for Codecs registered with RegisterCodec.
//
// Deprecated: register codecs using encoding.RegisterCodec. The server will
// automatically use registered codecs based on the incoming requests' headers.
// See also
// https://github.com/grpc/grpc-go/blob/master/Documentation/encoding.md#using-a-codec.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Can you look up & see whether this is something we must keep for 1.x or if it's something we may delete in the future? And add that to the comment here. (See other "deprecated" comments for examples.)

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Done. All deprecated APIs in this file were all available at GA.

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks.

func CustomCodec(codec Codec) ServerOption {
return newFuncServerOption(func(o *serverOptions) {
o.codec = codec
Expand Down
1 change: 1 addition & 0 deletions vet.sh
View file
Open in desktop
Expand Up @@ -135,6 +135,7 @@ balancer.Picker
grpc.CallCustomCodec
grpc.Code
grpc.Compressor
grpc.CustomCodec
grpc.Decompressor
grpc.MaxMsgSize
grpc.MethodConfig
Expand Down