pio 0.6.0 → 0.7.0

data/lib/pio/echo.rb

@@ -3,23 +3,16 @@
 require 'pio/echo/format'
 require 'pio/echo/reply'
 require 'pio/echo/request'
+require 'pio/message_type_selector'
 
 module Pio
   # OpenFlow Echo Request and Reply message parser.
   class Echo
+    extend MessageTypeSelector
+
     REQUEST = 2
     REPLY = 3
 
-    def self.read(raw_data)
-      echo = Echo::Format.read(raw_data)
-      case echo.message_type
-      when REQUEST
-        Echo::Request.create_from(echo)
-      when REPLY
-        Echo::Reply.create_from(echo)
-      else
-        fail 'Unknown Echo message type.'
-      end
-    end
+    message_type REQUEST => Request, REPLY => Reply
   end
 end

data/lib/pio/echo/format.rb

@@ -1,18 +1,18 @@
 # encoding: utf-8
 
 require 'bindata'
+require 'pio/type/open_flow'
 
 module Pio
   class Echo
     # OpenFlow 1.0 Echo message format.
     class Format < BinData::Record
+      extend Type::OpenFlow
+
       endian :big
 
-      uint8 :version, value: 1
-      uint8 :message_type
-      uint16 :message_length, value: -> { 8 + data.length }
-      uint32 :transaction_id, initial_value: 0
-      string :data
+      openflow_header
+      string :body
     end
   end
 end

data/lib/pio/echo/message.rb

@@ -14,7 +14,7 @@ module Pio
       def_delegators :@echo, :message_length
       def_delegators :@echo, :transaction_id
       def_delegator :@echo, :transaction_id, :xid
-      def_delegators :@echo, :data
+      def_delegator :@echo, :body, :data
       def_delegator :@echo, :to_binary_s, :to_binary
 
       def self.create_from(echo)
@@ -24,15 +24,24 @@ module Pio
       end
 
       def initialize(message_type, user_options = {})
-        @options = user_options.dup.merge(message_type: message_type)
-        handle_option_aliases
+        if user_options.respond_to?(:to_i)
+          @options = { transaction_id: user_options.to_i,
+                       message_type: message_type }
+        elsif user_options.respond_to?(:[])
+          @options = user_options.dup.merge(message_type: message_type)
+          handle_user_hash_options
+        else
+          fail TypeError
+        end
         @echo = Format.new(@options)
       end
 
       private
 
-      def handle_option_aliases
+      def handle_user_hash_options
+        @options[:body] = @options[:data]
         @options[:transaction_id] ||= @options[:xid]
+        @options[:transaction_id] = 0 unless @options[:transaction_id]
       end
     end
   end

data/lib/pio/echo/reply.rb

@@ -8,6 +8,35 @@ module Pio
   class Echo
     # OpenFlow 1.0 Echo Reply message.
     class Reply < Message
+      # Creates an EchoReply OpenFlow message. This message can be
+      # used to measure the bandwidth of a controller/switch
+      # connection as well as to verify its liveness.
+      #
+      # @overload initialize()
+      #   @example
+      #     Pio::Echo::Reply.new
+      #
+      # @overload initialize(transaction_id)
+      #   @example
+      #     Pio::Echo::Reply.new(123)
+      #   @param [Number] transaction_id
+      #     An unsigned 32-bit integer number associated with this
+      #     message.
+      #
+      # @overload initialize(user_options)
+      #   @example
+      #     Pio::Echo::Reply.new(
+      #       transaction_id: transaction_id,
+      #       user_data: 'Thu Aug 25 13:09:00 +0900 2011'
+      #     )
+      #   @param [Hash] user_options The options to create a message with.
+      #   @option user_options [Number] :transaction_id
+      #   @option user_options [Number] :xid An alias to transaction_id.
+      #   @option user_options [String] :user_data
+      #     The user data field specified as a String may be a message
+      #     timestamp to check latency, various lengths to measure
+      #     bandwidth or zero-size(nil) to verify liveness between the
+      #     switch and controller.
       def initialize(user_options = {})
         super REPLY, user_options
       end

data/lib/pio/echo/request.rb

@@ -8,6 +8,35 @@ module Pio
   class Echo
     # OpenFlow 1.0 Echo Request message.
     class Request < Message
