модуль OpenSSL::Buffering

# File ext/openssl/lib/openssl/buffering.rb, line 393
def <<(s)
  do_write(s)
  self
end

Записывает s в поток. s будет преобразован в строку с помощью метода .to_s.

# File ext/openssl/lib/openssl/buffering.rb, line 456
def close
  flush rescue nil
  sysclose
end

Закрывает SSLSocket и очищает все не записанные данные.

# File ext/openssl/lib/openssl/buffering.rb, line 225
def each(eol=$/)
  while line = self.gets(eol)
    yield line
  end
end

Выполняет блок для каждой строки в потоке, где строки разделены eol.

См. также gets

# File ext/openssl/lib/openssl/buffering.rb, line 266
def each_byte # :yields: byte
  while c = getc
    yield(c.ord)
  end
end

Вызывает данный блок один раз для каждого байта в потоке.

# File ext/openssl/lib/openssl/buffering.rb, line 297
def eof?
  fill_rbuff if !@eof && @rbuffer.empty?
  @eof && @rbuffer.empty?
end

Возвращает true, если поток находится в конце файла, что означает, что больше нет данных для чтения.

# File ext/openssl/lib/openssl/buffering.rb, line 444
def flush
  osync = @sync
  @sync = true
  do_write ""
  return self
ensure
  @sync = osync
end

Очищает буферизованные данные в SSLSocket.

# File ext/openssl/lib/openssl/buffering.rb, line 259
def getc
  read(1)
end

Читает один символ из потока. Возвращает nil, если вызов сделан в конце файла.

# File ext/openssl/lib/openssl/buffering.rb, line 201
def gets(eol=$/, limit=nil)
  idx = @rbuffer.index(eol)
  until @eof
    break if idx
    fill_rbuff
    idx = @rbuffer.index(eol)
  end
  if eol.is_a?(Regexp)
    size = idx ? idx+$&.size : nil
  else
    size = idx ? idx+eol.size : nil
  end
  if size && limit && limit >= 0
    size = [size, limit].min
  end
  consume_rbuff(size)
end

Читает следующую «строку» из потока. Строки разделены eol. Если указано limit, результат не будет длиннее указанного количества байтов.

eol может быть строкой или Regexp.

В отличие от IO#gets, считанная строка не будет назначена +$_+.

В отличие от IO#gets, разделитель должен быть указан, если задан предел.

# File ext/openssl/lib/openssl/buffering.rb, line 423
def print(*args)
  s = ""
  args.each{ |arg| s << arg.to_s }
  do_write(s)
  nil
end

Записывает args в поток.

См. IO#print для подробностей.

# File ext/openssl/lib/openssl/buffering.rb, line 436
def printf(s, *args)
  do_write(s % args)
  nil
end

Форматирует и записывает в поток, преобразуя параметры в соответствии со строкой формата.

См. Kernel#sprintf для подробностей о строке формата.

# File ext/openssl/lib/openssl/buffering.rb, line 403
def puts(*args)
  s = ""
  if args.empty?
    s << "\n"
  end
  args.each{|arg|
    s << arg.to_s
    if $/ && /\n\z/ !~ s
      s << "\n"
    end
  }
  do_write(s)
  nil
end

Записывает args в поток вместе с разделителем записей.

См. IO#puts для подробностей.

# File ext/openssl/lib/openssl/buffering.rb, line 85
def read(size=nil, buf=nil)
  if size == 0
    if buf
      buf.clear
      return buf
    else
      return ""
    end
  end
  until @eof
    break if size && size <= @rbuffer.size
    fill_rbuff
  end
  ret = consume_rbuff(size) || ""
  if buf
    buf.replace(ret)
    ret = buf
  end
  (size && ret.empty?) ? nil : ret
end

Читает size байт из потока. Если buf указан, он должен ссылаться на строку, которая получит данные.

См. IO#read для подробностей.

# File ext/openssl/lib/openssl/buffering.rb, line 170
def read_nonblock(maxlen, buf=nil, exception: true)
  if maxlen == 0
    if buf
      buf.clear
      return buf
    else
      return ""
    end
  end
  if @rbuffer.empty?
    return sysread_nonblock(maxlen, buf, exception: exception)
  end
  ret = consume_rbuff(maxlen)
  if buf
    buf.replace(ret)
    ret = buf
  end
  ret
end

Читает не более maxlen байт в режиме без блокировки.

Когда данные нельзя прочитать без блокировки, генерируется OpenSSL::SSL::SSLError, дополненный IO::WaitReadable или IO::WaitWritable.

IO::WaitReadable означает, что SSL должен прочитать данные внутри, поэтому #read_nonblock следует вызывать снова, когда базовый IO доступен для чтения.

