summaryrefslogtreecommitdiff
path: root/vendor/packaged/thrift/src/Transport/TBufferedTransport.php
blob: 253c5acfb47cd52390f0455b529fe578ac8e44c1 (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
<?php
/*
 * 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.transport
 */

namespace Thrift\Transport;

use Thrift\Exception\TTransportException;
use Thrift\Factory\TStringFuncFactory;

/**
 * Buffered transport. Stores data to an internal buffer that it doesn't
 * actually write out until flush is called. For reading, we do a greedy
 * read and then serve data out of the internal buffer.
 *
 * @package thrift.transport
 */
class TBufferedTransport extends TTransport
{
    /**
     * The underlying transport
     *
     * @var TTransport
     */
    protected $transport_;

    /**
     * The receive buffer size
     *
     * @var int
     */
    protected $rBufSize_ = 512;

    /**
     * The write buffer size
     *
     * @var int
     */
    protected $wBufSize_ = 512;

    /**
     * The write buffer.
     *
     * @var string
     */
    protected $wBuf_ = '';

    /**
     * The read buffer.
     *
     * @var string
     */
    protected $rBuf_ = '';

    /**
     * Constructor. Creates a buffered transport around an underlying transport
     */
    public function __construct($transport, $rBufSize = 512, $wBufSize = 512)
    {
        $this->transport_ = $transport;
        $this->rBufSize_ = $rBufSize;
        $this->wBufSize_ = $wBufSize;
    }

    public function isOpen()
    {
        return $this->transport_->isOpen();
    }

    /**
     * @inheritdoc
     *
     * @throws TTransportException
     */
    public function open()
    {
        $this->transport_->open();
    }

    public function close()
    {
        $this->transport_->close();
    }

    public function putBack($data)
    {
        if (TStringFuncFactory::create()->strlen($this->rBuf_) === 0) {
            $this->rBuf_ = $data;
        } else {
            $this->rBuf_ = ($data . $this->rBuf_);
        }
    }

    /**
     * The reason that we customize readAll here is that the majority of PHP
     * streams are already internally buffered by PHP. The socket stream, for
     * example, buffers internally and blocks if you call read with $len greater
     * than the amount of data available, unlike recv() in C.
     *
     * Therefore, use the readAll method of the wrapped transport inside
     * the buffered readAll.
     *
     * @throws TTransportException
     */
    public function readAll($len)
    {
        $have = TStringFuncFactory::create()->strlen($this->rBuf_);
        if ($have == 0) {
            $data = $this->transport_->readAll($len);
        } elseif ($have < $len) {
            $data = $this->rBuf_;
            $this->rBuf_ = '';
            $data .= $this->transport_->readAll($len - $have);
        } elseif ($have == $len) {
            $data = $this->rBuf_;
            $this->rBuf_ = '';
        } elseif ($have > $len) {
            $data = TStringFuncFactory::create()->substr($this->rBuf_, 0, $len);
            $this->rBuf_ = TStringFuncFactory::create()->substr($this->rBuf_, $len);
        }

        return $data;
    }

    /**
     * @inheritdoc
     *
     * @param int $len
     * @return string
     * @throws TTransportException
     */
    public function read($len)
    {
        if (TStringFuncFactory::create()->strlen($this->rBuf_) === 0) {
            $this->rBuf_ = $this->transport_->read($this->rBufSize_);
        }

        if (TStringFuncFactory::create()->strlen($this->rBuf_) <= $len) {
            $ret = $this->rBuf_;
            $this->rBuf_ = '';

            return $ret;
        }

        $ret = TStringFuncFactory::create()->substr($this->rBuf_, 0, $len);
        $this->rBuf_ = TStringFuncFactory::create()->substr($this->rBuf_, $len);

        return $ret;
    }

    /**
     * @inheritdoc
     *
     * @param string $buf
     * @throws TTransportException
     */
    public function write($buf)
    {
        $this->wBuf_ .= $buf;
        if (TStringFuncFactory::create()->strlen($this->wBuf_) >= $this->wBufSize_) {
            $out = $this->wBuf_;

            // Note that we clear the internal wBuf_ prior to the underlying write
            // to ensure we're in a sane state (i.e. internal buffer cleaned)
            // if the underlying write throws up an exception
            $this->wBuf_ = '';
            $this->transport_->write($out);
        }
    }

    /**
     * @inheritdoc
     *
     * @throws TTransportException
     */
    public function flush()
    {
        if (TStringFuncFactory::create()->strlen($this->wBuf_) > 0) {
            $out = $this->wBuf_;

            // Note that we clear the internal wBuf_ prior to the underlying write
            // to ensure we're in a sane state (i.e. internal buffer cleaned)
            // if the underlying write throws up an exception
            $this->wBuf_ = '';
            $this->transport_->write($out);
        }
        $this->transport_->flush();
    }
}