summaryrefslogtreecommitdiff
path: root/lib/go/thrift/framed_transport.go
blob: e3c323afc6030e509db1875816d0df2ef3fd6db5 (plain)
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
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
/*
 * Licensed to the Apache Software Foundation (ASF) under one
 * or more contributor license agreements. See the NOTICE file
 * distributed with this work for additional information
 * regarding copyright ownership. The ASF licenses this file
 * to you under the Apache License, Version 2.0 (the
 * "License"); you may not use this file except in compliance
 * with the License. You may obtain a copy of the License at
 *
 *   http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing,
 * software distributed under the License is distributed on an
 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
 * KIND, either express or implied. See the License for the
 * specific language governing permissions and limitations
 * under the License.
 */

package thrift

import (
	"bufio"
	"bytes"
	"context"
	"encoding/binary"
	"fmt"
	"io"
)

// Deprecated: Use DEFAULT_MAX_FRAME_SIZE instead.
const DEFAULT_MAX_LENGTH = 16384000

type TFramedTransport struct {
	transport TTransport

	cfg *TConfiguration

	writeBuf *bytes.Buffer

	reader  *bufio.Reader
	readBuf *bytes.Buffer

	buffer [4]byte
}

type tFramedTransportFactory struct {
	factory TTransportFactory
	cfg     *TConfiguration
}

// Deprecated: Use NewTFramedTransportFactoryConf instead.
func NewTFramedTransportFactory(factory TTransportFactory) TTransportFactory {
	return NewTFramedTransportFactoryConf(factory, &TConfiguration{
		MaxFrameSize: DEFAULT_MAX_LENGTH,

		noPropagation: true,
	})
}

// Deprecated: Use NewTFramedTransportFactoryConf instead.
func NewTFramedTransportFactoryMaxLength(factory TTransportFactory, maxLength uint32) TTransportFactory {
	return NewTFramedTransportFactoryConf(factory, &TConfiguration{
		MaxFrameSize: int32(maxLength),

		noPropagation: true,
	})
}

func NewTFramedTransportFactoryConf(factory TTransportFactory, conf *TConfiguration) TTransportFactory {
	PropagateTConfiguration(factory, conf)
	return &tFramedTransportFactory{
		factory: factory,
		cfg:     conf,
	}
}

func (p *tFramedTransportFactory) GetTransport(base TTransport) (TTransport, error) {
	PropagateTConfiguration(base, p.cfg)
	tt, err := p.factory.GetTransport(base)
	if err != nil {
		return nil, err
	}
	return NewTFramedTransportConf(tt, p.cfg), nil
}

func (p *tFramedTransportFactory) SetTConfiguration(cfg *TConfiguration) {
	PropagateTConfiguration(p.factory, cfg)
	p.cfg = cfg
}

// Deprecated: Use NewTFramedTransportConf instead.
func NewTFramedTransport(transport TTransport) *TFramedTransport {
	return NewTFramedTransportConf(transport, &TConfiguration{
		MaxFrameSize: DEFAULT_MAX_LENGTH,

		noPropagation: true,
	})
}

// Deprecated: Use NewTFramedTransportConf instead.
func NewTFramedTransportMaxLength(transport TTransport, maxLength uint32) *TFramedTransport {
	return NewTFramedTransportConf(transport, &TConfiguration{
		MaxFrameSize: int32(maxLength),

		noPropagation: true,
	})
}

func NewTFramedTransportConf(transport TTransport, conf *TConfiguration) *TFramedTransport {
	PropagateTConfiguration(transport, conf)
	return &TFramedTransport{
		transport: transport,
		reader:    bufio.NewReader(transport),
		cfg:       conf,
	}
}

func (p *TFramedTransport) Open() error {
	return p.transport.Open()
}

func (p *TFramedTransport) IsOpen() bool {
	return p.transport.IsOpen()
}

