diameter 0.1.0.beta → 0.1.0.pre1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 155d66671781834056b72ee9fca500a317dd2580
-  data.tar.gz: d2233fc23a94125190656b1f13b73d193e178082
+  metadata.gz: e140baae5544d85586d01a9dbd1000c63d95aab0
+  data.tar.gz: c8407d154a3498d9d159acf99c1222043a288760
 SHA512:
-  metadata.gz: 0193a6fee32495c1566fe839cc3cdfb44f65ce7de5730cc4753b344c8809ea7afe2ce72b385d30f098544586e79c7543005c0198eb453c67cbf19cd3c7199428
-  data.tar.gz: cbed37f246b89602d463fc4cd5ce04d84a464c79e0ea3a054e47b78e37a2b54b3b3516c8c650194ebafd4cf78683b6f61b4b34f70e4db1ef8a68d924aab5c9a3
+  metadata.gz: 5e8e0a512e7b9ec8111a7e8d8e70252a6e0deaad7b966013a8a80be8bfb8f0d84dcfcfa65caa7264e7798ab4b39f08ed1fdcb616cc0307914b4ff9534e86722b
+  data.tar.gz: 44f4430b63e1c4a02c6f477ac89e37a2f0b94897a39e51ccae13eee62e73c0eba8f48ac7a35f74106b8d4cfa01312fa59b9128d40c53dd7be70cc57160d05a29

data/lib/diameter/avp.rb

@@ -51,14 +51,12 @@ module Diameter
 
     include AVPParser
 
-    # @api private
-    #
-    # Prefer {AVP.create} where possible.
     def initialize(code, options = {})
       @code = code
       @vendor_id = options[:vendor_id] || 0
       @content = options[:content] || ''
-      @mandatory = options.fetch(:mandatory, true)
+      @mandatory = options[:mandatory]
+      @mandatory = true if @mandatory.nil?
     end
 
     # Creates an AVP by name, and assigns it a value.
@@ -68,10 +66,6 @@ module Diameter
     #   that AVP - e.g. a Fixnum for an AVP defined as Unsigned32, a
     #   String for an AVP defined as OctetString, or an IPAddr for an AVP
     #   defined as IPAddress.
-    # @option opts [true, false] mandatory
-    #   Whether understanding this AVP is mandatory within this
-    #   application.
-    #
     # @return [AVP] The AVP that was created.
     def self.create(name, val, options = {})
       code, type, vendor = AVPNames.get(name)
@@ -109,7 +103,22 @@ module Diameter
         to_wire_novendor
       end
     end
+    
+    def to_wire_novendor
+      length_8, length_16 = UInt24.to_u8_and_u16(@content.length + 8)
+      avp_flags = @mandatory ? '01000000' : '00000000'
+      header = [@code, avp_flags, length_8, length_16].pack('NB8Cn')
+      header + padded_content
+    end
+
+    def to_wire_vendor
+      length_8, length_16 = UInt24.to_u8_and_u16(@content.length + 12)
+      avp_flags = @mandatory ? '11000000' : '10000000'
+      header = [@code, avp_flags, length_8, length_16, @vendor_id].pack('NB8CnN')
+      header + padded_content
+    end
 
+    
     # Guessing the type of an AVP and displaying it sensibly is complex,
     # so this is a complex method (but one that has a unity of purpose,
     # so can't easily be broken down). Disable several Rubocop
@@ -207,8 +216,6 @@ module Diameter
       grouped_value.select { |a| a.code == code }
     end
 
-    alias_method :[], :inner_avp
-    
     # Even though it is just "the raw bytes in the content",
     # octet_string is only one way of interpreting the AVP content and
     # shouldn't be treated differently to the others, so disable the
@@ -364,20 +371,6 @@ module Diameter
       end
     end
 
-    def to_wire_novendor
-      length_8, length_16 = UInt24.to_u8_and_u16(@content.length + 8)
-      avp_flags = @mandatory ? '01000000' : '00000000'
-      header = [@code, avp_flags, length_8, length_16].pack('NB8Cn')
-      header + padded_content
-    end
-
-    def to_wire_vendor
-      length_8, length_16 = UInt24.to_u8_and_u16(@content.length + 12)
-      avp_flags = @mandatory ? '11000000' : '10000000'
-      header = [@code, avp_flags, length_8, length_16, @vendor_id].pack('NB8CnN')
-      header + padded_content
-    end
-
     protected
 
     def padded_content

