модуль OpenSSL::Buffering

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

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

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

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

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

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

См. также gets

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

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

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

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

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

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

# File ext/openssl/lib/openssl/buffering.rb, line 108
def getbyte
  byte = read(1)
  byte && byte.unpack1("C")
end

Получает следующий 8-битный байт из ‘ssl`. Возвращает `nil` при EOF.

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

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

# File ext/openssl/lib/openssl/buffering.rb, line 235
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 может быть String или Regexp.

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

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

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

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

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

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

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

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

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

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

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

# File ext/openssl/lib/openssl/buffering.rb, line 119
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 204
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 является записываемым.

OpenSSL::Buffering#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, заключается в том, что узел запрашивает новый TLS/SSL обмен ключами. Для получения дополнительной информации см. часто задаваемые вопросы OpenSSL. www.openssl.org/support/faq.html

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

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

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

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

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

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

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

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

См. также gets

# File ext/openssl/lib/openssl/buffering.rb, line 146
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 323
def ungetc(c)
  @rbuffer[0,0] = c.chr
end

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

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

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

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

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

# File ext/openssl/lib/openssl/buffering.rb, line 413
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 станет записываемым.

Поэтому OpenSSL::Buffering#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 handshake. Дополнительные сведения см. в FAQ по OpenSSL. www.openssl.org/support/faq.html

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