Class: Mongo::Address::IPv4

Inherits:
Object
  • Object
show all
Defined in:
lib/mongo/address/ipv4.rb

Overview

Sets up resolution with IPv4 support if the address is an ip address.

Since:

  • 2.0.0

Constant Summary

MATCH =

The regular expression to use to match an IPv4 ip address.

Since:

  • 2.0.0

Regexp.new('/\./').freeze
SPLIT =

Split value constant.

Since:

  • 2.1.0

':'.freeze

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(host, port, host_name = nil) ⇒ IPv4

Initialize the IPv4 resolver.

Examples:

Initialize the resolver.

IPv4.new("127.0.0.1", 27017, 'localhost')

Parameters:

  • host (String)

    The host.

  • port (Integer)

    The port.

Since:

  • 2.0.0



69
70
71
72
73
# File 'lib/mongo/address/ipv4.rb', line 69

def initialize(host, port, host_name=nil)
  @host = host
  @port = port
  @host_name = host_name
end

Instance Attribute Details

#hostString (readonly)

Returns host The host.

Returns:

  • (String)

    host The host.

Since:

  • 2.0.0



25
26
27
# File 'lib/mongo/address/ipv4.rb', line 25

def host
  @host
end

#host_nameString (readonly)

Returns host_name The original host name.

Returns:

  • (String)

    host_name The original host name.

Since:

  • 2.0.0



28
29
30
# File 'lib/mongo/address/ipv4.rb', line 28

def host_name
  @host_name
end

#portInteger (readonly)

Returns port The port.

Returns:

  • (Integer)

    port The port.

Since:

  • 2.0.0



31
32
33
# File 'lib/mongo/address/ipv4.rb', line 31

def port
  @port
end

Class Method Details

.parse(address) ⇒ Array<String, Integer>

Parse an IPv4 address into its host and port.

Examples:

Parse the address.

IPv4.parse("127.0.0.1:28011")

Parameters:

  • address (String)

    The address to parse.

Returns:

  • (Array<String, Integer>)

    The host and port pair.

Since:

  • 2.0.0



53
54
55
56
57
58
# File 'lib/mongo/address/ipv4.rb', line 53

def self.parse(address)
  parts = address.split(SPLIT)
  host = parts[0]
  port = (parts[1] || 27017).to_i
  [ host, port ]
end

Instance Method Details

#socket(socket_timeout, ssl_options = {}) ⇒ Pool::Socket::SSL, Pool::Socket::TCP

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

Examples:

Get an IPv4 socket.

ipv4.socket(5, :ssl => true)

Parameters:

  • socket_timeout (Float)

    The socket timeout.

  • ssl_options (Hash) (defaults to: {})

    SSL options.

Returns:

  • (Pool::Socket::SSL, Pool::Socket::TCP)

    The socket.

Since:

  • 2.0.0



86
87
88
89
90
91
92
# File 'lib/mongo/address/ipv4.rb', line 86

def socket(socket_timeout, ssl_options = {})
  unless ssl_options.empty?
    Socket::SSL.new(host, port, host_name, socket_timeout, Socket::PF_INET, ssl_options)
  else
    Socket::TCP.new(host, port, socket_timeout, Socket::PF_INET)
  end
end