data/lib/diameter/message.rb

@@ -1,7 +1,6 @@
 require 'diameter/avp_parser'
 require 'diameter/u24'
 
-# The Diameter module
 module Diameter
   # A Diameter message.
   #
@@ -18,14 +17,16 @@ module Diameter
   #   The end-to-end identifier of this message.
   # @!attribute [r] request
   #   Whether this message is a request.
-  # @!attribute [r] answer
-  #   Whether this message is an answer.
   class Message
-    attr_reader :version, :command_code, :app_id, :hbh, :ete, :request, :answer
+    attr_reader :version, :command_code, :app_id, :hbh, :ete, :request
     include Internals
+    
+    # @!attribute [r] answer
+    #   Whether this message is an answer.
+    def answer
+      !@request
+    end
 
-    # Creates a new Diameter message.
-    #
     # @option opts [Fixnum] command_code
     #   The Diameter Command-Code of this messsage.
     # @option opts [Fixnum] app_id
@@ -51,7 +52,6 @@ module Diameter
       @ete = options[:ete] || Message.next_ete
 
       @request = options.fetch(:request, true)
-      @answer = !@request
       @proxyable = options.fetch(:proxyable, false)
       @retransmitted = false
       @error = false
@@ -90,10 +90,8 @@ module Diameter
     # Returns the first AVP with the given name. Only covers "top-level"
     # AVPs - it won't look inside Grouped AVPs.
     #
-    # Also available as [], e.g. message['Result-Code']
-    #
     # @param name [String] The AVP name, either one predefined in
-    #   {Constants::AVAILABLE_AVPS} or user-defined with {AVP.define}
+    #   {AVPNames::AVAILABLE_AVPS} or user-defined with {AVP.define}
     #
     # @return [AVP] if there is an AVP with that name
     # @return [nil] if there is not an AVP with that name
@@ -106,7 +104,7 @@ module Diameter
     # AVPs - it won't look inside Grouped AVPs.
     #
     # @param name [String] The AVP name, either one predefined in
-    #   {Constants::AVAILABLE_AVPS} or user-defined with {AVP.define}
+    #   {AVPNames::AVAILABLE_AVPS} or user-defined with {AVP.define}
     #
     # @return [Array<AVP>]
     def all_avps_by_name(name)
@@ -115,12 +113,8 @@ module Diameter
     end
 
     alias_method :avp, :avp_by_name
-    alias_method :[], :avp_by_name
-    alias_method :avps, :all_avps_by_name
-
-    # @private
-    # Prefer AVP.define and the by-name versions to this
-    #
+    alias_method :[], :all_avps_by_name
+    
     # Returns the first AVP with the given code and vendor. Only covers "top-level"
     # AVPs - it won't look inside Grouped AVPs.
     #
@@ -138,9 +132,6 @@ module Diameter
       end
     end
 
-    # @private
-    # Prefer AVP.define and the by-name versions to this
-    #
     # Returns all AVPs with the given code and vendor. Only covers "top-level"
     # AVPs - it won't look inside Grouped AVPs.
     #
@@ -162,24 +153,25 @@ module Diameter
 
     # Does this message contain a (top-level) AVP with this name?
     # @param name [String] The AVP name, either one predefined in
-    #   {Constants::AVAILABLE_AVPS} or user-defined with {AVP.define}
+    #   {AVPNames::AVAILABLE_AVPS} or user-defined with {AVP.define}
     #
     # @return [true, false]  
     def has_avp?(name)
       !!avp(name)
     end
 
-    # @private
-    #
-    # Not recommended for normal use - all AVPs should be given to the
-    # constructor. Used to allow the stack to add appropriate
-    # Origin-Host/Origin-Realm AVPs to outbound messages.
+    # @api private
     #
-    # @param host [String] The Diameter Identity for the stack.
-    # @param realm [String] The Diameter realm for the stack.
-    def add_origin_host_and_realm(host, realm)
-      @avps << AVP.create("Origin-Host", host) unless has_avp? 'Origin-Host'
-      @avps << AVP.create("Origin-Realm", realm) unless has_avp? 'Origin-Realm'
+    # Adds an AVP to this message. Not recommended for normal use -
+    # all AVPs should be given to the constructor. Used to allow the
+    # stack to add appropriate Origin-Host/Origin-Realm AVPs to outbound
+    # messages.
+    # @param name [String] The AVP name, either one predefined in
+    #   {AVPNames::AVAILABLE_AVPS} or user-defined with {AVP.define}
+    # @param value [Object] The AVP value, with type dependent on the
+    #   AVP itself.
+    def add_avp(name, value)
+      @avps << AVP.create(name, value)
     end
     
     # @!endgroup
