easy-serve 0.7 → 0.8

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: df13d8d57aa30fecfea71c7f1c0b3415e3384aaf
-  data.tar.gz: fad37a85f05878d484889783e6c49387380300fe
+  metadata.gz: 03c328ab82c8bb6aebbc3b9e6e5c9a50a3895a5c
+  data.tar.gz: be6c2705dc58ee78cf2ce725f0bdb885dac96378
 SHA512:
-  metadata.gz: 65b1b16bb7305ef869cc00ad481f621a104c680d0940e1ca2351e5b0ec19fbb6cc423dea5037d57f87f4ab7ccadf228ba526fb6188723be4062f3c67d3506e75
-  data.tar.gz: 820382890ef5249a837f5a1c71faf2650c1925c3d4f282a5cc24ee70a9d37f7091d7579adbcd63f4d4dea551ad32b69731e45b0aa29f5b16e0966ad345125d64
+  metadata.gz: d91ad208ac5237e50d2e03ca0d1524a2a8005753f78fa1ccf192b7486baa8ce70abca4c2b8ca7ecfaa25c2d364f1d0f5a6dcf6759fb2916557a3b9e9ca31b64f
+  data.tar.gz: 22d93a3d940daf5e2ecf4810896f9f13fbef3d49e8cad7f7f2b9a1a07991f1d4bb106163e55dfaf9d70f7a8dec8ed0bbc0a6b5a76b3856c74fbafa50e7e76491

data/README.md

@@ -1,4 +1,4 @@
 easy-serve
 ==========
 
-Framework for starting tcp/unix servers and connected clients under one parent process and on remote hosts.
+Framework for starting tcp/unix services and connected clients under one parent process and on remote hosts.

data/examples/multi.rb

@@ -1,18 +1,24 @@
 require 'easy-serve'
 
-servers_file = ARGV.shift
-unless servers_file
-  abort "Usage: #$0 servers_file   # Run this in two or more shells"
+if ARGV.delete("--tcp")
+  proto = :tcp
+else
+  proto = :unix
 end
 
-EasyServe.start servers_file: servers_file do |ez|
+services_file = ARGV.shift
+unless services_file
+  abort "Usage: #$0 services_file   # Run this in two or more shells"
+end
+
+EasyServe.start services_file: services_file do |ez|
   log = ez.log
   log.level = Logger::DEBUG
   log.formatter = nil if $VERBOSE
 
-  ez.start_servers do
-    ez.server "simple-server", :unix do |svr|
-      log.debug {"starting server"}
+  ez.start_services do
+    ez.service "simple-service", proto do |svr|
+      log.debug {"starting service"}
       Thread.new do
         loop do
           Thread.new(svr.accept) do |conn|
@@ -26,13 +32,13 @@ EasyServe.start servers_file: servers_file do |ez|
     end
   end
   
-  ez.child "simple-server" do |conn|
+  ez.child "simple-service" do |conn|
     log.progname = "client with pid=#$$"
     log.info conn.read
     conn.write "hello from #{log.progname}"
   end
   
-  ez.local "simple-server" do |conn|
+  ez.local "simple-service" do |conn|
     log.progname = "parent process"
     log.info "PRESS RETURN TO STOP"
     gets

data/examples/passive.rb

@@ -1,14 +1,20 @@
 require 'easy-serve'
 Thread.abort_on_exception = true
 
+if ARGV.delete("--tcp")
+  proto = :tcp
+else
+  proto = :unix
+end
+
 EasyServe.start do |ez|
   log = ez.log
   log.level = Logger::DEBUG
   log.formatter = nil if $VERBOSE
-  log.debug {"starting servers"}
+  log.debug {"starting services"}
     
-  ez.start_servers do
-    ez.server "simple-server", :unix do |svr|
+  ez.start_services do
+    ez.service "simple-service", proto do |svr|
       Thread.new do
         loop do
           conn = svr.accept
@@ -21,7 +27,7 @@ EasyServe.start do |ez|
     end
   end
   
-  ez.child "simple-server", passive: true do |conn|
+  ez.child "simple-service", passive: true do |conn|
     log.progname = "client 1"
     log.info conn.read
     conn.write "hello from #{log.progname}, pid = #$$; sleeping..."
@@ -31,7 +37,7 @@ EasyServe.start do |ez|
   
   sleep 0.1
   
-  ez.child "simple-server" do |conn|
+  ez.child "simple-service" do |conn|
     log.progname = "client 2"
     log.info conn.read
     conn.write "hello from #{log.progname}, pid = #$$"

data/examples/remote-drb.rb

@@ -23,8 +23,8 @@ EasyServe.start do |ez|
   log.level = Logger::INFO
   log.formatter = nil if $VERBOSE
 
