File: buffered_io.rb

package info (click to toggle)
ruby-redis-client 0.26.1-1
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid
  • size: 200 kB
  • sloc: ruby: 2,177; makefile: 4
file content (242 lines) | stat: -rw-r--r-- 6,838 bytes parent folder | download | duplicates (2)
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
# frozen_string_literal: true

require "io/wait" unless IO.method_defined?(:wait_readable) && IO.method_defined?(:wait_writable)

class RedisClient
  class RubyConnection
    class BufferedIO
      EOL = "\r\n".b.freeze
      EOL_SIZE = EOL.bytesize

      attr_accessor :read_timeout, :write_timeout

      if String.method_defined?(:byteindex) # Ruby 3.2+
        ENCODING = Encoding::UTF_8

        def initialize(io, read_timeout:, write_timeout:, chunk_size: 4096)
          @io = io
          @buffer = +""
          @offset = 0
          @chunk_size = chunk_size
          @read_timeout = read_timeout
          @write_timeout = write_timeout
          @blocking_reads = false
        end

        def gets_chomp
          fill_buffer(false) if @offset >= @buffer.bytesize
          until eol_index = @buffer.byteindex(EOL, @offset)
            fill_buffer(false)
          end

          line = @buffer.byteslice(@offset, eol_index - @offset)
          @offset = eol_index + EOL_SIZE
          line
        end

        def read_chomp(bytes)
          ensure_remaining(bytes + EOL_SIZE)
          str = @buffer.byteslice(@offset, bytes)
          @offset += bytes + EOL_SIZE
          str
        end

        private def ensure_line
          fill_buffer(false) if @offset >= @buffer.bytesize
          until @buffer.byteindex(EOL, @offset)
            fill_buffer(false)
          end
        end
      else
        ENCODING = Encoding::BINARY

        def initialize(io, read_timeout:, write_timeout:, chunk_size: 4096)
          @io = io
          @buffer = "".b
          @offset = 0
          @chunk_size = chunk_size
          @read_timeout = read_timeout
          @write_timeout = write_timeout
          @blocking_reads = false
        end

        def gets_chomp
          fill_buffer(false) if @offset >= @buffer.bytesize
          until eol_index = @buffer.index(EOL, @offset)
            fill_buffer(false)
          end

          line = @buffer.byteslice(@offset, eol_index - @offset)
          @offset = eol_index + EOL_SIZE
          line
        end

        def read_chomp(bytes)
          ensure_remaining(bytes + EOL_SIZE)
          str = @buffer.byteslice(@offset, bytes)
          @offset += bytes + EOL_SIZE
          str.force_encoding(Encoding::UTF_8)
        end

        private def ensure_line
          fill_buffer(false) if @offset >= @buffer.bytesize
          until @buffer.index(EOL, @offset)
            fill_buffer(false)
          end
        end
      end

      def close
        @io.to_io.close
      end

      def closed?
        @io.to_io.closed?
      end

      def eof?
        @offset >= @buffer.bytesize && @io.eof?
      end

      def with_timeout(new_timeout)
        new_timeout = false if new_timeout == 0

        previous_read_timeout = @read_timeout
        previous_blocking_reads = @blocking_reads

        if new_timeout
          @read_timeout = new_timeout
        else
          @blocking_reads = true
        end

        begin
          yield
        ensure
          @read_timeout = previous_read_timeout
          @blocking_reads = previous_blocking_reads
        end
      end

      def skip(offset)
        ensure_remaining(offset)
        @offset += offset
        nil
      end

      def write(string)
        total = remaining = string.bytesize
        loop do
          case bytes_written = @io.write_nonblock(string, exception: false)
          when Integer
            remaining -= bytes_written
            if remaining > 0
              string = string.byteslice(bytes_written..-1)
            else
              return total
            end
          when :wait_readable
            @io.to_io.wait_readable(@read_timeout) or raise(ReadTimeoutError, "Waited #{@read_timeout} seconds")
          when :wait_writable
            @io.to_io.wait_writable(@write_timeout) or raise(WriteTimeoutError, "Waited #{@write_timeout} seconds")
          when nil
            raise Errno::ECONNRESET
          else
            raise "Unexpected `write_nonblock` return: #{bytes.inspect}"
          end
        end
      end

      def getbyte
        unless byte = @buffer.getbyte(@offset)
          ensure_remaining(1)
          byte = @buffer.getbyte(@offset)
        end
        @offset += 1
        byte
      end

      def gets_integer
        int = 0
        offset = @offset
        while true
          chr = @buffer.getbyte(offset)

          if chr
            if chr == 13 # "\r".ord
              @offset = offset + 2
              break
            else
              int = (int * 10) + chr - 48
            end
            offset += 1
          else
            ensure_line
            return gets_integer
          end
        end

        int
      end

      private

      def ensure_remaining(bytes)
        needed = bytes - (@buffer.bytesize - @offset)
        if needed > 0
          fill_buffer(true, needed)
        end
      end

      def fill_buffer(strict, size = @chunk_size)
        remaining = size
        buffer_size = @buffer.bytesize
        start = @offset - buffer_size
        empty_buffer = start >= 0

        loop do
          bytes = if empty_buffer
            @io.read_nonblock([remaining, @chunk_size].max, @buffer, exception: false)
          else
            @io.read_nonblock([remaining, @chunk_size].max, exception: false)
          end

          case bytes
          when :wait_readable
            # Ref: https://github.com/redis-rb/redis-client/issues/190
            # SSLSocket always clear the provided buffer, even when it didn't
            # read anything. So we need to reset the offset accordingly.
            if empty_buffer && @buffer.empty?
              @offset -= buffer_size
            end

            unless @io.to_io.wait_readable(@read_timeout)
              raise ReadTimeoutError, "Waited #{@read_timeout} seconds" unless @blocking_reads
            end
          when :wait_writable
            # Ref: https://github.com/redis-rb/redis-client/issues/190
            # SSLSocket always clear the provided buffer, even when it didn't
            # read anything. So we need to reset the offset accordingly.
            if empty_buffer && @buffer.empty?
              @offset -= buffer_size
            end

            @io.to_io.wait_writable(@write_timeout) or raise(WriteTimeoutError, "Waited #{@write_timeout} seconds")
          when nil
            raise EOFError
          else
            if empty_buffer
              @offset = start
              empty_buffer = false
              @buffer.force_encoding(ENCODING) unless @buffer.encoding == ENCODING
            else
              @buffer << bytes.force_encoding(ENCODING)
            end
            remaining -= bytes.bytesize
            return if !strict || remaining <= 0
          end
        end
      end
    end
  end
end