blob: 453899651fc21af73421b6d2f6c8b3654e2426c8 [file] [log] [blame]
Girish Kumar182049b2020-07-08 18:53:34 +00001/*
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 (
23 "errors"
24 "io"
25)
26
27var errTransportInterrupted = errors.New("Transport Interrupted")
28
29type Flusher interface {
30 Flush() (err error)
31}
32
33type ReadSizeProvider interface {
34 RemainingBytes() (num_bytes uint64)
35}
36
37
38// Encapsulates the I/O layer
39type TTransport interface {
40 io.ReadWriteCloser
41 Flusher
42 ReadSizeProvider
43
44 // Opens the transport for communication
45 Open() error
46
47 // Returns true if the transport is open
48 IsOpen() bool
49}
50
51type stringWriter interface {
52 WriteString(s string) (n int, err error)
53}
54
55
56// This is "enchanced" transport with extra capabilities. You need to use one of these
57// to construct protocol.
58// Notably, TSocket does not implement this interface, and it is always a mistake to use
59// TSocket directly in protocol.
60type TRichTransport interface {
61 io.ReadWriter
62 io.ByteReader
63 io.ByteWriter
64 stringWriter
65 Flusher
66 ReadSizeProvider
67}
68