Class: Nexpose::IPRange
- Inherits:
-
Object
- Object
- Nexpose::IPRange
- Includes:
- Comparable
- Defined in:
- lib/nexpose/site.rb
Overview
Object that represents a single IP address or an inclusive range of IP addresses. If to is nil then the from field will be used to specify a single IP Address only.
Instance Attribute Summary collapse
-
#from ⇒ Object
Start of range *Required.
-
#to ⇒ Object
End of range *Optional (If nil then IPRange is a single IP Address).
Instance Method Summary collapse
- #<=>(other) ⇒ Object
- #==(other) ⇒ Object
- #as_xml ⇒ Object (also: #to_xml_elem)
- #eql?(other) ⇒ Boolean
- #hash ⇒ Object
- #include?(single_ip) ⇒ Boolean
-
#initialize(from, to = nil) ⇒ IPRange
constructor
A new instance of IPRange.
-
#size ⇒ Fixnum
Size of the IP range.
- #to_xml ⇒ Object
Constructor Details
#initialize(from, to = nil) ⇒ IPRange
Returns a new instance of IPRange.
452 453 454 455 |
# File 'lib/nexpose/site.rb', line 452 def initialize(from, to = nil) @from = from @to = to unless from == to end |
Instance Attribute Details
#from ⇒ Object
Start of range *Required
448 449 450 |
# File 'lib/nexpose/site.rb', line 448 def from @from end |
#to ⇒ Object
End of range *Optional (If nil then IPRange is a single IP Address)
450 451 452 |
# File 'lib/nexpose/site.rb', line 450 def to @to end |
Instance Method Details
#<=>(other) ⇒ Object
471 472 473 474 475 476 477 478 479 480 481 482 483 484 |
# File 'lib/nexpose/site.rb', line 471 def <=>(other) return 1 unless other.respond_to? :from from = IPAddr.new(@from) to = @to.nil? ? from : IPAddr.new(@to) cf_from = IPAddr.new(other.from) cf_to = IPAddr.new(other.to.nil? ? other.from : other.to) if cf_to < from 1 elsif to < cf_from -1 else # Overlapping 0 end end |
#==(other) ⇒ Object
486 487 488 |
# File 'lib/nexpose/site.rb', line 486 def ==(other) eql?(other) end |
#as_xml ⇒ Object Also known as: to_xml_elem
514 515 516 517 518 |
# File 'lib/nexpose/site.rb', line 514 def as_xml xml = REXML::Element.new('range') xml.add_attributes({ 'from' => @from, 'to' => @to }) xml end |
#eql?(other) ⇒ Boolean
490 491 492 493 |
# File 'lib/nexpose/site.rb', line 490 def eql?(other) return false unless other.respond_to? :from @from == other.from && @to == other.to end |
#hash ⇒ Object
510 511 512 |
# File 'lib/nexpose/site.rb', line 510 def hash to_xml.hash end |
#include?(single_ip) ⇒ Boolean
495 496 497 498 499 500 501 502 503 504 505 506 507 508 |
# File 'lib/nexpose/site.rb', line 495 def include?(single_ip) return false unless single_ip.respond_to? :from from = IPAddr.new(@from) to = @to.nil? ? from : IPAddr.new(@to) other = IPAddr.new(single_ip) if other < from false elsif to < other false else true end end |
#size ⇒ Fixnum
Size of the IP range. The total number of IP addresses represented by this range.
462 463 464 465 466 467 |
# File 'lib/nexpose/site.rb', line 462 def size return 1 if @to.nil? from = IPAddr.new(@from) to = IPAddr.new(@to) (from..to).to_a.size end |
#to_xml ⇒ Object
521 522 523 |
# File 'lib/nexpose/site.rb', line 521 def to_xml as_xml.to_s end |