IO::WaitWritable означает, что SSL должен записать данные внутри, поэтому #read_nonblock следует вызывать снова после того, как базовый IO доступен для записи.

#read_nonblock нуждается в двух операторах обработки исключений следующим образом:

# emulates blocking read (readpartial).
begin
  result = ssl.read_nonblock(maxlen)
rescue IO::WaitReadable
  IO.select([io])
  retry
rescue IO::WaitWritable
  IO.select(nil, [io])
  retry
end

Обратите внимание, что одна из причин, по которой #read_nonblock записывает в базовый IO, заключается в том, что peer запрашивает новый TLS/SSL handshake. Подробнее см. раздел FAQ по openssl. www.openssl.org/support/faq.html

Указав ключевой аргумент exception в #read_nonblock, вы можете указать, что #read_nonblock не должен генерировать исключение IO::Wait*able, а вместо этого возвращать символ :wait_writable или :wait_readable. В конце файла он будет возвращать nil вместо генерации EOFError.

# File ext/openssl/lib/openssl/buffering.rb, line 276
def readchar
  raise EOFError if eof?
  getc
end

Читает строку из одного символа из потока. Генерирует EOFError в конце файла.

# File ext/openssl/lib/openssl/buffering.rb, line 250
def readline(eol=$/)
  raise EOFError if eof?
  gets(eol)
end

Читает строку из потока, разделенную eol.

Генерирует EOFError, если достигнут конец файла.

# File ext/openssl/lib/openssl/buffering.rb, line 237
def readlines(eol=$/)
  ary = []
  while line = self.gets(eol)
    ary << line
  end
  ary
end

Читает строки из потока, разделенные eol.

См. также gets

# File ext/openssl/lib/openssl/buffering.rb, line 112
def readpartial(maxlen, buf=nil)
  if maxlen == 0
    if buf
      buf.clear
      return buf
    else
      return ""
    end
  end
  if @rbuffer.empty?
    begin
      return sysread(maxlen, buf)
    rescue Errno::EAGAIN
      retry
    end
  end
  ret = consume_rbuff(maxlen)
  if buf
    buf.replace(ret)
    ret = buf
  end
  ret
end

Читает не более maxlen байт из потока. Если buf указан, он должен ссылаться на строку, которая получит данные.

См. IO#readpartial для подробностей.

# File ext/openssl/lib/openssl/buffering.rb, line 289
def ungetc(c)
  @rbuffer[0,0] = c.chr
end

Возвращает символ c обратно в поток, так что последующее чтение буферизованного символа вернёт его.

В отличие от IO#getc, несколько байт могут быть возвращены обратно в поток.

Не оказывает никакого влияния на чтение без буферизации (например, sysread).

# File ext/openssl/lib/openssl/buffering.rb, line 340
def write(*s)
  s.inject(0) do |written, str|
    do_write(str)
    written + str.bytesize
  end
end

Записывает s в поток. Если аргумент не является строкой, он будет преобразован с помощью метода .to_s. Возвращает количество записанных байтов.

# File ext/openssl/lib/openssl/buffering.rb, line 384
def write_nonblock(s, exception: true)
  flush
  syswrite_nonblock(s, exception: exception)
end

Записывает s в неблокирующем режиме.

Если есть буферизованные данные, они сначала сбрасываются. Это может заблокировать выполнение.

#write_nonblock возвращает количество байтов, записанных в соединение SSL.

Если данные не могут быть записаны без блокировки, возникает исключение OpenSSL::SSL::SSLError дополненное IO::WaitReadable или IO::WaitWritable.

IO::WaitReadable означает, что SSL нуждается во внутренней операции чтения, поэтому #write_nonblock следует вызвать повторно после того, как объект IO станет доступным для чтения.

IO::WaitWritable означает, что SSL нуждается во внутренней операции записи, поэтому #write_nonblock следует вызвать повторно после того, как объект IO станет доступным для записи.

Поэтому #write_nonblock требует двух блоков обработки исключений в следующем виде.

# emulates blocking write.
begin
  result = ssl.write_nonblock(str)
rescue IO::WaitReadable
  IO.select([io])
  retry
rescue IO::WaitWritable
  IO.select(nil, [io])
  retry
end

Обратите внимание, что одной из причин, по которым #write_nonblock читает данные из базового объекта IO, является запрос со стороны удалённого узла на новый обмен данными TLS/SSL. Дополнительные сведения см. в FAQ OpenSSL. www.openssl.org/support/faq.html

Указав ключевое слово exception в false, вы можете указать, что #write_nonblock не должен генерировать исключения IO::Wait*able, а вместо этого должен возвращать символ :wait_writable или :wait_readable.