struct Socket::IPAddress

• Socket::IPAddress
• Socket::Address
• Struct
• Value
• Object

Overview

IP address representation.

Holds a binary representation of an IP address, either translated from a String, or directly received from an opened connection (e.g. Socket#local_address, Socket#receive).

Example:

require "socket"

Socket::IPAddress.new("127.0.0.1", 8080)
Socket::IPAddress.new("fe80::2ab2:bdff:fe59:8e2c", 1234)

IPAddress won't resolve domains, including localhost. If you must resolve an IP, or don't know whether a String contains an IP or a domain name, you should use Addrinfo.resolve instead.

Defined in:

Constant Summary

BROADCAST = "255.255.255.255"

BROADCAST6 = "ff0X::1"

LOOPBACK = "127.0.0.1"

LOOPBACK6 = "::1"

UNSPECIFIED = "0.0.0.0"

UNSPECIFIED6 = "::"

Constructors

• .from(sockaddr : Pointer(LibC::Sockaddr), addrlen) : IPAddress

  Creates an IPAddress from the internal OS representation.

• .new(address : String, port : Int32)
• .parse(uri : URI) : IPAddress

  Parses a Socket::IPAddress from an URI.

• .parse(uri : String) : self

  Parses a Socket::IPAddress from an URI.

Class Method Summary

• .valid_port?(port : Int) : Bool

  Returns true if port is a valid port number.

Instance Method Summary

• #==(other : self)
• #address : String

  Returns a String representation of the IP address.

• #hash(hasher)

  See Object#hash(hasher)

• #inspect(io : IO) : Nil

  Appends this struct's name and instance variables names and values to the given IO.

• #loopback? : Bool

  Returns true if this IP is a loopback address.

• #port : Int32
• #pretty_print(pp)
• #private? : Bool

  Returns true if this IP is a private address.

• #to_s(io : IO) : Nil

  Same as #inspect(io).

• #to_unsafe : Pointer(LibC::Sockaddr)
• #unspecified? : Bool

  Returns true if this IP is an unspecified address, either the IPv4 address 0.0.0.0 or the IPv6 address ::.

Constructor Detail

require "socket"

Socket::IPAddress.parse("tcp://127.0.0.1:8080") # => Socket::IPAddress.new("127.0.0.1", 8080)
Socket::IPAddress.parse("udp://[::1]:8080")     # => Socket::IPAddress.new("::1", 8080)

require "socket"

Socket::IPAddress.parse("tcp://127.0.0.1:8080") # => Socket::IPAddress.new("127.0.0.1", 8080)
Socket::IPAddress.parse("udp://[::1]:8080")     # => Socket::IPAddress.new("::1", 8080)

Class Method Detail

Instance Method Detail

ip_address = socket.remote_address
ip_address.address # => "127.0.0.1"

struct Point
  def initialize(@x : Int32, @y : Int32)
  end
end

p1 = Point.new 1, 2
p1.to_s    # "Point(@x=1, @y=2)"
p1.inspect # "Point(@x=1, @y=2)"