@@ -214,7 +206,6 @@ module Diameter
       avps = Internals::AVPParser.parse_avps_int(bytes[20..-1])
       Message.new(version: version, command_code: command_code, app_id: app_id, hbh: hbh, ete: ete, request: request, proxyable: proxyable, retransmitted: false, error: false, avps: avps)
     end
-    
     # @!endgroup
 
     # Generates an answer to this request, filling in a Result-Code or

data/lib/diameter/stack.rb

@@ -9,21 +9,10 @@ require 'concurrent'
 module Diameter
   class Stack
     include Internals
-
-    # @!group Setup methods
-
-    # Stack constructor.
-    #
-    # @note The stack does not advertise any applications to peers by
-    #  default - {#add_handler} must be called early on.
-    #
-    # @param host [String] The Diameter Identity of this stack (for
-    #  the Origin-Host AVP).
-    # @param realm [String] The Diameter realm of this stack (for
-    #  the Origin-Realm AVP).
-    def initialize(host, realm)
+    def initialize(host, realm, opts={})
       @local_host = host
       @local_realm = realm
+      @local_port = opts[:port] || 3868
 
       @auth_apps = []
       @acct_apps = []
@@ -33,55 +22,18 @@ module Diameter
       @tcp_helper = TCPStackHelper.new(self)
       @peer_table = {}
       @handlers = {}
-
-      @threadpool = pool = Concurrent::ThreadPoolExecutor.new(
-                                                              min_threads: 5,
-                                                              max_threads: 5,
-                                                              max_queue: 100,
-                                                              overflow_policy: :caller_runs
-                                                              )
-
-      
       Diameter.logger.log(Logger::INFO, 'Stack initialized')
     end
 
-    # Complete the stack initialization and begin reading from the TCP connections.
+    # @!group Setup methods
     def start
       @tcp_helper.start_main_loop
     end
 
-    # Begins listening for inbound Diameter connections (making this a
-    # Diameter server instead of just a client).
-    #
-    # @param port [Fixnum] The TCP port to listen on (default 3868)
-    def listen_for_tcp(port=3868)
-      @tcp_helper.setup_new_listen_connection("0.0.0.0", port)
+    def listen_for_tcp
+      @tcp_helper.setup_new_listen_connection("0.0.0.0", @local_port)
     end
 
-    # Adds a handler for a specific Diameter application.
-    #
-    # @note If you expect to only send requests for this application,
-    #  not receive them, the block can be a no-op (e.g. `{ nil }`)
-    #
-    # @param app_id [Fixnum] The Diameter application ID.
-    # @option opts [true, false] auth
-    #   Whether we should advertise support for this application in
-    #   the Auth-Application-ID AVP. Note that at least one of auth or
-    #   acct must be specified.
-    # @option opts [true, false] acct
-    #   Whether we should advertise support for this application in
-    #   the Acct-Application-ID AVP. Note that at least one of auth or
-    #   acct must be specified.
-    # @option opts [Fixnum] vendor
-    #  If we should advertise support for this application in a
-    #  Vendor-Specific-Application-Id AVP, this specifies the
-    #  associated Vendor-Id.
-    #
-    # @yield [req, cxn] Passes a Diameter message (and its originating
-    #  connection) for application-specific handling.
-    # @yieldparam [Message] req The parsed Diameter message from the peer.
-    # @yieldparam [Socket] cxn The TCP connection to the peer, to be
-    #  passed to {Stack#send_answer}.
     def add_handler(app_id, opts={}, &blk)
       vendor = opts.fetch(:vendor, 0)
       auth = opts.fetch(:auth, false)
@@ -97,24 +49,10 @@ module Diameter
 
     # @!endgroup
 
-    # This shuts the stack down, closing all TCP connections and
-    # terminating any background threads still waiting for an answer.
     def shutdown
       @tcp_helper.shutdown
-      @pending_ete.each do |ete, q|
-        Diameter.logger.debug("Shutting down queue #{q} as no answer has been received with EtE #{ete}")
-        q.push :shutdown
-      end
-      @threadpool.kill
-      @threadpool.wait_for_termination(5)
     end
 
