blob: ba2738a8df111f75e312b66d3a2d8e9bdf254e4d [file] [log] [blame]
Matteo Scandoloa4285862020-12-01 18:10:10 -08001/*
2 * Licensed to the Apache Software Foundation (ASF) under one
3 * or more contributor license agreements. See the NOTICE file
4 * distributed with this work for additional information
5 * regarding copyright ownership. The ASF licenses this file
6 * to you under the Apache License, Version 2.0 (the
7 * "License"); you may not use this file except in compliance
8 * with the License. You may obtain a copy of the License at
9 *
10 * http://www.apache.org/licenses/LICENSE-2.0
11 *
12 * Unless required by applicable law or agreed to in writing,
13 * software distributed under the License is distributed on an
14 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
15 * KIND, either express or implied. See the License for the
16 * specific language governing permissions and limitations
17 * under the License.
18 */
19
20package thrift
21
22import (
David K. Bainbridge06631892021-08-19 13:07:00 +000023 "context"
Matteo Scandoloa4285862020-12-01 18:10:10 -080024 "errors"
25 "io"
26)
27
28var errTransportInterrupted = errors.New("Transport Interrupted")
29
30type Flusher interface {
31 Flush() (err error)
32}
33
David K. Bainbridge06631892021-08-19 13:07:00 +000034type ContextFlusher interface {
35 Flush(ctx context.Context) (err error)
36}
37
Matteo Scandoloa4285862020-12-01 18:10:10 -080038type ReadSizeProvider interface {
39 RemainingBytes() (num_bytes uint64)
40}
41
Matteo Scandoloa4285862020-12-01 18:10:10 -080042// Encapsulates the I/O layer
43type TTransport interface {
44 io.ReadWriteCloser
David K. Bainbridge06631892021-08-19 13:07:00 +000045 ContextFlusher
Matteo Scandoloa4285862020-12-01 18:10:10 -080046 ReadSizeProvider
47
48 // Opens the transport for communication
49 Open() error
50
51 // Returns true if the transport is open
52 IsOpen() bool
53}
54
55type stringWriter interface {
56 WriteString(s string) (n int, err error)
57}
58
Matteo Scandoloa4285862020-12-01 18:10:10 -080059// This is "enchanced" transport with extra capabilities. You need to use one of these
60// to construct protocol.
61// Notably, TSocket does not implement this interface, and it is always a mistake to use
62// TSocket directly in protocol.
63type TRichTransport interface {
64 io.ReadWriter
65 io.ByteReader
66 io.ByteWriter
67 stringWriter
David K. Bainbridge06631892021-08-19 13:07:00 +000068 ContextFlusher
Matteo Scandoloa4285862020-12-01 18:10:10 -080069 ReadSizeProvider
70}