|
|
|
|
@ -61,11 +61,10 @@ Rich Feature Set includes: |
|
|
|
|
- Drop-in replacement for encoding/json. `json:` key in struct tag supported. |
|
|
|
|
- Provides a RPC Server and Client Codec for net/rpc communication protocol. |
|
|
|
|
- Handle unique idiosyncrasies of codecs e.g. |
|
|
|
|
- For messagepack, configure how ambiguities in handling raw bytes are resolved |
|
|
|
|
- For messagepack, provide rpc server/client codec to support |
|
|
|
|
msgpack-rpc protocol defined at: |
|
|
|
|
https://github.com/msgpack-rpc/msgpack-rpc/blob/master/spec.md
|
|
|
|
|
|
|
|
|
|
- For messagepack, configure how ambiguities in handling raw bytes are resolved |
|
|
|
|
- For messagepack, provide rpc server/client codec to support |
|
|
|
|
msgpack-rpc protocol defined at: |
|
|
|
|
https://github.com/msgpack-rpc/msgpack-rpc/blob/master/spec.md
|
|
|
|
|
|
|
|
|
|
## Extension Support |
|
|
|
|
|
|
|
|
|
@ -75,11 +74,13 @@ custom types. |
|
|
|
|
There are no restrictions on what the custom type can be. Some examples: |
|
|
|
|
|
|
|
|
|
```go |
|
|
|
|
type BisSet []int |
|
|
|
|
type BitSet64 uint64 |
|
|
|
|
type UUID string |
|
|
|
|
type MyStructWithUnexportedFields struct { a int; b bool; c []int; } |
|
|
|
|
type GifImage struct { ... } |
|
|
|
|
|
|
|
|
|
type BisSet []int |
|
|
|
|
type BitSet64 uint64 |
|
|
|
|
type UUID string |
|
|
|
|
type MyStructWithUnexportedFields struct { a int; b bool; c []int; } |
|
|
|
|
type GifImage struct { ... } |
|
|
|
|
|
|
|
|
|
``` |
|
|
|
|
|
|
|
|
|
As an illustration, MyStructWithUnexportedFields would normally be encoded |
|
|
|
|
@ -87,7 +88,6 @@ as an empty map because it has no exported fields, while UUID would be |
|
|
|
|
encoded as a string. However, with extension support, you can encode any of |
|
|
|
|
these however you like. |
|
|
|
|
|
|
|
|
|
|
|
|
|
|
## Custom Encoding and Decoding |
|
|
|
|
|
|
|
|
|
This package maintains symmetry in the encoding and decoding halfs. We |
|
|
|
|
@ -108,13 +108,11 @@ Consequently, if a type only defines one-half of the symmetry (e.g. it |
|
|
|
|
implements UnmarshalJSON() but not MarshalJSON() ), then that type doesn't |
|
|
|
|
satisfy the check and we will continue walking down the decision tree. |
|
|
|
|
|
|
|
|
|
|
|
|
|
|
## RPC |
|
|
|
|
|
|
|
|
|
RPC Client and Server Codecs are implemented, so the codecs can be used with |
|
|
|
|
the standard net/rpc package. |
|
|
|
|
|
|
|
|
|
|
|
|
|
|
## Usage |
|
|
|
|
|
|
|
|
|
The Handle is SAFE for concurrent READ, but NOT SAFE for concurrent |
|
|
|
|
@ -135,85 +133,93 @@ Consequently, the usage model is basically: |
|
|
|
|
Sample usage model: |
|
|
|
|
|
|
|
|
|
```go |
|
|
|
|
// create and configure Handle
|
|
|
|
|
var ( |
|
|
|
|
mh codec.MsgpackHandle |
|
|
|
|
) |
|
|
|
|
|
|
|
|
|
mh.MapType = reflect.TypeOf(map[string]interface{}(nil)) |
|
|
|
|
|
|
|
|
|
// configure extensions
|
|
|
|
|
// e.g. for msgpack, define functions and enable Time support for tag 1
|
|
|
|
|
mh.SetExt(reflect.TypeOf(time.Time{}), 1, myExt) |
|
|
|
|
|
|
|
|
|
// create and use decoder/encoder
|
|
|
|
|
var ( |
|
|
|
|
r io.Reader |
|
|
|
|
w io.Writer |
|
|
|
|
b []byte |
|
|
|
|
h = &mh |
|
|
|
|
) |
|
|
|
|
|
|
|
|
|
dec = codec.NewDecoder(r, h) |
|
|
|
|
dec = codec.NewDecoderBytes(b, h) |
|
|
|
|
err = dec.Decode(&v) |
|
|
|
|
|
|
|
|
|
enc = codec.NewEncoder(w, h) |
|
|
|
|
enc = codec.NewEncoderBytes(&b, h) |
|
|
|
|
err = enc.Encode(v) |
|
|
|
|
|
|
|
|
|
//RPC Server
|
|
|
|
|
go func() { |
|
|
|
|
for { |
|
|
|
|
conn, err := listener.Accept() |
|
|
|
|
rpcCodec := codec.GoRpc.ServerCodec(conn, h) |
|
|
|
|
//OR rpcCodec := codec.MsgpackSpecRpc.ServerCodec(conn, h)
|
|
|
|
|
rpc.ServeCodec(rpcCodec) |
|
|
|
|
} |
|
|
|
|
}() |
|
|
|
|
|
|
|
|
|
//RPC Communication (client side)
|
|
|
|
|
conn, err = net.Dial("tcp", "localhost:5555") |
|
|
|
|
rpcCodec := codec.GoRpc.ClientCodec(conn, h) |
|
|
|
|
//OR rpcCodec := codec.MsgpackSpecRpc.ClientCodec(conn, h)
|
|
|
|
|
client := rpc.NewClientWithCodec(rpcCodec) |
|
|
|
|
``` |
|
|
|
|
|
|
|
|
|
// create and configure Handle
|
|
|
|
|
var ( |
|
|
|
|
mh codec.MsgpackHandle |
|
|
|
|
) |
|
|
|
|
|
|
|
|
|
mh.MapType = reflect.TypeOf(map[string]interface{}(nil)) |
|
|
|
|
|
|
|
|
|
// configure extensions
|
|
|
|
|
// e.g. for msgpack, define functions and enable Time support for tag 1
|
|
|
|
|
mh.SetExt(reflect.TypeOf(time.Time{}), 1, myExt) |
|
|
|
|
|
|
|
|
|
// create and use decoder/encoder
|
|
|
|
|
var ( |
|
|
|
|
r io.Reader |
|
|
|
|
w io.Writer |
|
|
|
|
b []byte |
|
|
|
|
h = &mh |
|
|
|
|
) |
|
|
|
|
|
|
|
|
|
dec = codec.NewDecoder(r, h) |
|
|
|
|
dec = codec.NewDecoderBytes(b, h) |
|
|
|
|
err = dec.Decode(&v) |
|
|
|
|
|
|
|
|
|
enc = codec.NewEncoder(w, h) |
|
|
|
|
enc = codec.NewEncoderBytes(&b, h) |
|
|
|
|
err = enc.Encode(v) |
|
|
|
|
|
|
|
|
|
//RPC Server
|
|
|
|
|
go func() { |
|
|
|
|
for { |
|
|
|
|
conn, err := listener.Accept() |
|
|
|
|
rpcCodec := codec.GoRpc.ServerCodec(conn, h) |
|
|
|
|
//OR rpcCodec := codec.MsgpackSpecRpc.ServerCodec(conn, h)
|
|
|
|
|
rpc.ServeCodec(rpcCodec) |
|
|
|
|
} |
|
|
|
|
}() |
|
|
|
|
|
|
|
|
|
//RPC Communication (client side)
|
|
|
|
|
conn, err = net.Dial("tcp", "localhost:5555") |
|
|
|
|
rpcCodec := codec.GoRpc.ClientCodec(conn, h) |
|
|
|
|
//OR rpcCodec := codec.MsgpackSpecRpc.ClientCodec(conn, h)
|
|
|
|
|
client := rpc.NewClientWithCodec(rpcCodec) |
|
|
|
|
|
|
|
|
|
``` |
|
|
|
|
|
|
|
|
|
## Running Tests |
|
|
|
|
|
|
|
|
|
To run tests, use the following: |
|
|
|
|
|
|
|
|
|
``` |
|
|
|
|
go test |
|
|
|
|
|
|
|
|
|
go test |
|
|
|
|
|
|
|
|
|
``` |
|
|
|
|
|
|
|
|
|
To run the full suite of tests, use the following: |
|
|
|
|
|
|
|
|
|
``` |
|
|
|
|
go test -tags alltests -run Suite |
|
|
|
|
|
|
|
|
|
go test -tags alltests -run Suite |
|
|
|
|
|
|
|
|
|
``` |
|
|
|
|
|
|
|
|
|
You can run the tag 'safe' to run tests or build in safe mode. e.g. |
|
|
|
|
|
|
|
|
|
``` |
|
|
|
|
go test -tags safe -run Json |
|
|
|
|
go test -tags "alltests safe" -run Suite |
|
|
|
|
|
|
|
|
|
go test -tags safe -run Json |
|
|
|
|
go test -tags "alltests safe" -run Suite |
|
|
|
|
|
|
|
|
|
``` |
|
|
|
|
|
|
|
|
|
## Running Benchmarks |
|
|
|
|
|
|
|
|
|
``` |
|
|
|
|
cd codec/bench |
|
|
|
|
./bench.sh -d |
|
|
|
|
./bench.sh -c |
|
|
|
|
./bench.sh -s |
|
|
|
|
go test -bench . -benchmem -benchtime 1s |
|
|
|
|
|
|
|
|
|
cd codec/bench |
|
|
|
|
./bench.sh -d |
|
|
|
|
./bench.sh -c |
|
|
|
|
./bench.sh -s |
|
|
|
|
go test -bench . -benchmem -benchtime 1s |
|
|
|
|
|
|
|
|
|
``` |
|
|
|
|
|
|
|
|
|
Please see http://github.com/hashicorp/go-codec-bench .
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
## Caveats |
|
|
|
|
|
|
|
|
|
Struct fields matching the following are ignored during encoding and |
|
|
|
|
|
renovate[bot]
8 months ago
committed by