class Mongo::Socket

Provides additional data around sockets for the driver's use.

@since 2.0.0

Constants

DEFAULT_TCP_KEEPCNT
DEFAULT_TCP_KEEPIDLE
DEFAULT_TCP_KEEPINTVL
SSL_ERROR

Error message for SSL related exceptions.

@since 2.0.0

TIMEOUT_ERROR

Error message for timeouts on socket calls.

@since 2.0.0 @deprecated

TIMEOUT_PACK

The pack directive for timeouts.

@since 2.0.0

Attributes

family[R]

@return [ Integer ] family The type of host family.

options[R]

@return [ Hash ] The options.

socket[R]

@return [ Socket ] socket The wrapped socket.

timeout[R]

@return [ Float ] timeout The socket timeout.

Public Class Methods

new(family) click to toggle source

Create the new socket for the provided family - ipv4, piv6, or unix.

@example Create a new ipv4 socket.

Socket.new(Socket::PF_INET)

@param [ Integer ] family The socket domain.

@since 2.0.0

# File lib/mongo/socket.rb, line 107
def initialize(family)
  @family = family
  @socket = ::Socket.new(family, SOCK_STREAM, 0)
  set_socket_options(@socket)
end

Public Instance Methods

alive?() click to toggle source

Is the socket connection alive?

@example Is the socket alive?

socket.alive?

@return [ true, false ] If the socket is alive.

@deprecated Use connectable? on the connection instead.

# File lib/mongo/socket.rb, line 63
def alive?
  sock_arr = [ @socket ]
  if Kernel::select(sock_arr, nil, sock_arr, 0)
    eof?
  else
    true
  end
end
close() click to toggle source

Close the socket.

@example Close the socket.

socket.close

@return [ true ] Always true.

@since 2.0.0

# File lib/mongo/socket.rb, line 80
def close
  @socket.close rescue true
  true
end
connectable?() click to toggle source

For backwards compatibilty only, do not use.

@return [ true ] Always true.

@deprecated

# File lib/mongo/socket.rb, line 183
def connectable?
  true
end
eof?() click to toggle source

Tests if this socket has reached EOF. Primarily used for liveness checks.

@since 2.0.5

# File lib/mongo/socket.rb, line 172
def eof?
  @socket.eof?
rescue IOError, SystemCallError
  true
end
gets(*args) click to toggle source

Delegates gets to the underlying socket.

@example Get the next line.

socket.gets(10)

@param [ Array<Object> ] args The arguments to pass through.

@return [ Object ] The returned bytes.

@since 2.0.0

# File lib/mongo/socket.rb, line 95
def gets(*args)
  handle_errors { @socket.gets(*args) }
end
read(length) click to toggle source

Will read all data from the socket for the provided number of bytes. If no data is returned, an exception will be raised.

@example Read all the requested data from the socket.

socket.read(4096)

@param [ Integer ] length The number of bytes to read.

@raise [ Mongo::SocketError ] If not all data is returned.

@return [ Object ] The data from the socket.

@since 2.0.0

# File lib/mongo/socket.rb, line 126
def read(length)
  handle_errors do
    data = read_from_socket(length)
    unless (data.length > 0 || length == 0)
      raise IOError, "Expected to read > 0 bytes but read 0 bytes"
    end
    while data.length < length
      chunk = read_from_socket(length - data.length)
      unless (chunk.length > 0 || length == 0)
        raise IOError, "Expected to read > 0 bytes but read 0 bytes"
      end
      data << chunk
    end
    data
  end
end
readbyte() click to toggle source

Read a single byte from the socket.

@example Read a single byte.

socket.readbyte

@return [ Object ] The read byte.

@since 2.0.0

# File lib/mongo/socket.rb, line 151
def readbyte
  handle_errors { @socket.readbyte }
end
write(*args) click to toggle source

Writes data to the socket instance.

@example Write to the socket.

socket.write(data)

@param [ Array<Object> ] args The data to be written.

@return [ Integer ] The length of bytes written to the socket.

@since 2.0.0

# File lib/mongo/socket.rb, line 165
def write(*args)
  handle_errors { @socket.write(*args) }
end

Private Instance Methods

address() click to toggle source
# File lib/mongo/socket.rb, line 325
def address
  raise NotImplementedError
end
allocate_string(capacity) click to toggle source
# File lib/mongo/socket.rb, line 267
def allocate_string(capacity)
  if RUBY_VERSION >= '2.4.0'
    String.new('', :capacity => capacity, :encoding => 'BINARY')
  else
    ('x'*capacity).force_encoding('BINARY')
  end