+      # Creates an EchoRequest OpenFlow message. This message can be
+      # used to measure the bandwidth of a controller/switch
+      # connection as well as to verify its liveness.
+      #
+      # @overload initialize()
+      #   @example
+      #     Pio::Echo::Request.new
+      #
+      # @overload initialize(transaction_id)
+      #   @example
+      #     Pio::Echo::Request.new(123)
+      #   @param [Number] transaction_id
+      #     An unsigned 32-bit integer number associated with this
+      #     message.
+      #
+      # @overload initialize(user_options)
+      #   @example
+      #     Pio::Echo::Request.new(
+      #       transaction_id: transaction_id,
+      #       user_data: 'Thu Aug 25 13:09:00 +0900 2011'
+      #     )
+      #   @param [Hash] user_options The options to create a message with.
+      #   @option user_options [Number] :transaction_id
+      #   @option user_options [Number] :xid An alias to transaction_id.
+      #   @option user_options [String] :user_data
+      #     The user data field specified as a String may be a message
+      #     timestamp to check latency, various lengths to measure
+      #     bandwidth or zero-size(nil) to verify liveness between the
+      #     switch and controller.
       def initialize(user_options = {})
         super REQUEST, user_options
       end

data/lib/pio/features.rb

@@ -0,0 +1,18 @@
+# encoding: utf-8
+
+require 'pio/features/format'
+require 'pio/features/reply'
+require 'pio/features/request'
+require 'pio/message_type_selector'
+
+module Pio
+  # OpenFlow 1.0 Features messages
+  class Features
+    extend MessageTypeSelector
+
+    REQUEST = 5
+    REPLY = 6
+
+    message_type REQUEST => Request, REPLY => Reply
+  end
+end

data/lib/pio/features/format.rb

@@ -0,0 +1,18 @@
+# encoding: utf-8
+
+require 'bindata'
+require 'pio/type/open_flow'
+
+module Pio
+  class Features
+    # OpenFlow 1.0 Features message format.
+    class Format < BinData::Record
+      extend Type::OpenFlow
+
+      endian :big
+
+      openflow_header
+      string :body, read_length: -> { message_length - 8 }
+    end
+  end
+end

data/lib/pio/features/message.rb

@@ -0,0 +1,14 @@
+# encoding: utf-8
+
+module Pio
+  class Features
+    # Base class of Features request and reply.
+    class Message
+      def self.create_from(features)
+        message = allocate
+        message.instance_variable_set :@features, features
+        message
+      end
+    end
+  end
+end

data/lib/pio/features/reply.rb

@@ -0,0 +1,73 @@
+# encoding: utf-8
+
+require 'bindata'
+require 'forwardable'
+require 'pio/features/message'
+
+module Pio
+  # OpenFlow 1.0 Features messages
+  class Features
+    # OpenFlow 1.0 Features Reply message
+    class Reply < Message
+      # Message body of Features Reply
+      class Body < BinData::Record
+        endian :big
+
+        uint64 :datapath_id
+        uint32 :n_buffers
+        uint8 :n_tables
+        uint24 :padding
+        uint32 :capabilities
+        uint32 :actions
+        array :ports, type: :phy_port, read_until: :eof
+      end
+
+      extend Forwardable
+
+      def_delegators :@features, :version
+      def_delegators :@features, :message_type
+      def_delegators :@features, :message_length
+      def_delegators :@features, :transaction_id
+      def_delegator :@features, :transaction_id, :xid
+      def_delegators :@features, :body
+
+      def initialize(user_options = {})
+        @options = user_options.dup.merge(datapath_id: user_options[:dpid])
+        body = Body.new(@options)
+        @features = Format.new(@options.merge(message_type: 6,
+                                              body: body.to_binary_s))
+      end
+
+      def datapath_id
+        @body ||= Body.read(@features.body)
+        @body.datapath_id
+      end
+      alias_method :dpid, :datapath_id
+
+      def n_buffers
+        @body ||= Body.read(@features.body)
+        @body.n_buffers
+      end
+
+      def n_tables
+        @body ||= Body.read(@features.body)
+        @body.n_tables
+      end
+
+      def capabilities
+        @body ||= Body.read(@features.body)
+        @body.capabilities
+      end
+
+      def actions
+        @body ||= Body.read(@features.body)
+        @body.actions
+      end
+
+      def ports
+        @body ||= Body.read(@features.body)
+        @body.ports
+      end
+    end
+  end
+end

data/lib/pio/features/request.rb

