class Mongo::Address::IPv4
Sets up resolution with IPv4
support if the address is an ip address.
@since 2.0.0
Constants
- MATCH
The regular expression to use to match an
IPv4
ip address.@since 2.0.0
- SPLIT
Split value constant.
@since 2.1.0
Attributes
@return [ String ] host The host.
@return [ String ] host_name
The original host name.
@return [ Integer ] port The port.
Public Class Methods
Initialize the IPv4
resolver.
@example Initialize the resolver.
IPv4.new("127.0.0.1", 27017, 'localhost')
@param [ String ] host The host. @param [ Integer ] port The port.
@since 2.0.0
# File lib/mongo/address/ipv4.rb, line 72 def initialize(host, port, host_name=nil) @host = host @port = port @host_name = host_name end
Parse an IPv4
address into its host and port.
@example Parse the address.
IPv4.parse("127.0.0.1:28011")
@param [ String ] address The address to parse.
@return [ Array<String, Integer> ] The host and port pair.
@since 2.0.0
# File lib/mongo/address/ipv4.rb, line 56 def self.parse(address) parts = address.split(SPLIT) host = parts[0] port = (parts[1] || 27017).to_i [ host, port ] end
Public Instance Methods
Get a socket for the provided address type, given the options.
@example Get an IPv4
socket.
ipv4.socket(5, :ssl => true)
@param [ Float ] socket_timeout The socket timeout. @param [ Hash ] options The options.
@option options [ Float ] :connect_timeout Connect timeout. @option options [ true | false ] :ssl Whether to use TLS. @option options [ String ] :ssl_ca_cert
Same as the corresponding Client/Socket::SSL option.
@option options [ Array<OpenSSL::X509::Certificate> ] :ssl_ca_cert_object
Same as the corresponding Client/Socket::SSL option.
@option options [ String ] :ssl_ca_cert_string
Same as the corresponding Client/Socket::SSL option.
@option options [ String ] :ssl_cert
Same as the corresponding Client/Socket::SSL option.
@option options [ OpenSSL::X509::Certificate ] :ssl_cert_object
Same as the corresponding Client/Socket::SSL option.
@option options [ String ] :ssl_cert_string
Same as the corresponding Client/Socket::SSL option.
@option options [ String ] :ssl_key
Same as the corresponding Client/Socket::SSL option.
@option options [ OpenSSL::PKey ] :ssl_key_object
Same as the corresponding Client/Socket::SSL option.
@option options [ String ] :ssl_key_pass_phrase
Same as the corresponding Client/Socket::SSL option.
@option options [ String ] :ssl_key_string
Same as the corresponding Client/Socket::SSL option.
@option options [ true, false ] :ssl_verify
Same as the corresponding Client/Socket::SSL option.
@option options [ true, false ] :ssl_verify_certificate
Same as the corresponding Client/Socket::SSL option.
@option options [ true, false ] :ssl_verify_hostname
Same as the corresponding Client/Socket::SSL option.
@return [ Mongo::Socket::SSL
, Mongo::Socket::TCP
] The socket.
@since 2.0.0 @api private
# File lib/mongo/address/ipv4.rb, line 119 def socket(socket_timeout, options = {}) if options[:ssl] Socket::SSL.new(host, port, host_name, socket_timeout, Socket::PF_INET, options) else Socket::TCP.new(host, port, socket_timeout, Socket::PF_INET, options) end end