rami 0.2 → 0.3

data/CHANGELOG

@@ -1,3 +1,8 @@
+* 0.3 (Nov 2, 2005)
+
+* Added Client.stop and Server.stop.
+
+
 * 0.2 (Oct 20, 2005)
 
 * Change RamiServer and RamiClient classes to just Server and Client. Client now takes one paramater for new(), which is an instance

data/bin/example1.rb

@@ -1,5 +1,6 @@
 #!/usr/local/bin/ruby
 
+## This shows how to use the Server and Client classes together, without using Server to create a separate proxy server. 
 require 'rubygems'
 require 'rami'
 include Rami
@@ -31,3 +32,4 @@ print_results(t)
 t =  client.get_events
 print_results(t)
 
+client.stop

data/bin/example2.rb

@@ -1,5 +1,6 @@
 #!/usr/local/bin/ruby
 
+## This shows how to create an instance of Client that can connect via Drb to an instance of Server running as a proxy.
 require 'rubygems'
 require 'rami'
 include Rami

data/lib/rami.rb

@@ -102,6 +102,14 @@ class Client
     @client = client
   end
 
+
+  # Closes the socket connection to Asterisk.  If your client was created using a Server instance instead of a DrbObject, then
+  # the connection will be left open as long as your client instance is still valid.  If for example you are making calls from
+  # a webserver this is bad as you will end up with a lot of open connections to Asterisk.  So make sure to use stop.
+  def stop
+    @client.stop
+  end
+
   def absolute_timeout(channel=nil,tout=nil)
     increment_action_id
     return @client.send_action({'ActionID' => @action_id, 'Action' => 'AbsoluteTimeout', 'Channel' => channel, 'Timeout' => tout},@timeout)
@@ -361,6 +369,8 @@ def logger(type,msg)
   end
 end
 
+
+
 def connect
   @sock = TCPSocket.new(@host,@port)
   login = {'Action' => 'login', 'Username' => @username, 'Secret' => @secret, 'Events' => 'On'}
@@ -394,8 +404,10 @@ def mainloop
 
   ast_reader = Thread.new do
     Thread.current.abort_on_exception=true
+   begin
     linecount = 0
     loop do
+
       event = {}
       @sock.each("\r\n") do |line|
         linecount += 1
@@ -440,6 +452,9 @@ def mainloop
         end
       end
     end
+    rescue IOError => e
+      puts "Socket disconnected #{e}"
+    end
   end
 end
 
@@ -471,6 +486,7 @@ end
 
 public
 
+
 # Starts the server and connects to asterisk.
 def run
   if connect
@@ -482,6 +498,10 @@ def run
   mainloop
 end
 
+def stop
+  @sock.close
+end
+
 # Should only be called via Client
 def find_events(key=nil,value=nil)
   logger('find_events',"#{key}: #{value}")

metadata

@@ -3,8 +3,8 @@ rubygems_version: 0.8.11
 specification_version: 1
 name: rami
 version: !ruby/object:Gem::Version 
-  version: "0.2"
-date: 2005-10-20 00:00:00 -07:00
+  version: "0.3"
+date: 2005-11-02 00:00:00 -08:00
 summary: A proxy server/client api for the Asterisk Manager Interface
 require_paths: 
   - lib