trema 0.2.5 → 0.2.6

data/ruby/trema/packet-queue.rb

@@ -26,21 +26,21 @@ class Queue
     attr_accessor :queues
   end
 
-  
+
   # Add queue to list.
   # @param [PacketQueue] queue a {PacketQueue} instance.
   def self.append queue
     @queues ||= []
     @queues << queue unless @queues.include?(queue)
   end
-  
-  
+
+
   # @return [Array]
   #   an array of {PacketQueue} objects.
   def self.queues
     @queues
   end
-  
+
 
   # Iterate over each {PacketQueue} item.
   # @return [Array] a list of {PacketQueue} items.
@@ -57,11 +57,11 @@ class PacketQueue
   OFPQT_NONE = 0
   # Minimum datarate guaranteed.
   OFPQT_MIN_RATE = 1
-  
-  
+
+
   # Id for the specific queue.
   # @return [Number] queue_id
-  #   the value of attribute queue_id.  
+  #   the value of attribute queue_id.
   attr_accessor :queue_id
   # Queue description's length in bytes.
   # @return [Number] len
@@ -79,7 +79,7 @@ class PacketQueue
   #   id for the specific queue.
   # @option options [Symbol] :len
   #   queue description's length in bytes.
-  # 
+  #
   def initialize options
     @queue_id = options[ :queue_id ]
     @len = options[ :len ]
@@ -146,7 +146,7 @@ class MinRateQueue < QueueProperty
   #   the value of attribute rate.
   attr_accessor :rate
 
-  
+
   # An object that encapsulates the minimum rate queue property description.
   # @param [Number] property
   #   property queue id.

data/ruby/trema/packetin-filter.rb

@@ -57,7 +57,7 @@ module Trema
     def name
       "packet-in filter"
     end
-    
+
 
     #
     # Starts a packetin filter process

data/ruby/trema/phost.rb

@@ -25,36 +25,45 @@ require "trema/executables"
 
 
 module Trema
+  #
+  # An interface class to phost emulation utility program.
+  #
   class Phost
     include Trema::Daemon
 
 
-    command { | phost | "sudo #{ Executables.phost } -i #{ phost.interface } -p #{ Trema.pid } -l #{ Trema.log } -D" }
+    command { | phost | "sudo #{ Executables.phost } -i #{ phost.interface } -p #{ Trema.pid } -l #{ Trema.log } -n #{ phost.name } -D" }
     wait_until_up
-    daemon_id :interface
+    daemon_id :name
 
 
+    #
+    # Creates a new instance of Phost for each virtual host.
+    #
     def initialize host
       @host = host
     end
 
 
+    #
+    # @raise [RuntimeError] if no interface defined for virtual host.
+    #
+    # @return [String] the virtual host's interface name.
+    #
     def interface
       raise "The link(s) for vhost '#{ name }' is not defined." if @host.interface.nil?
       @host.interface
     end
 
 
+    #
+    # @return [Boolean] whether phost is running or not.
+    #
     def running?
       not @host.interface.nil? and super
     end
 
 
-    ################################################################################
-    private
-    ################################################################################
-
-
     def name
       @host.name
     end

data/ruby/trema/port-mod.c

@@ -93,10 +93,11 @@ port_mod_init( int argc, VALUE *argv, VALUE self ) {
       if ( rb_obj_is_kind_of( hw_addr, rb_cString ) == Qtrue ||
         rb_obj_is_kind_of( hw_addr, rb_cInteger ) == Qtrue ) {
         mac = rb_funcall( rb_eval_string( "Trema::Mac" ), rb_intern( "new" ), 1, hw_addr );
-      } else if ( rb_obj_is_instance_of( hw_addr, rb_eval_string( "Trema::Mac" ) ) == Qfalse ) {
+      }
+      else if ( rb_obj_is_instance_of( hw_addr, rb_eval_string( "Trema::Mac" ) ) == Qfalse ) {
         rb_raise( rb_eArgError, "hw_addr must be a string or an integer or Mac object" );
       }
-      ptr = ( uint8_t* ) dl_addr_to_a( mac, haddr );
+      ptr = ( uint8_t * ) dl_addr_to_a( mac, haddr );
       rb_iv_set( self, "@hw_addr", mac );
     }
     VALUE port_no;
