Class: IPAddr

Constants

 xffffffff
 xffffffffffffffffffffffffffffffff
 (["%.4x"] * 8).join(':')

Attributes

family [R] Returns the address family of this IP address.

Public Class methods

new(addr = '::', family = Socket::AF_UNSPEC)

Creates a new ipaddr object either from a human readable IP address representation in string, or from a packed in_addr value followed by an address family.

In the former case, the following are the valid formats that will be recognized: "address", "address/prefixlen" and "address/mask", where IPv6 address may be enclosed in square brackets (`[’ and `]’). If a prefixlen or a mask is specified, it returns a masked IP address. Although the address family is determined automatically from a specified string, you can specify one explicitly by the optional second argument.

Otherwise an IP addess is generated from a packed in_addr value and an address family.

The IPAddr class defines many methods and operators, and some of those, such as &, |, include? and ==, accept a string, or a packed in_addr value instead of an IPAddr object.

new_ntoh(addr)

Creates a new ipaddr containing the given network byte ordered string form of an IP address.

ntop(addr)

Convert a network byte ordered string form of an IP address into human readable form.

Public Instance methods

&(other)

Returns a new ipaddr built by bitwise AND.

<<(num)

Returns a new ipaddr built by bitwise left shift.

<=>(other)

Compares the ipaddr with another.

==(other)

Returns true if two ipaddrs are equal.

===(other)

Alias for include?

>>(num)

Returns a new ipaddr built by bitwise right-shift.

hton()

Returns a network byte ordered string form of the IP address.

include?(other)

Returns true if the given ipaddr is in the range.

e.g.:

  require 'ipaddr'
  net1 = IPAddr.new("192.168.2.0/24")
  net2 = IPAddr.new("192.168.2.100")
  net3 = IPAddr.new("192.168.3.0")
  p net1.include?(net2)     #=> true
  p net1.include?(net3)     #=> false

inspect()

Returns a string containing a human-readable representation of the ipaddr. ("#<IPAddr: family:address/mask>")

ip6_arpa()

Returns a string for DNS reverse lookup compatible with RFC3172.

ip6_int()

Returns a string for DNS reverse lookup compatible with RFC1886.

ipv4?()

Returns true if the ipaddr is an IPv4 address.

ipv4_compat()

Returns a new ipaddr built by converting the native IPv4 address into an IPv4-compatible IPv6 address.

ipv4_compat?()

Returns true if the ipaddr is an IPv4-compatible IPv6 address.

ipv4_mapped()

Returns a new ipaddr built by converting the native IPv4 address into an IPv4-mapped IPv6 address.

ipv4_mapped?()

Returns true if the ipaddr is an IPv4-mapped IPv6 address.

ipv6?()

Returns true if the ipaddr is an IPv6 address.

mask(prefixlen)

Returns a new ipaddr built by masking IP address with the given prefixlen/netmask. (e.g. 8, 64, "255.255.255.0", etc.)

native()

Returns a new ipaddr built by converting the IPv6 address into a native IPv4 address. If the IP address is not an IPv4-mapped or IPv4-compatible IPv6 address, returns self.

reverse()

Returns a string for DNS reverse lookup. It returns a string in RFC3172 form for an IPv6 address.

succ()

Returns the successor to the ipaddr.

to_i()

Returns the integer representation of the ipaddr.

to_range()

Creates a Range object for the network address.

to_s()

Returns a string containing the IP address representation.

to_string()

Returns a string containing the IP address representation in canonical form.