class Mongo::Socket::TCP

Wrapper for TCP sockets.

@since 2.0.0

Attributes

host[R]

@return [ String ] host The host to connect to.

port[R]

@return [ Integer ] port The port to connect to.

Public Class Methods

new(host, port, timeout, family, options = {}) click to toggle source

Initializes a new TCP socket.

@example Create the TCP socket.

TCP.new('::1', 27017, 30, Socket::PF_INET)
TCP.new('127.0.0.1', 27017, 30, Socket::PF_INET)

@param [ String ] host The hostname or IP address. @param [ Integer ] port The port number. @param [ Float ] timeout The socket timeout value. @param [ Integer ] family The socket family. @param [ Hash ] options The options.

@option options [ Float ] :connect_timeout Connect timeout.

@since 2.0.0

Calls superclass method Mongo::Socket::new
# File lib/mongo/socket/tcp.rb, line 64
def initialize(host, port, timeout, family, options = {})
  @host, @port, @timeout, @options = host, port, timeout, options
  super(family)
  connect!
end

Private Instance Methods

address() click to toggle source
# File lib/mongo/socket/tcp.rb, line 72
def address
  "#{host}:#{port} (no TLS)"
end
connect!() click to toggle source

Establishes a socket connection.

@example Connect the socket.

sock.connect!

@note This method mutates the object by setting the socket

internally.

@return [ TCP ] The connected socket instance.

@since 2.0.0

# File lib/mongo/socket/tcp.rb, line 40
def connect!
  Timeout.timeout(options[:connect_timeout], Error::SocketTimeoutError) do
    socket.setsockopt(IPPROTO_TCP, TCP_NODELAY, 1)
    handle_errors { socket.connect(::Socket.pack_sockaddr_in(port, host)) }
    self
  end
end