rubybvc 0.3.1 → 1.0.0

data/lib/openflowdev/actions/set_field_action.rb

@@ -28,14 +28,20 @@
 # ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF
 # THE POSSIBILITY OF SUCH DAMAGE.
 
+#Class to define OpenFlow action to set a field.
 class SetFieldAction < Action
+
+# _Parameters_ 
+# * +order+:: integer : The order of the action relative to other actions in Instruction.
+# * +vlan_id+:: integer : VLAN identifier to set.
+# * +mpls_label+:: integer : MPLS label to set.
   def initialize(order: 0, vlan_id: nil, mpls_label: nil)
     super(order: order)
     @vlan_id = vlan_id
     @mpls_label = mpls_label
   end
   
-  def to_hash
+  def to_hash #:nodoc:
     {:order => @order, 'set-field' => {'vlan-match' => {'vlan-id' =>
             {'vlan-id' => @vlan_id, 'vlan-id-present' => !@vlan_id.nil?}},
         'protocol-match-fields' => {'mpls-label' => @mpls_label}}}

data/lib/openflowdev/actions/set_mpls_ttl_action.rb

@@ -28,14 +28,19 @@
 # ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF
 # THE POSSIBILITY OF SUCH DAMAGE.
 
+#Class to define an OpenFlow action to set the MPLS Time To Live (TTL)
 class SetMplsTTLAction < Action
+
+# _Parameters_ 
+# * +order+:: integer : The order of the action relative to other actions in Instruction.
+# * +mpls_ttl+:: integer : The Time To Live to set in the MPLS header.
   def initialize(order: 0, mpls_ttl: nil)
     super(order: order)
     raise ArgumentError, "MPLS TTL (mpls_ttl) required" unless mpls_ttl
     @mpls_ttl = mpls_ttl
   end
   
-  def to_hash
+  def to_hash #:nodoc:
     {:order => order, 'set-mpls-ttl-action' => {'mpls-ttl' => @mpls_ttl}}
   end
 end

data/lib/openflowdev/actions/set_nw_dst_action.rb

@@ -28,14 +28,19 @@
 # ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF
 # THE POSSIBILITY OF SUCH DAMAGE.
 
+#Class to define OpenFlow action to set the destination IP (network layer) address
 class SetNwDstAction < Action
+
+# _Parameters_ 
+# * +order+:: integer : The order of the action relative to other actions in Instruction.
+# * +ip_addr+:: string : The destination IP address to set.
   def initialize(order: nil, ip_addr: nil)
     super(order: order)
     raise ArgumentError, "IP Address (ip_addr) required" unless ip_addr
     @ip = ip_addr
   end
   
-  def to_hash
+  def to_hash #:nodoc:
     {:order => @order, 'set-nw-dst-action' => {:address => @ip}}
   end
 end

data/lib/openflowdev/actions/set_nw_src_action.rb

@@ -28,14 +28,19 @@
 # ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF
 # THE POSSIBILITY OF SUCH DAMAGE.
 
+#Class used to define OpenFlow action for setting the Source IP address (network layer)
 class SetNwSrcAction < Action
+
+# _Parameters_ 
+# * +order+:: integer : The order of the action relative to other actions in Instruction.
+# * +ip_addr+:: string : The IP address to set in source IP
   def initialize(order: nil, ip_addr: nil)
     super(order: order)
     raise ArgumentError, "IP Address (ip_addr) required" unless ip_addr
     @ip = ip_addr
   end
   
-  def to_hash
+  def to_hash #:nodoc:
     {:order => @order, 'set-nw-src-action' => {:address => @ip}}
   end
 end

data/lib/openflowdev/actions/set_nw_ttl_action.rb

@@ -28,14 +28,19 @@
 # ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF
 # THE POSSIBILITY OF SUCH DAMAGE.
 
+#Class used to define OpenFlow action to set IP header Time To Live (network layer)
 class SetNwTTLAction < Action
+
+# _Parameters_ 
+# * +order+:: integer : The order of the action relative to other actions in Instruction.
+# * +ip_ttl+:: integer : The Time To Live to set in the IP header.
   def initialize(order: 0, ip_ttl: nil)
     super(order: order)
     raise ArgumentError, "IP TTL (ip_ttl) required" unless ip_ttl
     @ip_ttl = ip_ttl
   end
   