func (p *TFramedTransport) Close() error {
	return p.transport.Close()
}

func (p *TFramedTransport) Read(buf []byte) (read int, err error) {
	defer func() {
		// Make sure we return the read buffer back to pool
		// after we finished reading from it.
		if p.readBuf != nil && p.readBuf.Len() == 0 {
			bufPool.put(&p.readBuf)
		}
	}()

	if p.readBuf != nil {

		read, err = p.readBuf.Read(buf)
		if err != io.EOF {
			return
		}

		// For bytes.Buffer.Read, EOF would only happen when read is zero,
		// but still, do a sanity check,
		// in case that behavior is changed in a future version of go stdlib.
		// When that happens, just return nil error,
		// and let the caller call Read again to read the next frame.
		if read > 0 {
			return read, nil
		}
	}

	// Reaching here means that the last Read finished the last frame,
	// so we need to read the next frame into readBuf now.
	if err = p.readFrame(); err != nil {
		return read, err
	}
	newRead, err := p.Read(buf[read:])
	return read + newRead, err
}

func (p *TFramedTransport) ReadByte() (c byte, err error) {
	buf := p.buffer[:1]
	_, err = p.Read(buf)
	if err != nil {
		return
	}
	c = buf[0]
	return
}

func (p *TFramedTransport) ensureWriteBufferBeforeWrite() {
	if p.writeBuf == nil {
		p.writeBuf = bufPool.get()
	}
}

func (p *TFramedTransport) Write(buf []byte) (int, error) {
	p.ensureWriteBufferBeforeWrite()
	n, err := p.writeBuf.Write(buf)
	return n, NewTTransportExceptionFromError(err)
}

func (p *TFramedTransport) WriteByte(c byte) error {
	p.ensureWriteBufferBeforeWrite()
	return p.writeBuf.WriteByte(c)
}

func (p *TFramedTransport) WriteString(s string) (n int, err error) {
	p.ensureWriteBufferBeforeWrite()
	return p.writeBuf.WriteString(s)
}

func (p *TFramedTransport) Flush(ctx context.Context) error {
	defer bufPool.put(&p.writeBuf)
	size := p.writeBuf.Len()
	buf := p.buffer[:4]
	binary.BigEndian.PutUint32(buf, uint32(size))
	_, err := p.transport.Write(buf)
	if err != nil {
		return NewTTransportExceptionFromError(err)
	}
	if size > 0 {
		if _, err := io.Copy(p.transport, p.writeBuf); err != nil {
			return NewTTransportExceptionFromError(err)
		}
	}
	err = p.transport.Flush(ctx)
	return NewTTransportExceptionFromError(err)
}

func (p *TFramedTransport) readFrame() error {
	if p.readBuf != nil {
		bufPool.put(&p.readBuf)
	}
	p.readBuf = bufPool.get()

	buf := p.buffer[:4]
	if _, err := io.ReadFull(p.reader, buf); err != nil {
		return err
	}
	size := binary.BigEndian.Uint32(buf)
	if size > uint32(p.cfg.GetMaxFrameSize()) {
		return NewTTransportException(UNKNOWN_TRANSPORT_EXCEPTION, fmt.Sprintf("Incorrect frame size (%d)", size))
	}
	_, err := io.CopyN(p.readBuf, p.reader, int64(size))
	return NewTTransportExceptionFromError(err)
}

func (p *TFramedTransport) RemainingBytes() (num_bytes uint64) {
	if p.readBuf == nil {
		return 0
	}
	return uint64(p.readBuf.Len())
}

// SetTConfiguration implements TConfigurationSetter.
func (p *TFramedTransport) SetTConfiguration(cfg *TConfiguration) {
	PropagateTConfiguration(p.transport, cfg)
	p.cfg = cfg
}

var (
	_ TConfigurationSetter = (*tFramedTransportFactory)(nil)
	_ TConfigurationSetter = (*TFramedTransport)(nil)
)