-  ez.start_servers do
-    ez.server "simple-server", :tcp, nil, 0 do |svr|
+  ez.start_services do
+    ez.service "simple-service", :tcp do |svr|
       Thread.new do
         loop do
           Thread.new(svr.accept) do |conn|
@@ -41,7 +41,7 @@ EasyServe.start do |ez|
     end
   end
   
-  ez.remote "simple-server", host: addr_there do |conn|
+  ez.remote "simple-service", host: addr_there do |conn|
     # this block runs locally, but calls methods on the remote using drb
     log.progname = "druby remote on #{addr_there}"
     log.info "trying to read from #{conn.inspect}"

data/examples/remote-eval-passive.rb

@@ -22,8 +22,8 @@ EasyServe.start do |ez|
   log.level = Logger::INFO
   log.formatter = nil if $VERBOSE
 
-  ez.start_servers do
-    ez.server "simple-server", :tcp, nil, 0 do |svr|
+  ez.start_services do
+    ez.service "simple-service", :tcp do |svr|
       Thread.new do
         loop do
           Thread.new(svr.accept) do |conn|
@@ -40,7 +40,7 @@ EasyServe.start do |ez|
     end
   end
 
-  ez.remote "simple-server", host: addr_there, log: true, passive: true,
+  ez.remote "simple-service", host: addr_there, log: true, passive: true,
     eval: %{
     conn = conns[0]
     # this code is executed on the remote host, connected by conn, not drb
@@ -52,17 +52,17 @@ EasyServe.start do |ez|
     
     sleep
       # Without passive, this sleep would prevent the distributed app from
-      # exiting -- the simple-server above could not be safely stopped, since
+      # exiting -- the simple-service above could not be safely stopped, since
       # there's no guarantee that it is no longer needed. The passive
       # declaration make it clear that this process can be stopped after all
-      # non-passive clients have finished, and then the server can be stopped.
+      # non-passive clients have finished, and then the service can be stopped.
       # Of course, this also means that if all other clients execute very
       # quickly, this client might never get a chance to run.
   }
   
   sleep 1 # Ensure (for testing) that the above client runs.
   