-  def to_hash
+  def to_hash #:nodoc:
     {:order => @order, 'set-nw-ttl-action' => {'nw-ttl' => @ip_ttl}}
   end
 end

data/lib/openflowdev/actions/set_queue_action.rb

@@ -28,7 +28,13 @@
 # ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF
 # THE POSSIBILITY OF SUCH DAMAGE.
 
+#Class to define OpenFlow action to set the queue for the packet
 class SetQueueAction < Action
+
+# _Parameters_ 
+# * +order+:: integer : The order of the action relative to other actions in Instruction.
+# * +queue+:: 
+# * +queue_id+:: integer : ID of the queue onto which the packet is to be queued.
   def initialize(order: nil, queue: nil, queue_id: nil)
     super(order: order)
     raise ArgumentError, "Queue (queue) required" unless queue
@@ -37,7 +43,7 @@ class SetQueueAction < Action
     @queue_id = queue
   end
   
-  def to_hash
+  def to_hash #:nodoc:
     {:order => @order, 'queue-action' => {:queue => @queue,
         'queue-id' => @queue_id}}
   end

data/lib/openflowdev/actions/set_tp_dst_action.rb

@@ -28,14 +28,19 @@
 # ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF
 # THE POSSIBILITY OF SUCH DAMAGE.
 
+#Class used to define OpenFlow action to set the TCP Destination port
 class SetTpDstAction < Action
+
+# _Parameters_ 
+# * +order+:: integer : The order of the action relative to other actions in Instruction.
+# * +port+:: integer : The destination TCP port to set.
   def initialize(order: nil, port: nil)
     super(order: order)
     raise ArgumentError, "Port (port) required" unless port
     @port = port
   end
   
-  def to_hash
+  def to_hash #:nodoc:
     {:order => order, 'set-tp-dst-action' => {:port => @port}}
   end
 end

data/lib/openflowdev/actions/set_tp_src_action.rb

@@ -28,14 +28,19 @@
 # ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF
 # THE POSSIBILITY OF SUCH DAMAGE.
 
+#Class used to define OpenFlow action to set TCP Source Port
 class SetTpSrcAction < Action
+
+# _Parameters_ 
+# * +order+:: integer : The order of the action relative to other actions in Instruction.
+# * +port+:: integer : The port number to set for TCP source port.
   def initialize(order: nil, port: nil)
     super(order: order)
     raise ArgumentError, "Port (port) required" unless port
     @port = port
   end
   
-  def to_hash
+  def to_hash #:nodoc:
     {:order => order, 'set-tp-src-action' => {:port => @port}}
   end
 end

data/lib/openflowdev/actions/set_vlan_cfi_action.rb

@@ -28,14 +28,19 @@
 # ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF
 # THE POSSIBILITY OF SUCH DAMAGE.
 
+#Class used to define OpenFlow action to set the CFI field of VLAN header
 class SetVlanCfiAction < Action
+
+# _Parameters_ 
+# * +order+:: integer : The order of the action relative to other actions in Instruction.
+# * +vlan_cfi+:: integer : The CFI field value to set.
   def initialize(order: nil, vlan_cfi: nil)
     super(order: order)
     raise ArgumentError, "VLAN CFI (vlan_cfi) required" unless vlan_cfi
     @vlan_cfi = vlan_cfi
   end
   
-  def to_hash
+  def to_hash #:nodoc:
     {:order => @order, 'set-vlan-cfi-action' => {'vlan-cfi' => @vlan_cfi}}
   end
 end

data/lib/openflowdev/actions/set_vlan_id_action.rb

@@ -28,14 +28,19 @@
 # ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF
 # THE POSSIBILITY OF SUCH DAMAGE.
 
+#Class to define OpenFlow action that will set the VLAN identifier in VLAN header
 class SetVlanIdAction < Action
+
+# _Parameters_ 
+# * +order+:: integer : The order of the action relative to other actions in Instruction.
+# * +vlan_id+:: integer : The VLAN identifier to set in VLAN header.
   def initialize(order: nil, vlan_id: nil)
     super(order: order)
     raise ArgumentError, "VLAN ID (vlan_id) required" unless vlan_id
     @vlan_id = vlan_id
   end
   