@@ -107,15 +108,15 @@ port_mod_init( int argc, VALUE *argv, VALUE self ) {
       rb_iv_set( self, "@port_no", port_no );
     }
     VALUE config;
-    if ( ( config = rb_hash_aref( options, ID2SYM( rb_intern( "config" ) ) ) ) != Qnil ){
+    if ( ( config = rb_hash_aref( options, ID2SYM( rb_intern( "config" ) ) ) ) != Qnil ) {
       rb_iv_set( self, "@config", config );
     }
     VALUE  mask;
-    if ( ( mask = rb_hash_aref( options, ID2SYM( rb_intern( "mask" ) ) ) ) != Qnil ){
+    if ( ( mask = rb_hash_aref( options, ID2SYM( rb_intern( "mask" ) ) ) ) != Qnil ) {
       rb_iv_set( self, "@mask", mask );
     }
     VALUE advertise;
-    if ( ( advertise = rb_hash_aref( options, ID2SYM( rb_intern( "advertise" ) ) ) ) != Qnil ){
+    if ( ( advertise = rb_hash_aref( options, ID2SYM( rb_intern( "advertise" ) ) ) ) != Qnil ) {
       rb_iv_set( self, "@advertise", advertise );
     }
     uint32_t xid = get_transaction_id();

data/ruby/trema/port-stats-reply.rb

@@ -35,7 +35,7 @@ module Trema
     #
     # @overload initialize(options={})
     #
-    #   @example 
+    #   @example
     #     PortStatsReply.new(
     #       :port_no => 1,
     #       :rx_packets => 7,
@@ -97,7 +97,7 @@ module Trema
     #   @return [PortStatsReply]
     #     an object that encapsulates the OFPST_STATS_REPLY(OFPST_PORT) OpenFlow message.
     #
-    def initialize options 
+    def initialize options
       super FIELDS, options
     end
   end

data/ruby/trema/process.rb

@@ -21,7 +21,25 @@
 
 
 module Trema
+  #
+  # A class responsible for terminating processes.
+  #
   class Process
+    #
+    # @overload read(pid_file)
+    #   Reads a process identification file and saves the process name
+    #   process id and effective user id. The process name is inferred from the
+    #   +:pid_file+.
+    #   @param [String] pid_file the full path name of the pid file.
+    #
+    # @overload read(pid_file, name)
+    #   Reads a process identification file and saves the process name
+    #   process id and effective user id.
+    #   @param [String] pid_file the full path name of the pid file.
+    #   @param [String] name the process name.
+    #
+    # @return [Process] the object that encapsulates the process details.
+    #
     def self.read pid_file, name = nil
       name = File.basename( pid_file, ".pid" ) if name.nil?
       return new( pid_file, name )
@@ -40,6 +58,14 @@ module Trema
     end
 
 
+    #
+    # kills an active process.
+    #
+    # @raise [RuntimeError] if failed to kill the process after a
+    #   maximum number of attempts.
+    #
+    # @return [void]
+    #
     def kill!
       return if @pid_file.nil?
       return if dead?
@@ -62,6 +88,9 @@ module Trema
     ################################################################################
 
 
+    #
+    # @return [Boolean] whether a process is not alive or not.
+    #
     def dead?
       `ps ax | grep -E "^[[:blank:]]*#{ @pid }"`.empty?
     end

data/ruby/trema/queue-stats-reply.rb

@@ -1,6 +1,4 @@
 #
-# Author: Nick Karanatsios <nickkaranatsios@gmail.com>
-#
 # Copyright (C) 2008-2012 NEC Corporation
 #
 # This program is free software; you can redistribute it and/or modify
@@ -34,7 +32,7 @@ module Trema
     #
     # @overload initialize(options={})
     #
-    #   @example 
+    #   @example
     #     QueueStatsReply.new(
     #       :port_no => 1,
     #       :queue_id => 123,
@@ -62,7 +60,7 @@ module Trema
     #     a counter of transmitted errors.
     #
     #   @return [QueueStatsReply]
-    #     an object that encapsulates the OFPST_STATS_REPLY(OPPST_QUEUE) OpenFlow message. 
+    #     an object that encapsulates the OFPST_STATS_REPLY(OFPST_QUEUE) OpenFlow message.
     #
     def initialize options
       super FIELDS, options

data/ruby/trema/send-out-port.rb

@@ -28,7 +28,9 @@ module Trema
     DEFAULT_MAX_LEN = 2 ** 16 - 1
 
 
+    # @return [Fixnum] the value of attribute {#max_len}
     attr_reader :max_len
+    # @return [Fixnum] the value of attribute {#port_number}
     attr_reader :port_number
 
 
@@ -38,7 +40,7 @@ module Trema
     # @example
     #   SendOutPort.new( 1 )
     #   SendOutPort.new( :port_number => 1 )
-    #   SendOutPort.new( :port_number => 1, :max_len => 256 )
+    #   SendOutPort.new( :port_number => OFPP_CONTROLLER, :max_len => 256 )
     #
     # @param [Integer|Hash] options
     #   the port number or the options hash to create this action class instance with.
@@ -81,14 +83,14 @@ module Trema
       if @port_number.nil?
         raise ArgumentError, "Port number is a mandatory option"
       end
-      if not @port_number.unsigned_16bit?
+      unless @port_number.unsigned_16bit?
         raise ArgumentError, "Port number must be an unsigned 16-bit integer"
       end
     end
 
 
     def check_max_len
-      if not @max_len.unsigned_16bit?
+      unless @max_len.unsigned_16bit?
         raise ArgumentError, "Max length must be an unsigned 16-bit integer"
       end
     end

data/ruby/trema/set-eth-addr.rb

@@ -25,6 +25,10 @@ module Trema
   # @abstract The base class of {SetEthSrcAddr} and {SetEthDstAddr} action.
   #
   class SetEthAddr < Action
+    #
+    # @return [Trema::Mac] the object that holds {#mac_address}'s
+    #   internal representation.
+    #
     attr_reader :mac_address
 
 

data/ruby/trema/set-ip-addr.rb

@@ -24,6 +24,8 @@ module Trema
   # @abstract The base class of {SetIpSrcAddr} and {SetIpDstAddr} action.
   #
   class SetIpAddr < Action
+    # @return [IPAddr] the object that holds {#ip_address}'s
+    #   internal representation.
     attr_reader :ip_address
 
 
@@ -31,8 +33,8 @@ module Trema
     # @private
     #
     def initialize ip_address
-      if not ip_address.is_a?( String )
-        raise TypeError, "Source IP address must be an String"
+      unless ip_address.is_a?( String )
+        raise TypeError, "Source IP address must be a String"
       end
       @ip_address = IPAddr.new( ip_address )
     end

data/ruby/trema/set-ip-dst-addr.rb

@@ -34,7 +34,8 @@ module Trema
     # @param [String] ip_address
     #   the IPv4 address to create this action with.
     #
-    # @raise [TypeError] if ip_address is not an String.
+    # @raise [ArgumentError] if ip_address is an invalid IPv4 address.
+    # @raise [TypeError] if ip_address is not a String.
     #
     def initialize ip_address
       super ip_address

data/ruby/trema/set-ip-src-addr.rb

@@ -33,7 +33,8 @@ module Trema
     # @param [String] ip_address
     #   the IPv4 address to create this action with.
     #
-    # @raise [TypeError] if ip_address is not an String.
+    # @raise [ArgumentError] if ip_address is an invalid IPv4 address.
+    # @raise [TypeError] if ip_address is not a String.
     #
     def initialize ip_address
       super ip_address

data/ruby/trema/set-ip-tos.rb

@@ -25,6 +25,7 @@ module Trema
   # An action to modify the IP ToS/DSCP field of a packet.
   #
   class SetIpTos < Action
+    # @return [Fixnum] the value of attribute {#type_of_service}
     attr_reader :type_of_service
 
 
@@ -41,10 +42,10 @@ module Trema
     # @raise [TypeError] if type_of_service argument is not an Integer.
     #
     def initialize type_of_service
-      if not type_of_service.is_a?( Integer )
+      unless type_of_service.is_a?( Integer )
         raise TypeError, "ToS must be an unsigned 8-bit integer"
       end
-      if not type_of_service.unsigned_8bit?
+      unless type_of_service.unsigned_8bit?
         raise ArgumentError, "ToS must be an unsigned 8-bit integer"
       end
       @type_of_service = type_of_service

data/ruby/trema/set-transport-port.rb

@@ -25,6 +25,7 @@ module Trema
   # @abstract The base class of {SetTransportSrcPort} and {SetTransportDstPort} action.
   #
   class SetTransportPort < Action
+    # @return [Fixnum] the value of attribute {#port_number}
     attr_reader :port_number
 
 
@@ -33,10 +34,10 @@ module Trema
     #
     def initialize port_number
       error_message = "TCP/UDP port must be an unsigned 16-bit integer"
-      if not port_number.is_a?( Integer )
+      unless port_number.is_a?( Integer )
         raise TypeError, error_message
       end
-      if not port_number.unsigned_16bit?
+      unless port_number.unsigned_16bit?
         raise ArgumentError, error_message
       end
       @port_number = port_number

data/ruby/trema/set-vlan-priority.rb

@@ -24,6 +24,7 @@ module Trema
   # An action to modify the VLAN priority of a packet.
   #
   class SetVlanPriority < Action
+    # @return [Fixnum] the value of attribute {#vlan_priority}
     attr_reader :vlan_priority
 
 
@@ -43,10 +44,10 @@ module Trema
     # @raise [TypeError] if vlan_priority is not an Integer.
     #
     def initialize vlan_priority
-      if not vlan_priority.is_a?( Integer )
+      unless vlan_priority.is_a?( Integer )
         raise TypeError, "VLAN priority must be an unsigned 8-bit Integer"
       end
-      if not ( vlan_priority >= 0 and vlan_priority <= 7 )
+      unless ( vlan_priority >= 0 and vlan_priority <= 7 )
         raise ArgumentError, "Valid VLAN priority values are 0 to 7 inclusive"
       end
       @vlan_priority = vlan_priority

data/ruby/trema/set-vlan-vid.rb

@@ -24,6 +24,7 @@ module Trema
   # An action to modify the VLAN ID of a packet.
   #
   class SetVlanVid < Action
+    # @return [Fixnum] the value of attribute {#vlan_id}
     attr_reader :vlan_id
 
 
@@ -38,15 +39,15 @@ module Trema
     # @param [Integer] vlan_id
     #   the VLAN ID to set to. Only the lower 12-bits are used.
     #
-    # @raise [ArgumentError] if vlan_id not within 1 and 4096 inclusive.
+    # @raise [ArgumentError] if vlan_id not within 1 and 4095 inclusive.
     # @raise [TypeError] if vlan_id is not an Integer.
     #
     def initialize vlan_id
-      if not vlan_id.is_a?( Integer )
+      unless vlan_id.is_a?( Integer )
         raise TypeError, "VLAN ID argument must be an Integer"
       end
-      if not ( vlan_id >= 1 and vlan_id <= 4096 )
-        raise ArgumentError, "Valid VLAN ID values between 1 to 4096 inclusive"
+      unless ( vlan_id >= 1 and vlan_id <= 4095 )
+        raise ArgumentError, "Valid VLAN ID values between 1 to 4095 inclusive"
       end
       @vlan_id = vlan_id
     end

data/ruby/trema/shell/reset_stats.rb

@@ -26,7 +26,8 @@ require "trema/dsl"
 module Trema
   module Shell
     def reset_stats host_name = nil
-      sanity_check
+      assert_trema_is_built
+
       if host_name and Host[ host_name ].nil?
         raise "Host '#{ host_name }' is not defined."
       end

data/ruby/trema/shell/run.rb

@@ -26,7 +26,7 @@ require "trema/dsl"
 module Trema
   module Shell
     def run controller
-      sanity_check
+      assert_trema_is_built
 
       if controller
         if /\.rb\Z/=~ controller.split.first