OpenSSL::Buffering

Module

OpenSSL IO buffering mix-in module.

This module allows an OpenSSL::SSL::SSLSocket to behave like an IO.

You typically won’t use this module directly, you can see it implemented in OpenSSL::SSL::SSLSocket.

Constants

BLOCK_SIZE

Default size to read from or write to the SSLSocket for buffer operations.

Attributes

sync

Read & Write

The “sync mode” of the SSLSocket.

See IO#sync for full details.

Class Methods

new(*)
::

Creates an instance of OpenSSL’s buffering IO module.

Instance Methods

<<(s)
#

Writes s to the stream. s will be converted to a String using .to_s method.

close
#

Closes the SSLSocket and flushes any unwritten data.

consume_rbuff(size=nil)
#

Consumes size bytes from the buffer

do_write(s)
#

Writes s to the buffer. When the buffer is full or sync is true the buffer is flushed to the underlying socket.

each(eol=$/) { |line| ... }
#

Executes the block for every line in the stream where lines are separated by eol.

See also gets

each_byte() { |byte| ... }
#

Calls the given block once for each byte in the stream.

each_line(eol=$/)
#
An alias for each

eof
#
An alias for eof?

eof?
#

Returns true if the stream is at file which means there is no more data to be read.

fill_rbuff
#

Fills the buffer from the underlying SSLSocket

flush
#

Flushes buffered data to the SSLSocket.

getc
#

Reads one character from the stream. Returns nil if called at end of file.

gets(eol=$/, limit=nil)
#

Reads the next “line” from the stream. Lines are separated by eol. If limit is provided the result will not be longer than the given number of bytes.

eol may be a String or Regexp.

Unlike IO#gets the line read will not be assigned to +$_+.

Unlike IO#gets the separator must be provided if a limit is provided.

print(*args)
#

Writes args to the stream.

See IO#print for full details.

printf(s, *args)
#

Formats and writes to the stream converting parameters under control of the format string.

See Kernel#sprintf for format string details.

puts(*args)
#

Writes args to the stream along with a record separator.

See IO#puts for full details.

read(size=nil, buf=nil)
#

Reads size bytes from the stream. If buf is provided it must reference a string which will receive the data.

See IO#read for full details.

read_nonblock(maxlen, buf=nil, exception: true)
#

Reads at most maxlen bytes in the non-blocking manner.

When no data can be read without blocking it raises OpenSSL::SSL::SSLError extended by IO::WaitReadable or IO::WaitWritable.

IO::WaitReadable means SSL needs to read internally so read_nonblock should be called again when the underlying IO is readable.

IO::WaitWritable means SSL needs to write internally so read_nonblock should be called again after the underlying IO is writable.

OpenSSL::Buffering#read_nonblock needs two rescue clause as follows:

# 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

Note that one reason that read_nonblock writes to the underlying IO is when the peer requests a new TLS/SSL handshake. See openssl the FAQ for more details. www.openssl.org/support/faq.html

By specifying a keyword argument exception to false, you can indicate that read_nonblock should not raise an IO::Wait*able exception, but return the symbol :wait_writable or :wait_readable instead. At EOF, it will return nil instead of raising EOFError.

readchar
#

Reads a one-character string from the stream. Raises an EOFError at end of file.

readline(eol=$/)
#

Reads a line from the stream which is separated by eol.

Raises EOFError if at end of file.

readlines(eol=$/)
#

Reads lines from the stream which are separated by eol.

See also gets

readpartial(maxlen, buf=nil)
#

Reads at most maxlen bytes from the stream. If buf is provided it must reference a string which will receive the data.

See IO#readpartial for full details.

ungetc(c)
#

Pushes character c back onto the stream such that a subsequent buffered character read will return it.

Unlike IO#getc multiple bytes may be pushed back onto the stream.

Has no effect on unbuffered reads (such as sysread).

write(*s)
#

Writes s to the stream. If the argument is not a String it will be converted using .to_s method. Returns the number of bytes written.

write_nonblock(s, exception: true)
#

Writes s in the non-blocking manner.

If there is buffered data, it is flushed first. This may block.

write_nonblock returns number of bytes written to the SSL connection.

When no data can be written without blocking it raises OpenSSL::SSL::SSLError extended by IO::WaitReadable or IO::WaitWritable.

IO::WaitReadable means SSL needs to read internally so write_nonblock should be called again after the underlying IO is readable.

IO::WaitWritable means SSL needs to write internally so write_nonblock should be called again after underlying IO is writable.

So OpenSSL::Buffering#write_nonblock needs two rescue clause as follows.

# 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

Note that one reason that write_nonblock reads from the underlying IO is when the peer requests a new TLS/SSL handshake. See the openssl FAQ for more details. www.openssl.org/support/faq.html

By specifying a keyword argument exception to false, you can indicate that write_nonblock should not raise an IO::Wait*able exception, but return the symbol :wait_writable or :wait_readable instead.