-  def to_hash
+  def to_hash #:nodoc:
     {:order => @order, 'set-vlan-id-action' => {'vlan-id' => @vlan_id}}
   end
 end

data/lib/openflowdev/actions/set_vlan_pcp_action.rb

@@ -28,14 +28,19 @@
 # ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF
 # THE POSSIBILITY OF SUCH DAMAGE.
 
+#Class used to define OpenFlow action to set the PCP field in VLAN header
 class SetVlanPCPAction < Action
+
+# _Parameters_ 
+# * +order+:: integer : The order of the action relative to other actions in Instruction.
+# * +vlan_pcp+:: integer : The valoue to set in the PCP field in VLAN header.
   def initialize(order: nil, vlan_pcp: nil)
     super(order: order)
     raise ArgumentError, "VLAN PCP (vlan_pcp) required" unless vlan_pcp
     @vlan_pcp = vlan_pcp
   end
   
-  def to_hash
+  def to_hash #:nodoc:
     {:order => @order, 'set-vlan-pcp-action' => {'vlan-pcp' => @vlan_pcp}}
   end
 end

data/lib/openflowdev/actions/strip_vlan_action.rb

@@ -28,8 +28,9 @@
 # ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF
 # THE POSSIBILITY OF SUCH DAMAGE.
 
+#Class used to define OpenFlow action to strip the VLAN header.
 class StripVlanAction < Action
-  def to_hash
+  def to_hash #:nodoc:
     {:order => @order, 'strip-vlan-action' => {}}
   end
 end

data/lib/openflowdev/actions/sw_path_action.rb

@@ -28,12 +28,16 @@
 # ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF
 # THE POSSIBILITY OF SUCH DAMAGE.
 
+
 class SwPathAction < Action
+
+# _Parameters_ 
+# * +order+:: integer : The order of the action relative to other actions in Instruction.
   def initialize(order: 0)
     super(order: order)
   end
   
-  def to_hash
+  def to_hash #:nodoc:
     {:order => @order, 'sw-path-action' => {}}
   end
 end

data/lib/openflowdev/flow_entry.rb

@@ -28,14 +28,84 @@
 # ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF
 # THE POSSIBILITY OF SUCH DAMAGE.
 
+# Class for creating and interacting with OpenFlow flows
 class FlowEntry
   require 'openflowdev/instruction'
   require 'openflowdev/match'
   