-  ez.remote "simple-server", host: addr_there, log: true, eval: %{
+  ez.remote "simple-service", host: addr_there, log: true, eval: %{
     conn = conns[0]
     # this code is executed on the remote host, connected by conn, not drb
     log.progname = "eval remote 2 on \#{host}"

data/examples/remote-eval.rb

@@ -15,7 +15,7 @@ unless addr_there
     
     The 'hostname' may by any valid hostname or ssh alias.
 
-    If --tunnel is specified, use the ssh connection to tunnel the tupelo
+    If --tunnel is specified, use the ssh connection to tunnel the data
     traffic. Otherwise, just use tcp. (Always use ssh to start the remote
     process.)
 
@@ -27,9 +27,9 @@ EasyServe.start do |ez|
   log.level = Logger::INFO
   log.formatter = nil if $VERBOSE
 
-  ez.start_servers do
+  ez.start_services do
     host = tunnel ? "localhost" : nil # no need to expose port if tunnelled
-    ez.server "simple-server", :tcp, host, 0 do |svr|
+    ez.service "simple-service", :tcp, bind_host: host do |svr|
       Thread.new do
         loop do
           Thread.new(svr.accept) do |conn|
@@ -46,7 +46,7 @@ EasyServe.start do |ez|
     end
   end
 
-  ez.remote "simple-server", host: addr_there, tunnel: tunnel, log: true,
+  ez.remote "simple-service", host: addr_there, tunnel: tunnel, log: true,
     eval: %{
     conn = conns[0]
     # this code is executed on the remote host, connected by conn, not drb

data/examples/remote-manual.rb

@@ -1,22 +1,22 @@
 require 'easy-serve'
 
-servers_file = ARGV.shift
-unless servers_file
+services_file = ARGV.shift
+unless services_file
   abort <<-END
-    Usage: #$0 servers_file
-    For the client, copy the generated servers_file to the client host, and
+    Usage: #$0 services_file
+    For the client, copy the generated services_file to the client host, and
     run with the same command.
   END
 end
 
-EasyServe.start servers_file: servers_file do |ez|
+EasyServe.start services_file: services_file do |ez|
   log = ez.log
   log.level = Logger::DEBUG
   log.formatter = nil if $VERBOSE
 
-  ez.start_servers do
-    ez.server "simple-server", :tcp, '0.0.0.0', 0 do |svr|
-      log.debug {"starting server"}
+  ez.start_services do
+    ez.service "simple-service", :tcp do |svr|
+      log.debug {"starting service"}
       Thread.new do
         loop do
           Thread.new(svr.accept) do |conn|
@@ -30,7 +30,7 @@ EasyServe.start servers_file: servers_file do |ez|
     end
   end
   
-  ez.local "simple-server" do |conn|
+  ez.local "simple-service" do |conn|
     log.progname = "parent process"
     log.info conn.read
     conn.write "hello from #{log.progname}"

data/examples/remote-multi-server.rb

@@ -15,7 +15,7 @@ unless address_there
     
     The 'hostname' may by any valid hostname or ssh alias.
 
-    If --tunnel is specified, use the ssh connection to tunnel the tupelo
+    If --tunnel is specified, use the ssh connection to tunnel the data
     traffic. Otherwise, just use tcp. (Always use ssh to start the remote
     process.)
 
@@ -27,10 +27,10 @@ EasyServe.start do |ez|
   log.level = Logger::INFO
   log.formatter = nil if $VERBOSE
 
-  ez.start_servers do
+  ez.start_services do
     host = tunnel ? "localhost" : nil # no need to expose port if tunnelled
 
-    ez.server "adder", :tcp, host, 0 do |svr|
+    ez.service "adder", :tcp, bind_host: host do |svr|
       Thread.new do
         loop do
           Thread.new(svr.accept) do |conn|
@@ -56,7 +56,7 @@ EasyServe.start do |ez|
       end
     end
 
-    ez.server "multiplier", :tcp, host, 0 do |svr|
+    ez.service "multiplier", :tcp, bind_host: host do |svr|
       Thread.new do
         loop do
           Thread.new(svr.accept) do |conn|

data/examples/remote-run.rb

@@ -15,7 +15,7 @@ unless addr_there
     
     The 'hostname' may by any valid hostname or ssh alias.
 
-    If --tunnel is specified, use the ssh connection to tunnel the tupelo
+    If --tunnel is specified, use the ssh connection to tunnel the data
     traffic. Otherwise, just use tcp. (Always use ssh to start the remote
     process.)
 
@@ -31,9 +31,9 @@ EasyServe.start do |ez|
   log.level = Logger::INFO
   log.formatter = nil if $VERBOSE
 
-  ez.start_servers do
+  ez.start_services do
     host = tunnel ? "localhost" : nil # no need to expose port if tunnelled
-    ez.server "simple-server", :tcp, host, 0 do |svr|
+    ez.service "simple-service", :tcp, bind_host: host do |svr|
       Thread.new do
         loop do
           Thread.new(svr.accept) do |conn|
@@ -50,7 +50,7 @@ EasyServe.start do |ez|
     end
   end
 
-  ez.remote "simple-server", host: addr_there, tunnel: tunnel,
+  ez.remote "simple-service", host: addr_there, tunnel: tunnel,
     dir: "/tmp",
     file: "remote-run-script.rb",
       # 'file' passed to load, so can be rel to dir or ruby's $LOAD_PATH

data/examples/simple.rb

@@ -1,13 +1,19 @@
 require 'easy-serve'
 
+if ARGV.delete("--tcp")
+  proto = :tcp
+else
+  proto = :unix
+end
+
 EasyServe.start do |ez|
   log = ez.log
   log.level = Logger::DEBUG
   log.formatter = nil if $VERBOSE
-  log.debug {"starting servers"}
+  log.debug {"starting services"}
     
-  ez.start_servers do
-    ez.server "simple-server", :unix do |svr|
+  ez.start_services do
+    ez.service "simple-service", proto do |svr|
       Thread.new do
         loop do
           conn = svr.accept
@@ -20,13 +26,13 @@ EasyServe.start do |ez|
     end
   end
   
-  ez.child "simple-server" do |conn|
+  ez.child "simple-service" do |conn|
     log.progname = "client 1"
     log.info conn.read
     conn.write "hello from #{log.progname}"
   end
   
-  ez.local "simple-server" do |conn|
+  ez.local "simple-service" do |conn|
     log.progname = "parent process"
     log.info conn.read
     conn.write "hello from #{log.progname}"

data/lib/easy-serve.rb

@@ -3,16 +3,10 @@ require 'socket'
 require 'yaml'
 require 'fileutils'
 
-class EasyServe
-  VERSION = "0.7"
+require 'easy-serve/service'
 
-  class Server
-    attr_reader :name, :pid, :addr
-    
-    def initialize name, pid, addr
-      @name, @pid, @addr = name, pid, addr
-    end
-  end
+class EasyServe
+  VERSION = "0.8"
   
   class EasyFormatter < Logger::Formatter
     Format = "%s: %s: %s\n"
@@ -35,10 +29,10 @@ class EasyServe
   end
 
   attr_accessor :log
-  attr_accessor :servers
+  attr_accessor :services
   attr_reader :children
   attr_reader :passive_children
-  attr_reader :servers_file
+  attr_reader :services_file
   attr_reader :interactive
   
   def self.start(log: default_logger, **opts)
@@ -52,37 +46,37 @@ class EasyServe
   end
 
   def initialize **opts
-    @servers_file = opts[:servers_file]
+    @services_file = opts[:services_file]
     @interactive = opts[:interactive]
     @log = opts[:log] || self.class.null_logger
     @children = [] # pid
     @passive_children = [] # pid
     @owner = false
     @tmpdir = nil
-    @servers = opts[:servers] # name => Server
+    @services = opts[:services] # name => service
     
-    unless servers
-      if servers_file
-        @servers =
+    unless services
+      if services_file
+        @services =
           begin
-            load_server_table
+            load_service_table
           rescue Errno::ENOENT
-            init_server_table
+            init_service_table
           end
       else
-        init_server_table
+        init_service_table
       end
     end
   end
 
-  def load_server_table
-    File.open(servers_file) do |f|
+  def load_service_table
+    File.open(services_file) do |f|
       YAML.load(f)
     end
   end
   
-  def init_server_table
-    @servers ||= begin
+  def init_service_table
+    @services ||= begin
       @owner = true
       {}
     end
@@ -113,20 +107,16 @@ class EasyServe
     end
     
     if @owner
-      servers.each do |name, server|
+      services.each do |name, service|
         log.info "stopping #{name}"
-        Process.kill "TERM", server.pid
-        Process.waitpid server.pid
-        if server.addr.kind_of? String
-          FileUtils.remove_entry server.addr
-        end
+        service.cleanup
       end
 
-      if servers_file
+      if services_file
         begin
-          FileUtils.rm servers_file
+          FileUtils.rm services_file
         rescue Errno::ENOENT
-          log.warn "servers file at #{servers_file.inspect} was deleted already"
+          log.warn "services file #{services_file.inspect} was deleted already"
         end
       end
     end
@@ -134,14 +124,14 @@ class EasyServe
     clean_tmpdir
   end
   
-  def start_servers
+  def start_services
     if @owner
-      log.debug {"starting servers"}
+      log.debug {"starting services"}
       yield
 
-      if servers_file
-        File.open(servers_file, "w") do |f|
-          YAML.dump(servers, f)
+      if services_file
+        File.open(services_file, "w") do |f|
+          YAML.dump(services, f)
         end
       end
     end
@@ -166,7 +156,7 @@ class EasyServe
     end
   end
 
-  def inc_socket_filename name
+  def self.bump_socket_filename name
     name =~ /-\d+\z/ ? name.succ : name + "-0"
   end
   
@@ -186,83 +176,49 @@ class EasyServe
     end
   end
   
-  def server name, proto = :unix, host = nil, port = nil
-    server_class, *server_addr =
-      case proto
-      when /unix/i; [UNIXServer, choose_socket_filename(name, base: host)]
-      when /tcp/i;  [TCPServer, host || host_name, port || 0]
-      else raise ArgumentError, "Unknown socket protocol: #{proto.inspect}"
-      end
+  MAX_TRIES = 10
 
-    rd, wr = IO.pipe
+  def service name, proto = nil, **opts
+    proto ||= opts.delete(:proto) || :unix
+    case proto
+    when :unix
+      opts[:path] ||= choose_socket_filename(name, base: opts[:base])
+
+    when :tcp
+      opts[:connect_host] ||=
+        case opts[:bind_host]
+        when nil, "0.0.0.0", /\A<any>\z/i
+          host_name ## maybe local connectors should use "localhost" ?
+        when "localhost", "127.0.0.1"
+          "localhost"
+        end
+    end
 
+    service = Service.for(name, proto, **opts)
+    rd, wr = IO.pipe
     pid = fork do
       rd.close
       log.progname = name
       log.info "starting"
-
-      svr = server_for(server_class, *server_addr)
+      
+      svr = service.serve(max_tries: MAX_TRIES, log: log)
       yield svr if block_given?
       no_interrupt_if_interactive
 
-      addr =
-        case proto
-        when /unix/i; svr.addr[1]
-        when /tcp/i; svr.addr(false).values_at(2,1)
-        end
-      Marshal.dump addr, wr
+      Marshal.dump service, wr
       wr.close
       sleep
     end
 
     wr.close
-    addr = Marshal.load rd
+    services[name] = Marshal.load rd
     rd.close
-    servers[name] = Server.new(name, pid, addr)
-  end
-
-  MAX_TRIES = 10
-
-  def server_for server_class, *server_addr
-    tries = 0
-    begin
-      server_class.new(*server_addr)
-    rescue Errno::EADDRINUSE => ex
-      if server_class == UNIXServer
-        if tries < MAX_TRIES
-          tries += 1
-          server_addr[0] = inc_socket_filename(server_addr[0])
-          log.warn {
-            "#{ex} -- trying again at path #{server_addr}, #{tries}/#{MAX_TRIES} times."
-          }
-          retry
-        end
-      elsif server_class == TCPServer
-        port = Integer(server_addr[1])
-        if port and tries < MAX_TRIES
-          tries += 1
-          port += 1
-          server_addr[1] = port
-          log.warn {
-            "#{ex} -- trying again at port #{port}, #{tries}/#{MAX_TRIES} times."
-          }
-          retry
-        end
-      else
-        raise ArgumentError, "unknown server_class: #{server_class.inspect}"
-      end
-      raise
-
-    rescue => ex
-      ex.message << "; addr=#{server_addr.inspect}"
-      raise
-    end
   end
 
   # A passive client child may be stopped after all active clients exit.
-  def child *server_names, passive: false
+  def child *service_names, passive: false
     c = fork do
-      conns = server_names.map {|sn| socket_for(*servers[sn].addr)}
+      conns = service_names.map {|sn| services[sn].connect}
       yield(*conns) if block_given?
       no_interrupt_if_interactive
     end
@@ -275,8 +231,8 @@ class EasyServe
     child *args, &block
   end
   
-  def local *server_names
-    conns = server_names.map {|sn| socket_for(*servers[sn].addr)}
+  def local *service_names
+    conns = service_names.map {|sn| services[sn].connect}
     yield(*conns) if block_given?
   ensure
     conns and conns.each do |conn|
@@ -285,20 +241,8 @@ class EasyServe
     log.info "stopped local client"
   end
   
-  def socket_for *addr
-    socket_class =
-      case addr.size
-      when 1; UNIXSocket
-      else TCPSocket
-      end
-    socket_class.new(*addr)
-  rescue => ex
-    ex.message << "; addr=#{addr.inspect}"
-    raise
-  end
-
   # ^C in the irb session (parent process) should not kill the
-  # server (child process)
+  # service (child process)
   def no_interrupt_if_interactive
     trap("INT") {} if interactive
   end

data/lib/easy-serve/accessible-services.rb

@@ -0,0 +1,34 @@
+class EasyServe
+  # Returns list of services that are accessible from +host+, setting
+  # up an ssh tunnel if specified. Note that OpenSSH 6.0 or later is required
+  # for the tunnel option.
+  def accessible_services host, tunnel: false
+    tcp_svs = services.values.grep(TCPService)
+    return tcp_svs unless tunnel and host != "localhost" and host != "127.0.0.1"
+
+    tcp_svs.map do |service|
+      service_host =
+        case service.bind_host
+        when nil, "localhost", "127.0.0.1", "0.0.0.0", /\A<any>\z/i
+          "localhost"
+        else
+          service.bind_host
+        end
+
+      fwd = "0:#{service_host}:#{service.port}"
+      out = `ssh -O forward -R #{fwd} #{host}`
+
+      begin
+        remote_port = Integer(out)
+      rescue
+        log.error "Unable to set up dynamic ssh port forwarding. " +
+          "Please check if ssh -v is at least 6.0."
+        raise
+      end
+
+      at_exit {system "ssh -O cancel -R #{fwd} #{host}"}
+
+      TCPService.new service.name, connect_host: "localhost", port: remote_port
+    end
+  end
+end

data/lib/easy-serve/remote-drb.rb

@@ -6,7 +6,7 @@ class EasyServe
   # It's up to you to start another thread inside the code block if you
   # want more concurrency. This is for convenience when testing (cases in which
   # concurrency needs to be controlled explicitly).
-  def remote_drb *server_names, host: nil
+  def remote_drb *service_names, host: nil
     ## remote logfile option?
 
     DRb.start_service("druby://#{host_name}:0", nil)
@@ -24,17 +24,17 @@ class EasyServe
           require 'yaml'
           require 'easy-serve'
           
-          server_names = #{server_names.inspect}
-          servers = YAML.load(#{YAML.dump(servers).inspect})
+          service_names = #{service_names.inspect}
+          services = YAML.load(#{YAML.dump(services).inspect})
           log_level = #{log.level}
           host_uri = #{host_uri.inspect}
           
-          EasyServe.start servers: servers do |ez|
+          EasyServe.start services: services do |ez|
             log = ez.log
             log.level = log_level
             log.formatter = nil if $VERBOSE
 
-            ez.local *server_names do |*conns|
+            ez.local *service_names do |*conns|
               begin
                 DRb.start_service(host_uri, {conns: conns})
                 puts DRb.uri

data/lib/easy-serve/remote-eval-mgr.rb

@@ -3,12 +3,14 @@ require 'easy-serve'
 
 def EasyServe.manage_remote_eval_client msg
   $VERBOSE = msg["verbose"]
-  server_names, servers_list, log_level, eval_string, host =
-    msg.values_at(*%w{server_names servers_list log_level eval_string host})
+  service_names, services_list, log_level, eval_string, host =
+    msg.values_at(*%w{service_names services_list log_level eval_string host})
 
-  servers = {}
-  servers_list.each do |name, pid, addr|
-    servers[name] = EasyServe::Server.new(name, pid, addr)
+  services = {}
+  service_names = Marshal.load(service_names)
+  services_list = Marshal.load(services_list)
+  services_list.each do |service|
+    services[service.name] = service
   end
   
   log_args = msg["log"]
@@ -22,12 +24,12 @@ def EasyServe.manage_remote_eval_client msg
       EasyServe.null_logger
     end
 
-  EasyServe.start servers: servers, log: log do |ez|
+  EasyServe.start services: services, log: log do |ez|
     log = ez.log
     log.level = log_level
     log.formatter = nil if $VERBOSE
 
-    ez.local *server_names do |*conns|
+    ez.local *service_names do |*conns|
       begin
         pr = eval "proc do |conns, host, log| #{eval_string}; end"
         pr[conns, host, log]
@@ -48,7 +50,7 @@ def EasyServe.handle_remote_eval_messages
   unpacker = MessagePack::Unpacker.new($stdin)
   unpacker.each do |msg|
     case
-    when msg["server_names"]
+    when msg["service_names"]
       Thread.new {manage_remote_eval_client(msg); exit}
     when msg["exit"]
       puts "exiting"

data/lib/easy-serve/remote-eval.rb

@@ -1,5 +1,5 @@
 require 'msgpack'
-require 'easy-serve/accessible-servers'
+require 'easy-serve/accessible-services'
 
 class EasyServe
   # useful simple cases in testing and in production, but long eval strings
@@ -13,7 +13,7 @@ class EasyServe
   #
   # 2. Log back over ssh: pass log: true.
   #
-  def remote_eval *server_names,
+  def remote_eval *service_names,
                   host: nil, passive: false, tunnel: false, **opts
     child_pid = fork do
       log.progname = "remote_eval #{host}"
@@ -26,17 +26,17 @@ class EasyServe
         "w+" do |ssh|
 
         ssh.sync = true
-        servers_list = accessible_servers(host, tunnel: tunnel)
+        services_list = accessible_services(host, tunnel: tunnel)
 
         MessagePack.pack(
           {
-            verbose:      $VERBOSE,
-            server_names: server_names,
-            servers_list: servers_list,
-            log_level:    log.level,
-            eval_string:  opts[:eval],
-            host:         host,
-            log:          opts[:log]
+            verbose:        $VERBOSE,
+            service_names:  Marshal.dump(service_names),
+            services_list:  Marshal.dump(services_list),
+            log_level:      log.level,
+            eval_string:    opts[:eval],
+            host:           host,
+            log:            opts[:log]
           },
           ssh)
 

data/lib/easy-serve/remote-run-mgr.rb

@@ -3,15 +3,17 @@ require 'easy-serve'
 
 def EasyServe.manage_remote_run_client msg
   $VERBOSE = msg["verbose"]
-  server_names, servers_list, log_level, host, dir, file, class_name, args =
+  service_names, services_list, log_level, host, dir, file, class_name, args =
     msg.values_at(*%w{
-      server_names servers_list log_level host
+      service_names services_list log_level host
       dir file class_name args
     })
 
-  servers = {}
-  servers_list.each do |name, pid, addr|
-    servers[name] = EasyServe::Server.new(name, pid, addr)
+  services = {}
+  service_names = Marshal.load(service_names)
+  services_list = Marshal.load(services_list)
+  services_list.each do |service|
+    services[service.name] = service
   end
   
 ### opt for tmpdir and send files to it via ssh
@@ -29,12 +31,12 @@ def EasyServe.manage_remote_run_client msg
       EasyServe.null_logger
     end
 
-  EasyServe.start servers: servers, log: log do |ez|
+  EasyServe.start services: services, log: log do |ez|
     log = ez.log
     log.level = log_level
     log.formatter = nil if $VERBOSE
 
-    ez.local *server_names do |*conns|
+    ez.local *service_names do |*conns|
       begin
         cl = Object.const_get(class_name)
         ro = cl.new(conns, host, log, *args)
@@ -56,7 +58,7 @@ def EasyServe.handle_remote_run_messages
   unpacker = MessagePack::Unpacker.new($stdin)
   unpacker.each do |msg|
     case
-    when msg["server_names"]
+    when msg["service_names"]
       Thread.new {manage_remote_run_client(msg); exit}
     when msg["exit"]
       puts "exiting"

data/lib/easy-serve/remote-run.rb

@@ -1,5 +1,5 @@
 require 'msgpack'
-require 'easy-serve/accessible-servers'
+require 'easy-serve/accessible-services'
 
 class EasyServe
   # useful in production, though it requires remote lib files to be set up.
@@ -12,7 +12,7 @@ class EasyServe
   #
   # 2. Log back over ssh: pass log: true.
   #
-  def remote_run *server_names, host: nil, passive: false, tunnel: false, **opts
+  def remote_run *service_names, host: nil, passive: false, tunnel: false, **opts
     child_pid = fork do
       log.progname = "remote_run #{host}"
 
@@ -24,20 +24,20 @@ class EasyServe
         "w+" do |ssh|
 
         ssh.sync = true
-        servers_list = accessible_servers(host, tunnel: tunnel)
+        services_list = accessible_services(host, tunnel: tunnel)
 
         MessagePack.pack(
           {
-            verbose:      $VERBOSE,
-            server_names: server_names,
-            servers_list: servers_list,
-            log_level:    log.level,
-            host:         host,
-            dir:          opts[:dir],
-            file:         opts[:file],
-            class_name:   opts[:class_name],
-            args:         opts[:args],
-            log:          opts[:log]
+            verbose:        $VERBOSE,
+            service_names:  Marshal.dump(service_names),
+            services_list:  Marshal.dump(services_list),
+            log_level:      log.level,
+            host:           host,
+            dir:            opts[:dir],
+            file:           opts[:file],
+            class_name:     opts[:class_name],
+            args:           opts[:args],
+            log:            opts[:log]
           },
           ssh)
 

data/lib/easy-serve/remote.rb

@@ -3,20 +3,20 @@ require 'easy-serve'
 class EasyServe
   class RemoteError < RuntimeError; end
 
-  def remote *server_names, host: nil, **opts
+  def remote *service_names, host: nil, **opts
     raise ArgumentError, "no host specified" unless host
 
     if opts[:eval]
       require 'easy-serve/remote-eval'
-      remote_eval(*server_names, host: host, **opts)
+      remote_eval(*service_names, host: host, **opts)
 
     elsif opts[:file]
       require 'easy-serve/remote-run'
-      remote_run(*server_names, host: host, **opts)
+      remote_run(*service_names, host: host, **opts)
 
     elsif block_given?
       require 'easy-serve/remote-drb'
-      remote_drb(*server_names, host: host, **opts, &Proc.new)
+      remote_drb(*service_names, host: host, **opts, &Proc.new)
 
     else
       raise ArgumentError, "cannot select remote mode based on arguments"

data/lib/easy-serve/service.rb

@@ -0,0 +1,125 @@
+class EasyServe
+  # Refers to a named service. Use the #serve method to start the service.
+  # Encapsulates current location and identity, including pid and address. A
+  # Service object can be serialized to a remote process so it can #connect to
+  # the service. 
+  class Service
+    attr_reader :name
+    attr_reader :pid
+
+    SERVICE_CLASS = {}
+
+    def self.for name, proto, **opts
+      sc = SERVICE_CLASS[proto] or
+        raise ArgumentError, "Unknown socket protocol: #{proto.inspect}"
+      sc.new name, **opts
+    end
+
+    def initialize name
+      @name = name
+    end
+
+    # Returns the client socket.
+    def connect
+      try_connect
+    rescue => ex
+      ex.message << "; #{inspect}"
+      raise
+    end
+
+    # Returns the server socket.
+    def serve max_tries: 1, log: (raise ArgumentError, "missing log")
+      tries = 1
+      begin
+        try_serve.tap do
+          @pid = Process.pid
+        end
+
+      rescue Errno::EADDRINUSE => ex
+        raise if tries >= max_tries
+        log.warn {"#{ex}; #{inspect} (#{tries}/#{max_tries} tries)"}
+        tries += 1; bump!
+        log.info {"Trying: #{inspect}"}
+        retry
+      end
+    rescue => ex
+      ex.message << "; #{inspect}"
+      raise
+    end
+
+    def cleanup
+      Process.kill "TERM", pid
+      Process.waitpid pid
+    end
+  end
+
+  class UNIXService < Service
+    SERVICE_CLASS[:unix] = self
+
+    attr_reader :path
+    
+    def initialize name, path: nil
+      super name
+      @path = path
+    end
+
+    def serve max_tries: 1, log: log
+      super.tap do |svr|
+        found_path = svr.addr[1]
+        log.debug "#{inspect} is listening at #{found_path}"
+      
+        if found_path != path
+          log.error "Unexpected path: #{found_path} != #{path}"
+        end
+      end
+    end
+
+    def cleanup
+      super
+      FileUtils.remove_entry path if path
+    end
+
+    def try_connect
+      UNIXSocket.new(path)
+    end
+
+    def try_serve
+      UNIXServer.new(path)
+    end
+
+    def bump!
+      @path = EasyServe.bump_socket_filename(path)
+    end
+  end
+
+  class TCPService < Service
+    SERVICE_CLASS[:tcp] = self
+
+    attr_reader :bind_host, :connect_host, :port
+
+    def initialize name, bind_host: nil, connect_host: nil, port: 0
+      super name
+      @bind_host, @connect_host, @port = bind_host, connect_host, port
+    end
+
+    def serve max_tries: 1, log: log
+      super.tap do |svr|
+        found_addr = svr.addr(false).values_at(2,1)
+        log.debug "#{inspect} is listening at #{found_addr.join(":")}"
+        @port = found_addr[1]
+      end
+    end
+
+    def try_connect
+      TCPSocket.new(connect_host, port)
+    end
+
+    def try_serve
+      TCPServer.new(bind_host, port)
+    end
+
+    def bump!
+      @port += 1 unless port == 0 # should not happen
+    end
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: easy-serve
 version: !ruby/object:Gem::Version
-  version: '0.7'
+  version: '0.8'
 platform: ruby
 authors:
 - Joel VanderWerf
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-12-15 00:00:00.000000000 Z
+date: 2013-12-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: msgpack
@@ -24,8 +24,8 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-description: Framework for starting tcp/unix servers and connected clients under one
-  parent process and on remote hosts.
+description: Framework for starting tcp/unix services and connected clients under
+  one parent process and on remote hosts.
 email: vjoel@users.sourceforge.net
 executables: []
 extensions: []
@@ -35,24 +35,25 @@ extra_rdoc_files:
 files:
 - README.md
 - COPYING
-- lib/easy-serve/remote.rb
+- lib/easy-serve.rb
+- lib/easy-serve/remote-eval-mgr.rb
 - lib/easy-serve/remote-run.rb
 - lib/easy-serve/remote-drb.rb
-- lib/easy-serve/accessible-servers.rb
-- lib/easy-serve/remote-run-mgr.rb
-- lib/easy-serve/remote-eval-mgr.rb
+- lib/easy-serve/remote.rb
+- lib/easy-serve/accessible-services.rb
 - lib/easy-serve/remote-eval.rb
-- lib/easy-serve.rb
-- examples/remote-run.rb
-- examples/remote-multi-server.rb
-- examples/passive.rb
+- lib/easy-serve/remote-run-mgr.rb
+- lib/easy-serve/service.rb
+- examples/simple.rb
+- examples/remote-manual.rb
+- examples/multi.rb
 - examples/remote-eval-passive.rb
+- examples/remote-run.rb
 - examples/remote-drb.rb
+- examples/remote-multi-server.rb
 - examples/remote-run-script.rb
-- examples/multi.rb
-- examples/remote-manual.rb
-- examples/simple.rb
 - examples/remote-eval.rb
+- examples/passive.rb
 homepage: https://github.com/vjoel/easy-serve
 licenses:
 - BSD
@@ -83,7 +84,7 @@ rubyforge_project:
 rubygems_version: 2.1.11
 signing_key: 
 specification_version: 4
-summary: Framework for starting tcp/unix servers and connected clients under one parent
-  process and on remote hosts
+summary: Framework for starting tcp/unix services and connected clients under one
+  parent process and on remote hosts
 test_files: []
 has_rdoc: 

data/lib/easy-serve/accessible-servers.rb

@@ -1,29 +0,0 @@
-class EasyServe
-  # Returns list of [name, pid, addr] that are accessible from host, setting
-  # up ssh tunnel if specified. Note that OpenSSH 6.0 or later is required
-  # for the tunnel option.
-  def accessible_servers host, tunnel: false
-    if tunnel and host != "localhost" and host != "127.0.0.1"
-      servers.map do |n, s|
-        _, local_port = s.addr
-        fwd = "0:localhost:#{local_port}"
-        out = `ssh -O forward -R #{fwd} #{host}`
-
-        begin
-          remote_port = Integer(out)
-        rescue
-          log.error "Unable to set up dynamic ssh port forwarding. " +
-            "Please check if ssh -v is at least 6.0."
-          raise
-        end
-
-        at_exit {system "ssh -O cancel -R #{fwd} #{host}"}
-
-        [s.name, s.pid, ["localhost", remote_port]]
-      end
-
-    else
-      servers.map {|n, s| [s.name, s.pid, s.addr]}
-    end
-  end
-end