class Mongo::Socket::TCP
Wrapper for TCP sockets.
@since 2.0.0
Attributes
@return [ String ] host The host to connect to.
@return [ Integer ] port The port to connect to.
@return [ Float ] timeout The connection timeout.
Public Class Methods
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
# 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
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! Timeout.timeout(timeout, Error::SocketTimeoutError) do socket.setsockopt(IPPROTO_TCP, TCP_NODELAY, 1) handle_errors { socket.connect(::Socket.pack_sockaddr_in(port, host)) } self end end
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