Contents

# encoding: utf-8

require 'English'
require 'forwardable'
require 'pio/hello/format'

module Pio
  # OpenFlow 1.0 Hello message
  class Hello
    extend Forwardable

    def_delegators :@data, :ofp_version
    def_delegators :@data, :message_type
    def_delegators :@data, :message_length
    def_delegators :@data, :transaction_id
    def_delegator :@data, :transaction_id, :xid
    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
      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 = {})
      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
  end
end

Version data entries

2 entries across 2 versions & 1 rubygems

Version	Path
pio-0.8.1	lib/pio/hello.rb
pio-0.8.0	lib/pio/hello.rb