codec.go 1.6 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950
  1. /*
  2. *
  3. * Copyright 2014 gRPC authors.
  4. *
  5. * Licensed under the Apache License, Version 2.0 (the "License");
  6. * you may not use this file except in compliance with the License.
  7. * You may obtain a copy of the License at
  8. *
  9. * http://www.apache.org/licenses/LICENSE-2.0
  10. *
  11. * Unless required by applicable law or agreed to in writing, software
  12. * distributed under the License is distributed on an "AS IS" BASIS,
  13. * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  14. * See the License for the specific language governing permissions and
  15. * limitations under the License.
  16. *
  17. */
  18. package grpc
  19. import (
  20. "google.golang.org/grpc/encoding"
  21. _ "google.golang.org/grpc/encoding/proto" // to register the Codec for "proto"
  22. )
  23. // baseCodec contains the functionality of both Codec and encoding.Codec, but
  24. // omits the name/string, which vary between the two and are not needed for
  25. // anything besides the registry in the encoding package.
  26. type baseCodec interface {
  27. Marshal(v interface{}) ([]byte, error)
  28. Unmarshal(data []byte, v interface{}) error
  29. }
  30. var _ baseCodec = Codec(nil)
  31. var _ baseCodec = encoding.Codec(nil)
  32. // Codec defines the interface gRPC uses to encode and decode messages.
  33. // Note that implementations of this interface must be thread safe;
  34. // a Codec's methods can be called from concurrent goroutines.
  35. //
  36. // Deprecated: use encoding.Codec instead.
  37. type Codec interface {
  38. // Marshal returns the wire format of v.
  39. Marshal(v interface{}) ([]byte, error)
  40. // Unmarshal parses the wire format into v.
  41. Unmarshal(data []byte, v interface{}) error
  42. // String returns the name of the Codec implementation. This is unused by
  43. // gRPC.
  44. String() string
  45. }