doc: mark CustomCodec as deprecated #3698
Conversation
server.go
Outdated
| @@ -242,6 +242,10 @@ 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: server side codec can be registered, and it will be picked by the | |||
There was a problem hiding this comment.
Deprecated: register codecs using encoding.RegisterCodec. The server will automatically use registered codecs based on the incoming requests' headers ?
menghanl
force-pushed
the
custom_codec_deprecated
branch
from
f9caac0
to
3f1327e
Compare
There was a problem hiding this comment.
Oops, travis is failing:
benchmark/worker/benchmark_server.go:126:24: grpc.CustomCodec is 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. (SA1019)
We could ignore these (especially if it's tests for this function) or fix the usages.
|
I updated vet to ignore this. It was already ignoring other codec related deprecated APIs. |
| // 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. |
There was a problem hiding this comment.
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.)
There was a problem hiding this comment.
Done. All deprecated APIs in this file were all available at GA.
| // 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. |
fixes #3694