-  attr_reader :table_id, :id, :priority, :idle_timeout, :hard_timeout, :strict,
-    :install_hw, :barrier, :cookie, :cookie_mask, :name, :instructions, :match,
-    :out_port, :out_group, :flags, :buffer_id
-  
+  # string: ID of the table to put the flow in
+  attr_reader :table_id
+  # integer: Unique identifier of this FlowEntry in the Controller's data store
+  attr_reader :id
+  # integer: Priority level of flow entry
+  attr_reader :priority
+  # integer: Idle time before discarding (seconds)
+  attr_reader :idle_timeout
+  # integer: Max time before discarding (seconds)
+  attr_reader :hard_timeout
+  # boolean: Modify/Delete entry strictly matching wildcards and priority
+  attr_reader :strict
+  # internal Controller's inventory attribute
+  attr_reader :install_hw
+  # boolean: Boolean flag used to enforce OpenFlow switch to do ordered message processing.
+  # Barrier request/reply messages are used by the controller to ensure message dependencies
+  # have been met or to receive notifications for completed operations. When the controller
+  # wants to ensure message dependencies have been met or wants to receive notifications for
+  # completed operations, it may use an OFPT_BARRIER_REQUEST message. This message has no body.
+  # Upon receipt, the switch must finish processing all previously-received messages, including
+  # sending corresponding reply or error messages, before executing any messages beyond the
+  # Barrier Request.
+  attr_reader :barrier
+  # integer: Opaque Controller-issued identifier
+  attr_reader :cookie
+  # integer: Mask used to restrict the cookie bits that must match when the command is
+  # OFPFC_MODIFY* or OFPFC_DELETE*. A value of 0 indicates no restriction
+  attr_reader :cookie_mask
+  # string: FlowEntry name in the FlowTable (internal Controller's inventory attribute)
+  attr_reader :name
+  # list of Instruction: Instructions to be executed when a flow matches this entry flow match fields
+  attr_reader :instructions
+  # Match: Flow match fields
+  attr_reader :match
+  # integer: For delete commands, require matching entries to include this as an
+  # output port. A value of OFPP_ANY indicates no restriction.
+  attr_reader :out_port
+  # integer: For delete commands, require matching entries to include this as an
+  # output group. A value of OFPG_ANY indicates no restriction
+  attr_reader :out_group
+  # integer: Bitmap of OpenFlow flags (OFPFF_* from OpenFlow spec)
+  attr_reader :flags
+  # Buffered packet to apply to, or OFP_NO_BUFFER. Not meaningful for delete
+  attr_reader :buffer_id
+
+  # _Parameters_ 
+  # * +flow_table_id+:: string: ID of the table to put the flow in
+  # * +flow_id+:: integer: Unique identifier of this FlowEntry in the Controller's data store
+  # * +flow_priority+:: integer: Priority level of flow entry
+  # * +name+:: string: FlowEntry name in the FlowTable (internal Controller's inventory attribute)
+  # * +idle_timeout+:: integer: Idle time before discarding (seconds)
+  # * +hard_timeout+:: integer: Max time before discarding (seconds)
+  # * +strict+:: boolean: Modify/Delete entry strictly matching wildcards and priority
+  # * +install_hw+:: internal Controller's inventory attribute
+  # * +barrier+:: boolean: Boolean flag used to enforce OpenFlow switch to do ordered message processing.
+  # Barrier request/reply messages are used by the controller to ensure message dependencies
+  # have been met or to receive notifications for completed operations. When the controller
+  # wants to ensure message dependencies have been met or wants to receive notifications for
+  # completed operations, it may use an OFPT_BARRIER_REQUEST message. This message has no body.
+  # Upon receipt, the switch must finish processing all previously-received messages, including
+  # sending corresponding reply or error messages, before executing any messages beyond the
+  # Barrier Request.
+  # * +cookie+:: integer: Opaque Controller-issued identifier
+  # * +cookie_mask+:: integer: Mask used to restrict the cookie bits that must match when the command is
+  # OFPFC_MODIFY* or OFPFC_DELETE*. A value of 0 indicates no restriction
+  # * +out_port+:: integer: For delete commands, require matching entries to include this as an
+  # output port. A value of OFPP_ANY indicates no restriction.
+  # * +out_group+:: integer: For delete commands, require matching entries to include this as an
+  # output group. A value of OFPG_ANY indicates no restriction
+  # * +flags+:: integer: Bitmap of OpenFlow flags (OFPFF_* from OpenFlow spec)
+  # * +buffer_id+:: Buffered packet to apply to, or OFP_NO_BUFFER. Not meaningful for delete
+
+
   def initialize(flow_table_id: 0, flow_id: nil, flow_priority: nil, name: nil,
       idle_timeout: 0, hard_timeout: 0, strict: false, install_hw: false,
       barrier: false, cookie: nil, cookie_mask: nil, out_port: nil,
@@ -61,17 +131,27 @@ class FlowEntry
     @buffer_id = buffer_id
   end
   
+  ##
+  # Add an Instruction to the flow entry.
+  #
+  # _Parameters_ 
+  # * +instruction+:: Instruction : Instruction to add to the flow entry. 
   def add_instruction(instruction)
     raise ArgumentError, "Instruction must be of type 'Instruction'" unless instruction.is_a?(Instruction)
     @instructions << instruction
   end
-  
+
+  ##
+  # Add a match rule to the flow entry.
+  #
+  # _Parameters_ 
+  # * +match+:: Match : Match to add to the flow entry. 
   def add_match(match)
     raise ArgumentError, "Match must be of type 'Match'" unless match.is_a?(Match)
     @match = match
   end
   
-  def to_hash
+  def to_hash #:nodoc:
     instructions_hash = []
     @instructions.each do |instruction|
       instructions_hash << instruction.to_hash

data/lib/openflowdev/instruction.rb

@@ -28,22 +28,33 @@
 # ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF
 # THE POSSIBILITY OF SUCH DAMAGE.
 
+# Class representing OpenFlow flow instruction
 class Instruction
+  # integer : order that action is to be carried out relative to other instructions.
   attr_accessor :order
+  # Action : list of Action
   attr_reader :actions
   
+  ##
+  # _Parameters_
+  # * +instruction_order+:: Order in which to carry out this instruction relative to other instructions.
   def initialize(instruction_order: nil)
     raise ArgumentError, "Instruction Order (instruction_order) required" unless instruction_order
     @order = instruction_order
     @actions = []
   end
   
+  ##
+  # Add action to an Instruction.
+  #
+  # _Parameters_ 
+  # * +action+:: Action : What action to take 
   def add_apply_action(action)
     raise ArgumentError, "Action must be a subclass of 'Action'" unless action.is_a?(Action)
     @actions << action
   end
   
-  def to_hash
+  def to_hash #:nodoc:
     actions_hash = []
     @actions.each do |action|
       actions_hash << action.to_hash

data/lib/openflowdev/match.rb

@@ -28,16 +28,126 @@
 # ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF
 # THE POSSIBILITY OF SUCH DAMAGE.
 
+# Class that represents OpenFlow flow matching attributes 
 class Match
   require 'utils/hash_with_compact'
-  attr_reader :eth_type, :ipv4_dst, :ipv4_src, :ipv6_src, :ipv6_dst,
-    :ipv6_flabel, :ipv6_ext_hdr, :ethernet_dst, :ethernet_src, :in_phy_port,
-    :in_port, :ip_proto, :ip_dscp, :ip_ecn, :tcp_src_port, :tcp_dst_port,
-    :udp_src_port, :udp_dst_port, :icmpv4_type, :icmpv4_code, :icmpv6_type,
-    :icmpv6_code, :arp_op_code, :arp_src_ipv4, :arp_tgt_ipv4, :arp_src_hw_addr,
-    :arp_tgt_hw_addr, :vlan_id, :vlan_pcp, :sctp_dst, :sctp_src, :mpls_label,
-    :mpls_tc, :mpls_bos, :tunnel_id, :metadata, :metadata_mask
-  
+
+  # integer : Ethernet type
+  attr_reader :eth_type
+  # string : IPv4 Destination IP address
+  attr_reader :ipv4_dst
+  # string : IPv4 Source IP address
+  attr_reader :ipv4_src
+  # string : IPv6 Source IP address
+  attr_reader :ipv6_src
+  # string : IPv6 Destination IP address
+  attr_reader :ipv6_dst
+  # string : IPv6 Flow Label
+  attr_reader :ipv6_flabel
+  # integer : IPv6 Extension header
+  attr_reader :ipv6_ext_hdr
+  # string : Ethernet Destination address e.g. "00:11:22:33:44:55"
+  attr_reader :ethernet_dst
+  # string : Ethernet Source address e.g. "00:11:22:33:44:55" 
+  attr_reader :ethernet_src
+  # integer : Input physical port - not used for matches
+  attr_reader :in_phy_port
+  # integer : Input port
+  attr_reader :in_port
+  # integer : Ip protocol
+  attr_reader :ip_proto
+  # integer : Differentiated Services Code Point
+  attr_reader :ip_dscp
+  # integer : Explicit Congestion Notificaiton
+  attr_reader :ip_ecn
+  # integer : TCP Source port number
+  attr_reader :tcp_src_port
+  # integer : TCP Destination port number
+  attr_reader :tcp_dst_port
+  # integer : UDP Source port number
+  attr_reader :udp_src_port
+  # integer : UDP Destination port number
+  attr_reader :udp_dst_port
+  # integer : ICMPv4 type
+  attr_reader :icmpv4_type
+  # integer : ICMPv4 code
+  attr_reader :icmpv4_code
+  # integer : ICMPv6 type
+  attr_reader :icmpv6_type
+  # integer : ICMPv6 code
+  attr_reader :icmpv6_code
+  # integer : ARP opcode
+  attr_reader :arp_op_code
+  # string : ARP source IPv4 address.  e.g. "111.222.333.444"
+  attr_reader :arp_src_ipv4
+  # string : ARP target IPv4 address.  e.g. "111.222.333.444"
+  attr_reader :arp_tgt_ipv4
+  # string : ARP source hardware address.  e.g. "111.222.333.444"   
+  attr_reader :arp_src_hw_addr
+  # string : ARP target hardware address.  e.g. "111.222.333.444"
+  attr_reader :arp_tgt_hw_addr
+  # integer: VLAN identifier
+  attr_reader :vlan_id
+  # integer: VLAN priority code point
+  attr_reader :vlan_pcp
+  # integer : Stream control transmission protocol destination port
+  attr_reader :sctp_dst
+  # integer : Stream control transmission protocol source port
+  attr_reader :sctp_src
+  # integer : Multiprotocol Label Switching label
+  attr_reader :mpls_label
+  # integer : Multiprotocol Label Switching traffic class
+  attr_reader :mpls_tc
+  # integer : Multiprotocol Label Switching bottom of stack flag
+  attr_reader :mpls_bos
+  # integer : tunnel identifier
+  attr_reader :tunnel_id
+  # integer : Openflow intra-table metadata
+  attr_reader :metadata
+  # integer : Openflow intra-table metadata mask
+  attr_reader :metadata_mask
+
+
+    
+  # _Parameters_ 
+  # * +eth_type+:: integer : Ethernet type
+  # * +ipv4_destination+:: string : IPv4 Destination IP address
+  # * +ipv4_source+:: string : IPv4 Source IP address
+  # * +ipv6_source+:: string : IPv6 Source IP address
+  # * +ipv6_destination+:: string : IPv6 Destination IP address
+  # * +ipv6_flabel+:: string : IPv6 Flow Label
+  # * +ipv6_ext_header+:: integer : IPv6 Extension header
+  # * +ethernet_destination+:: string : Ethernet Destination address e.g. "00:11:22:33:44:55"
+  # * +ethernet_source+:: string : Ethernet Source address e.g. "00:11:22:33:44:55" 
+  # * +in_physical_port+:: integer : Input physical port - not used for matches
+  # * +in_port+:: integer : Input port
+  # * +ip_protocol_num+:: integer : Ip protocol
+  # * +ip_dscp+:: integer : Differentiated Services Code Point
+  # * +ip_ecn+:: integer : Explicit Congestion Notificaiton
+  # * +tcp_source_port+:: integer : TCP Source port number
+  # * +tcp_destination_port+:: integer : TCP Destination port number
+  # * +udp_source_port+:: integer : UDP Source port number
+  # * +udp_destination_port+:: integer : UDP Destination port number
+  # * +icmpv4_type+:: integer : ICMPv4 type
+  # * +icmpv4_code+:: integer : ICMPv4 code
+  # * +icmpv6_type+:: integer : ICMPv6 type
+  # * +icmpv6_code+:: integer : ICMPv6 code
+  # * +arp_op_code+:: integer : ARP opcode
+  # * +arp_source_ipv4+:: string : ARP source IPv4 address.  e.g. "111.222.333.444"
+  # * +arp_target_ipv4+:: string : ARP target IPv4 address.  e.g. "111.222.333.444"
+  # * +arp_source_hardware_address+:: string : ARP source hardware address.  e.g. "111.222.333.444"
+  # * +arp_target_hardware_address+:: string : ARP target hardware address.  e.g. "111.222.333.444"
+  # * +vlan_id+:: integer: VLAN identifier
+  # * +vlan_pcp+:: integer: VLAN priority code point
+  # * +sctp_destination+:: integer : Stream control transmission protocol destination port
+  # * +sctp_source+:: integer : Stream control transmission protocol source port
+  # * +mpls_label+:: integer : Multiprotocol Label Switching label
+  # * +mpls_tc+:: integer : Multiprotocol Label Switching traffic class
+  # * +mpls_bos+:: integer : Multiprotocol Label Switching bottom of stack flag
+  # * +tunnel_id+:: integer : tunnel identifier
+  # * +metadata+:: integer : Openflow intra-table metadata
+  # * +metadata_mask+:: integer : Openflow intra-table metadata mask
+
   def initialize(eth_type: nil, ipv4_destination: nil, ipv4_source: nil,
       ipv6_source: nil, ipv6_destination: nil, ipv6_flabel: nil,
       ipv6_ext_header: nil, ethernet_destination: nil, ethernet_source: nil,
@@ -89,7 +199,7 @@ class Match
     @metadata_mask = metadata_mask
   end
   
-  def to_hash
+  def to_hash #:nodoc:
     hash = {'ethernet-match' => {'ethernet-type' => {:type => @eth_type},
       'ethernet-destination' => {:address => @ethernet_dst},
       'ethernet-source' => {:address => @ethernet_src}},