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.

timeout[R]

@return [ Float ] timeout The socket timeout.

Public Class Methods

new(host, port, timeout, family) 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.

@since 2.0.0

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

Public Instance Methods

connect!(connect_timeout = nil) 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 43
def connect!(connect_timeout = nil)
  Timeout.timeout(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
connectable?() click to toggle source

This object does not wrap another socket so it's always connectable.

@example Is the socket connectable?

socket.connectable?

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

@since 2.2.5

# File lib/mongo/socket/tcp.rb, line 76
def connectable?
  true
end