-    # Closes the given connection, blanking out any internal data
-    # structures associated with it.
-    #
-    # Likely to be moved to the Peer object in a future release/
-    #
-    # @param connection [Socket] The connection to close.
     def close(connection)
       @tcp_helper.close(connection)
     end
@@ -125,11 +63,12 @@ module Diameter
     # network location indicated by peer_uri.
     #
     # @param peer_uri [URI] The aaa:// URI identifying the peer. Should
-    #   contain a hostname/IP; may contain a port (default 3868).
+    #   contain a hostname/IP; may contain a port (default 3868) and a
+    #   transport param indicating TCP or SCTP (default TCP).
     # @param peer_host [String] The DiameterIdentity of this peer, which
     #   will uniquely identify it in the peer table.
     # @param realm [String] The Diameter realm of this peer.
-    def connect_to_peer(peer_uri, peer_host, realm)
+    def connect_to_peer(peer_uri, peer_host, _realm)
       uri = URI(peer_uri)
       cxn = @tcp_helper.setup_new_connection(uri.host, uri.port)
       avps = [AVP.create('Origin-Host', @local_host),
@@ -148,25 +87,19 @@ module Diameter
       # Will move to :UP when the CEA is received
     end
 
-    # Sends a Diameter request. This is routed to an appropriate peer
-    # based on the Destination-Host AVP.
-    #
-    # This adds this stack's Origin-Host and Origin-Realm AVPs, if
-    # those AVPs don't already exist.
-    #
-    # @param req [Message] The request to send.
     def send_request(req)
       fail "Must pass a request" unless req.request
-      req.add_origin_host_and_realm(@local_host, @local_realm) 
+      req.add_avp('Origin-Host', @local_host) unless req.has_avp? 'Origin-Host'
+      req.add_avp('Origin-Realm', @local_realm) unless req.has_avp? 'Origin-Realm'
+      q = Queue.new
+      @pending_ete[req.ete] = q
       peer_name = req.avp_by_name('Destination-Host').octet_string
       state = peer_state(peer_name)
       if state == :UP
         peer = @peer_table[peer_name]
         @tcp_helper.send(req.to_wire, peer.cxn)
-        q = Queue.new
-        @pending_ete[req.ete] = q
-        p = Concurrent::Promise.execute(executor: @threadpool) {
-          Diameter.logger.debug("Waiting for answer to message with EtE #{req.ete}, queue #{q}")
+        p = Concurrent::Promise.execute {
+          Diameter.logger.debug("Waiting for answer to message with EtE #{req.ete}")
           val = q.pop
           Diameter.logger.debug("Promise fulfilled for message with EtE #{req.ete}")
           val
@@ -177,28 +110,13 @@ module Diameter
       end
     end
 
-    # Sends a Diameter answer. This is sent over the same connection
-    # the request was received on (which needs to be passed into to
-    # this method).
-    #
-    # This adds this stack's Origin-Host and Origin-Realm AVPs, if
-    # those AVPs don't already exist.
-    #
-    # @param ans [Message] The Diameter answer
-    # @param original_cxn [Socket] The connection which the request
-    #   came in on. This will have been passed to the block registered
-    #   with {Stack#add_handler}.
     def send_answer(ans, original_cxn)
       fail "Must pass an answer" unless ans.answer
-      ans.add_origin_host_and_realm(@local_host, @local_realm) 
+      ans.add_avp('Origin-Host', @local_host) unless ans.has_avp? 'Origin-Host'
+      ans.add_avp('Origin-Realm', @local_realm) unless ans.has_avp? 'Origin-Realm'
       @tcp_helper.send(ans.to_wire, original_cxn)
     end
 
-    # Retrieves the current state of a peer, defaulting to :CLOSED if
-    # the peer does not exist.
-    #
-    # @param id [String] The Diameter identity of the peer.
-    # @return [Keyword] The state of the peer (:UP, :WAITING or :CLOSED).
     def peer_state(id)
       if !@peer_table.key? id
         :CLOSED
@@ -210,9 +128,6 @@ module Diameter
     # @!endgroup
     
     # @private
-    # Handles a Diameter request straight from a network connection.
-    # Intended to be called by TCPStackHelper after it retrieves a
-    # message, not directly by users.
     def handle_message(msg_bytes, cxn)
       # Common processing - ensure that this message has come in on this
       # peer's expected connection, and update the last time we saw
@@ -318,6 +233,7 @@ module Diameter
 
     def handle_cea(cea)
       peer = cea.avp_by_name('Origin-Host').octet_string
+      # puts peer
       if @peer_table.has_key? peer
         @peer_table[peer].state = :UP
         @peer_table[peer].reset_timer

data/lib/diameter/stack_transport_helpers.rb

@@ -3,10 +3,6 @@ require 'socket'
 require 'diameter/message'
 require 'diameter/avp'
 
-if RUBY_ENGINE != 'jruby'
-  ServerSocket = Socket
-end
-
 module Diameter
   module Internals
     # @private
@@ -19,7 +15,6 @@ module Diameter
         @loop_thread = nil
         @accept_loop_thread = nil
         @connection_lock = Mutex.new
-        @wakeup_pipe_rd, @wakeup_pipe_wr = IO.pipe
       end
 
       def start_main_loop
@@ -32,25 +27,25 @@ module Diameter
       end
 
       def wakeup
-        @wakeup_pipe_wr.puts "wakeup"
+        @loop_thread.raise
       end
 
       def main_loop
-          rs, _ws, es = IO.select(@all_connections + [@wakeup_pipe_rd], [], @all_connections)
+        begin
+          rs, _ws, es = IO.select(@all_connections, [], @all_connections)
+        rescue RuntimeError
+          return
+        end
 
         es.each do |e|
           Diameter.logger.log(Logger::WARN, "Exception on connection #{e}")
         end
 
         rs.each do |r|
-          if r == @wakeup_pipe_rd
-            r.gets
-            next
-          end
 
           existing_data = @data[r]
           if existing_data.length < 4
-            msg, _src = r.recv_nonblock(4 - existing_data.length)
+            msg, _src = r.recvfrom_nonblock(4 - existing_data.length)
             if msg == ''
               Diameter.logger.warn('Received 0 bytes on read, closing connection')
               close(r)
@@ -64,7 +59,7 @@ module Diameter
             expected_len = Message.length_from_header(existing_data[0..4])
             Diameter.logger.debug("Read 4 bytes #{existing_data[0..4].inspect}, " \
                                   "reading full message of length #{expected_len}")
-            msg, _src = r.recv_nonblock(expected_len - existing_data.length)
+            msg, _src = r.recvfrom_nonblock(expected_len - existing_data.length)
             existing_data += msg
             if msg == ''
               # Connection closed
@@ -83,7 +78,7 @@ module Diameter
       end
 
       def send(bytes, connection)
-        connection.send(bytes, 0)
+        connection.sendmsg(bytes)
       end
     end
 
@@ -118,7 +113,7 @@ module Diameter
       end
       
       def setup_new_listen_connection(host, port)
-        sd = ServerSocket.new(Socket::AF_INET, Socket::SOCK_STREAM, 0)
+        sd = Socket.new(Socket::AF_INET, Socket::SOCK_STREAM, 0)
         # reuse = [1,0].pack('ii')
         sd.setsockopt(Socket::SOL_SOCKET, Socket::SO_REUSEADDR, true)
         sd.bind(Socket.pack_sockaddr_in(port, host))

metadata

@@ -1,106 +1,105 @@
 --- !ruby/object:Gem::Specification
 name: diameter
 version: !ruby/object:Gem::Version
-  version: 0.1.0.beta
+  version: 0.1.0.pre1
 platform: ruby
 authors:
 - Rob Day
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-12-15 00:00:00.000000000 Z
+date: 2014-12-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: concurrent-ruby
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '0.7'
+        version: '0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '0.7'
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: rubocop
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '0.28'
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '0.28'
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: yard
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '='
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '0.8'
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '='
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '0.8'
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: simplecov
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '='
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '0.9'
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '='
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '0.9'
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: mocha
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '='
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '1.1'
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '='
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '1.1'
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: minitest-spec-context
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '='
+    - - ">="
       - !ruby/object:Gem::Version
-        version: 0.0.3
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '='
+    - - ">="
       - !ruby/object:Gem::Version
-        version: 0.0.3
+        version: '0'
 description: 
 email: ruby-diameter@rkd.me.uk
 executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- lib/diameter.rb
 - lib/diameter/avp.rb
 - lib/diameter/avp_parser.rb
 - lib/diameter/constants.rb

data/lib/diameter.rb

@@ -1,2 +0,0 @@
-require 'diameter/stack'
-require 'diameter/message'