Class Mongo::Address::Unix
In: lib/mongo/address/unix.rb
Parent: Object

Sets up socket addresses.

@since 2.0.0

Methods

new   parse   socket  

Constants

MATCH = Regexp.new('\.sock').freeze   The regular expression to use to match a socket path.

@since 2.0.0

Attributes

host  [R]  @return [ String ] host The host.
port  [R]  @return [ nil ] port Will always be nil.

Public Class methods

new(host, port=nil, host_name=nil)

Initialize the socket resolver.

@example Initialize the resolver. 

  Unix.new("/path/to/socket.sock", "/path/to/socket.sock")

@param [ String ] host The host.

@since 2.0.0

parse(address)

Parse a socket path.

@example Parse the address. 

  Unix.parse("/path/to/socket.sock")

@param [ String ] address The address to parse.

@return [ Array<String> ] A list with the host (socket path).

@since 2.0.0

Public Instance methods

socket(socket_timeout, ssl_options = {}, options = {})

Get a socket for the provided address type, given the options.

@example Get a Unix socket. 

  address.socket(5)

@param [ Float ] socket_timeout The socket timeout. @param [ Hash ] ssl_options SSL options - ignored. @param [ Hash ] options The options.

@option options [ Float ] :connect_timeout Connect timeout.

@return [ Mongo::Socket::Unix ] The socket.

@since 2.0.0

[Validate]