end
handle_errors() { || ... } click to toggle source
# File lib/mongo/socket.rb, line 313
def handle_errors
  begin
    yield
  rescue Errno::ETIMEDOUT => e
    raise Error::SocketTimeoutError, "#{e.class}: #{e} (for #{address})"
  rescue IOError, SystemCallError => e
    raise Error::SocketError, "#{e.class}: #{e} (for #{address})"
  rescue OpenSSL::SSL::SSLError => e
    raise Error::SocketError, "#{e.class}: #{e} (for #{address}) (#{SSL_ERROR})"
  end
end
read_buffer_size() click to toggle source
# File lib/mongo/socket.rb, line 275
def read_buffer_size
  # Buffer size for non-SSL reads
  # 64kb
  65536
end
read_from_socket(length) click to toggle source
# File lib/mongo/socket.rb, line 189
def read_from_socket(length)
  # Just in case
  if length == 0
    return ''.force_encoding('BINARY')
  end

  if _timeout = self.timeout
    deadline = Time.now + _timeout
  end

  # We want to have a fixed and reasonably small size buffer for reads
  # because, for example, OpenSSL reads in 16 kb chunks max.
  # Having a 16 mb buffer means there will be 1000 reads each allocating
  # 16 mb of memory and using 16 kb of it.
  buf_size = read_buffer_size
  data = nil

  # If we want to read less than the buffer size, just allocate the
  # memory that is necessary
  if length < buf_size
    buf_size = length
  end

  # The binary encoding is important, otherwise Ruby performs encoding
  # conversions of some sort during the write into the buffer which
  # kills performance
  buf = allocate_string(buf_size)
  retrieved = 0
  begin
    while retrieved < length
      retrieve = length - retrieved
      if retrieve > buf_size
        retrieve = buf_size
      end
      chunk = @socket.read_nonblock(retrieve, buf)

      # If we read the entire wanted length in one operation,
      # return the data as is which saves one memory allocation and
      # one copy per read
      if retrieved == 0 && chunk.length == length
        return chunk
      end

      # If we are here, we are reading the wanted length in
      # multiple operations. Allocate the total buffer here rather
      # than up front so that the special case above won't be
      # allocating twice
      if data.nil?
        data = allocate_string(length)
      end

      # ... and we need to copy the chunks at this point
      data[retrieved, chunk.length] = chunk
      retrieved += chunk.length
    end
  # As explained in https://ruby-doc.com/core-trunk/IO.html#method-c-select,
  # reading from a TLS socket may require writing which may raise WaitWritable
  rescue IO::WaitReadable, IO::WaitWritable => exc
    if deadline
      select_timeout = deadline - Time.now
      if select_timeout <= 0
        raise Errno::ETIMEDOUT, "Took more than #{_timeout} seconds to receive data"
      end
    end
    if exc.is_a?(IO::WaitReadable)
      select_args = [[@socket], nil, [@socket], select_timeout]
    else
      select_args = [nil, [@socket], [@socket], select_timeout]
    end
    unless Kernel::select(*select_args)
      raise Errno::ETIMEDOUT, "Took more than #{_timeout} seconds to receive data"
    end
    retry
  end

  data
end
set_keepalive_opts(sock) click to toggle source
# File lib/mongo/socket.rb, line 291
def set_keepalive_opts(sock)
  sock.setsockopt(SOL_SOCKET, SO_KEEPALIVE, true)
  set_option(sock, :TCP_KEEPINTVL, DEFAULT_TCP_KEEPINTVL)
  set_option(sock, :TCP_KEEPCNT, DEFAULT_TCP_KEEPCNT)
  set_option(sock, :TCP_KEEPIDLE, DEFAULT_TCP_KEEPIDLE)
rescue
end
set_option(sock, option, default) click to toggle source
# File lib/mongo/socket.rb, line 299
def set_option(sock, option, default)
  if Socket.const_defined?(option)
    system_default = sock.getsockopt(IPPROTO_TCP, option).int
    if system_default > default
      sock.setsockopt(IPPROTO_TCP, option, default)
    end
  end
end
set_socket_options(sock) click to toggle source
# File lib/mongo/socket.rb, line 308
def set_socket_options(sock)
  sock.set_encoding(BSON::BINARY)
  set_keepalive_opts(sock)
end
unix_socket?(sock) click to toggle source
# File lib/mongo/socket.rb, line 281
def unix_socket?(sock)
  defined?(UNIXSocket) && sock.is_a?(UNIXSocket)
end