comments and gofmt

This commit is contained in:
iamqizhao
2016-01-25 11:18:41 -08:00
parent da3bb0c9f7
commit 61d7c39d4c
5 changed files with 32 additions and 18 deletions

View File

@ -91,12 +91,16 @@ func WithCodec(c Codec) DialOption {
} }
} }
// WithCompressor returns a DialOption which sets a CompressorGenerator for generating message
// compressor.
func WithCompressor(f CompressorGenerator) DialOption { func WithCompressor(f CompressorGenerator) DialOption {
return func(o *dialOptions) { return func(o *dialOptions) {
o.cg = f o.cg = f
} }
} }
// WithDecompressor returns a DialOption which sets a DecompressorGenerator for generating
// message decompressor.
func WithDecompressor(f DecompressorGenerator) DialOption { func WithDecompressor(f DecompressorGenerator) DialOption {
return func(o *dialOptions) { return func(o *dialOptions) {
o.dg = f o.dg = f

View File

@ -78,11 +78,15 @@ func (protoCodec) String() string {
return "proto" return "proto"
} }
// Compressor defines the interface gRPC uses to compress a message.
type Compressor interface { type Compressor interface {
// Do compresses p into w.
Do(w io.Writer, p []byte) error Do(w io.Writer, p []byte) error
// Type returns the compression algorithm the Compressor uses.
Type() string Type() string
} }
// NewGZIPCompressor creates a Compressor based on GZIP.
func NewGZIPCompressor() Compressor { func NewGZIPCompressor() Compressor {
return &gzipCompressor{} return &gzipCompressor{}
} }
@ -102,14 +106,18 @@ func (c *gzipCompressor) Type() string {
return "gzip" return "gzip"
} }
// Decompressor defines the interface gRPC uses to decompress a message.
type Decompressor interface { type Decompressor interface {
// Do reads the data from r and uncompress them.
Do(r io.Reader) ([]byte, error) Do(r io.Reader) ([]byte, error)
// Type returns the compression algorithm the Decompressor uses.
Type() string Type() string
} }
type gzipDecompressor struct { type gzipDecompressor struct {
} }
// NewGZIPDecompressor creates a Decompressor based on GZIP.
func NewGZIPDecompressor() Decompressor { func NewGZIPDecompressor() Decompressor {
return &gzipDecompressor{} return &gzipDecompressor{}
} }
@ -127,8 +135,10 @@ func (d *gzipDecompressor) Type() string {
return "gzip" return "gzip"
} }
// CompressorGenerator defines the function generating a Compressor.
type CompressorGenerator func() Compressor type CompressorGenerator func() Compressor
// DecompressorGenerator defines the function generating a Decompressor.
type DecompressorGenerator func() Decompressor type DecompressorGenerator func() Decompressor
// callInfo contains all related configuration and information about an RPC. // callInfo contains all related configuration and information about an RPC.

View File

@ -563,7 +563,7 @@ func testEmptyUnaryWithUserAgent(t *testing.T, e env) {
t.Fatalf("header[\"ua\"] = %q, %t, want %q, true", v, ok, testAppUA) t.Fatalf("header[\"ua\"] = %q, %t, want %q, true", v, ok, testAppUA)
} }
tearDown(s, cc) tearDown(s, cc)
ctx, _ = context.WithTimeout(context.Background(), 5 * time.Second) ctx, _ = context.WithTimeout(context.Background(), 5*time.Second)
if _, err := cc.WaitForStateChange(ctx, grpc.Ready); err != nil { if _, err := cc.WaitForStateChange(ctx, grpc.Ready); err != nil {
t.Fatalf("cc.WaitForStateChange(_, %s) = _, %v, want _, <nil>", grpc.Ready, err) t.Fatalf("cc.WaitForStateChange(_, %s) = _, %v, want _, <nil>", grpc.Ready, err)
} }
@ -823,12 +823,12 @@ func testCancelNoIO(t *testing.T, e env) {
go func() { go func() {
defer close(ch) defer close(ch)
// This should be blocked until the 1st is canceled. // This should be blocked until the 1st is canceled.
ctx, _ := context.WithTimeout(context.Background(), 2 * time.Second) ctx, _ := context.WithTimeout(context.Background(), 2*time.Second)
if _, err := tc.StreamingInputCall(ctx); err != nil { if _, err := tc.StreamingInputCall(ctx); err != nil {
t.Errorf("%v.StreamingInputCall(_) = _, %v, want _, <nil>", tc, err) t.Errorf("%v.StreamingInputCall(_) = _, %v, want _, <nil>", tc, err)
} }
}() }()
cancel(); cancel()
<-ch <-ch
} }