Class: Nmap::XML::ScanTask

Inherits:
Struct
  • Object
show all
Defined in:
lib/nmap/xml/scan_task.rb

Overview

Since:

  • 1.0.0

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(name, start_time, end_time, extra_info = nil) ⇒ ScanTask

Creates a new ScanTask object.

Parameters:

  • name (String) —

    The name of the scan task.

  • start_time (Time) —

    The time the scan task begun.

  • end_time (Time) —

    The time the scan task ended.

  • extra_info (String) (defaults to: nil) —

    Any extra information relating to the scan task.

Since:

  • 0.1.2



25
26
27
 
# File 'lib/nmap/xml/scan_task.rb', line 25

def initialize(name,start_time,end_time,extra_info=nil)
  super
end

Instance Attribute Details

#end_time ⇒ Object

Returns the value of attribute end_time

Returns:

  • (Object) —

    the current value of end_time



6
7
8
 
# File 'lib/nmap/xml/scan_task.rb', line 6

def end_time
  @end_time
end

#extra_info ⇒ Object

Returns the value of attribute extra_info

Returns:

  • (Object) —

    the current value of extra_info



6
7
8
 
# File 'lib/nmap/xml/scan_task.rb', line 6

def extra_info
  @extra_info
end

#name ⇒ Object

Returns the value of attribute name

Returns:

  • (Object) —

    the current value of name



6
7
8
 
# File 'lib/nmap/xml/scan_task.rb', line 6

def name
  @name
end

#start_time ⇒ Object

Returns the value of attribute start_time

Returns:

  • (Object) —

    the current value of start_time



6
7
8
 
# File 'lib/nmap/xml/scan_task.rb', line 6

def start_time
  @start_time
end

Instance Method Details

#duration ⇒ Integer

The duration of the scan task.

Returns:

  • (Integer) —

    The number of seconds it took the scan task to complete.

Since:

  • 0.1.2



37
38
39
 
# File 'lib/nmap/xml/scan_task.rb', line 37

def duration
  (self.end_time - self.start_time)
end

#to_s ⇒ String

Converts the scan task to a String.

Returns:

  • (String) —

    The String form of the scan task.

Since:

  • 0.1.2



49
50
51
 
# File 'lib/nmap/xml/scan_task.rb', line 49

def to_s
  "#{self.start_time}: #{self.name} (#{self.extra_info})"
end