/
protocol.go
73 lines (63 loc) · 3.12 KB
/
protocol.go
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
// Copyright (c) 2019 Uber Technologies, Inc.
//
// Permission is hereby granted, free of charge, to any person obtaining a copy
// of this software and associated documentation files (the "Software"), to deal
// in the Software without restriction, including without limitation the rights
// to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
// copies of the Software, and to permit persons to whom the Software is
// furnished to do so, subject to the following conditions:
//
// The above copyright notice and this permission notice shall be included in
// all copies or substantial portions of the Software.
//
// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
// IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
// FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
// AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
// LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
// OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
// THE SOFTWARE.
// Package protocol provides implementations of different Thrift protocols.
package protocol
import (
"io"
"go.uber.org/thriftrw/wire"
)
// Protocol defines a specific way for a Thrift value to be encoded or
// decoded.
type Protocol interface {
// Encode the given Value and write the result to the given Writer.
Encode(v wire.Value, w io.Writer) error
// EncodeEnveloped encodes the enveloped value and writes the result
// to the given Writer.
EncodeEnveloped(e wire.Envelope, w io.Writer) error
// Decode reads a Value of the given type from the given Reader.
Decode(r io.ReaderAt, t wire.Type) (wire.Value, error)
// DecodeEnveloped reads an enveloped value from the given Reader.
// Enveloped values are assumed to be TStructs.
DecodeEnveloped(r io.ReaderAt) (wire.Envelope, error)
}
// EnvelopeAgnosticProtocol defines a specific way for a Thrift value to be
// encoded or decoded, additionally being able to decode requests without prior
// knowledge of whether the request is enveloped.
//
// The Binary protocol in particular can be upcast to EnvelopeAgnosticProtocol.
type EnvelopeAgnosticProtocol interface {
Protocol
// DecodeRequest reads an enveloped or un-enveloped struct from the given
// ReaderAt.
// This allows a Thrift request handler to transparently accept requests
// regardless of whether the caller is configured to submit envelopes.
// The caller specifies the expected envelope type, one of OneWay or Unary,
// on which the decoder asserts if the envelope is present.
DecodeRequest(et wire.EnvelopeType, r io.ReaderAt) (wire.Value, Responder, error)
}
// Responder captures how to respond to a request, concerning whether and what
// kind of envelope to use, how to match the sequence identifier of the
// corresponding request.
type Responder interface {
// EncodeResponse writes a response value to the writer, with the envelope
// style of the corresponding request.
// The EnvelopeType should be either wire.Reply or wire.Exception.
EncodeResponse(v wire.Value, t wire.EnvelopeType, w io.Writer) error
}