@@ -0,0 +1,63 @@
+# encoding: utf-8
+
+require 'forwardable'
+require 'pio/features/message'
+
+module Pio
+  # OpenFlow 1.0 Features messages
+  class Features
+    # OpenFlow 1.0 Features Request message
+    class Request < Message
+      extend Forwardable
+
+      def_delegators :@features, :version
+      def_delegators :@features, :message_type
+      def_delegators :@features, :message_length
+      def_delegators :@features, :transaction_id
+      def_delegator :@features, :transaction_id, :xid
+      def_delegators :@features, :body
+      def_delegator :@features, :to_binary_s, :to_binary
+
+      # Creates a Features Request OpenFlow message.
+      #
+      # @overload initialize()
+      #   @example
+      #     Pio::Features::Request.new
+      #
+      # @overload initialize(transaction_id)
+      #   @example
+      #     Pio::Features::Request.new(123)
+      #   @param [Number] transaction_id
+      #     An unsigned 32-bit integer number associated with this
+      #     message.
+      #
+      # @overload initialize(user_options)
+      #   @example
+      #     Pio::Features::Request.new(transaction_id: 123)
+      #     Pio::Features::Request.new(xid: 123)
+      #   @param [Hash] user_options
+      #     The options to create a message with.
+      #   @option user_options [Number] :transaction_id
+      #   @option user_options [Number] :xid An alias to transaction_id.
+      def initialize(user_options = {})
+        if user_options.respond_to?(:to_i)
+          @options = { transaction_id: user_options.to_i,
+                       message_type: 5 }
+        elsif user_options.respond_to?(:[])
+          @options = user_options.dup.merge(message_type: 5)
+          handle_user_hash_options
+        else
+          fail TypeError
+        end
+        @features = Format.new(@options)
+      end
+
+      private
+
+      def handle_user_hash_options
+        @options[:transaction_id] ||= @options[:xid]
+        @options[:transaction_id] = 0 unless @options[:transaction_id]
+      end
+    end
+  end
+end

data/lib/pio/hello.rb

@@ -1,5 +1,6 @@
 # encoding: utf-8
 
+require 'English'
 require 'forwardable'
 require 'pio/hello/format'
 
@@ -16,22 +17,52 @@ module Pio
     def_delegators :@data, :body
     def_delegator :@data, :to_binary_s, :to_binary
 
+    # Parses +raw_data+ binary string into a Hello message object.
+    #
+    # @example
+    #   Pio::Hello.read("\x01\x00\x00\b\x00\x00\x00\x00")
+    # @return [Pio::Hello]
     def self.read(raw_data)
       hello = allocate
-      hello.instance_variable_set :@data, Format.read(raw_data)
+      begin
+        hello.instance_variable_set :@data, Format.read(raw_data)
+      rescue BinData::ValidityError
+        raise ParseError, $ERROR_INFO.message
+      end
       hello
     end
 
+    # Creates a Hello OpenFlow message.
+    #
+    # @overload initialize()
+    #   @example
+    #     Pio::Hello.new
+    #
+    # @overload initialize(transaction_id)
+    #   @example
+    #     Pio::Hello.new(123)
+    #   @param [Number] transaction_id
+    #     An unsigned 32-bit integer number associated with this
+    #     message.
+    #
+    # @overload initialize(user_options)
+    #   @example
+    #     Pio::Hello.new(transaction_id: 123)
+    #     Pio::Hello.new(xid: 123)
+    #   @param [Hash] user_options The options to create a message with.
+    #   @option user_options [Number] :transaction_id
+    #   @option user_options [Number] :xid An alias to transaction_id.
     def initialize(user_options = {})
-      @options = user_options.dup
-      handle_option_aliases
+      if user_options.respond_to?(:to_i)
+        @options = { transaction_id: user_options.to_i }
+      elsif user_options.respond_to?(:[])
+        @options = user_options.dup
+        @options[:transaction_id] ||= @options[:xid]
+        @options[:transaction_id] = 0 unless @options[:transaction_id]
+      else
+        fail TypeError
+      end
       @data = Format.new(@options)
     end
-
-    private
-
-    def handle_option_aliases
-      @options[:transaction_id] ||= @options[:xid]
-    end
   end
 end

data/lib/pio/icmp.rb

@@ -1,6 +1,6 @@
 # encoding: utf-8
 
-require 'pio/icmp/frame'
+require 'pio/icmp/format'
 require 'pio/icmp/reply'
 require 'pio/icmp/request'
 require 'pio/message_type_selector'

data/lib/pio/icmp/{frame.rb → format.rb}

@@ -6,8 +6,8 @@ require 'pio/type/ipv4_header'
 
 module Pio
   class Icmp
-    # Icmp frame parser.
-    class Frame < BinData::Record
+    # Icmp parser.
+    class Format < BinData::Record
       PADDED_PACKET_LENGTH = 50
       MINIMUM_PACKET_LENGTH = 36
       MINIMUM_FRAME_LENGTH = 64

data/lib/pio/icmp/message.rb

@@ -1,6 +1,6 @@
 # encoding: utf-8
 
-require 'pio/icmp/frame'
+require 'pio/icmp/format'
 require 'forwardable'
 
 module Pio
@@ -42,7 +42,7 @@ module Pio
 
       def initialize(user_options)
         options = self.class.const_get(:Options).new(user_options)
-        @frame = Icmp::Frame.new(options.to_hash)
+        @frame = Icmp::Format.new(options.to_hash)
       end
     end
   end