lib/mogilefs/client.rb

   1 require 'mogilefs/backend'
   2
   3 ##
   4 # MogileFS::Client is the MogileFS client base class.  Concrete clients like
   5 # MogileFS::MogileFS and MogileFS::Admin are implemented atop this one to do
   6 # real work.
   7
   8 class MogileFS::Client
   9
  10   ##
  11   # The backend connection for this client
  12
  13   attr_reader :backend
  14
  15   attr_accessor :hosts if defined? $TESTING
  16
  17   ##
  18   # Creates a new Client.  See MogileFS::Backend#initialize for how to specify
  19   # hosts.  If :readonly is set to true, the client will not modify anything
  20   # on the server.
  21   #
  22   #   MogileFS::Client.new :hosts => ['kaa:6001', 'ziz:6001'], :readonly => true
  23
  24   def initialize(args)
  25     @hosts = args[:hosts]
  26     @readonly = args[:readonly] ? true : false
  27     @timeout = args[:timeout]
  28
  29     reload
  30   end
  31
  32   ##
  33   # Creates a new MogileFS::Backend.
  34
  35   def reload
  36     @backend = MogileFS::Backend.new :hosts => @hosts, :timeout => @timeout
  37   end
  38
  39   ##
  40   # The last error reported by the backend.
  41   #--
  42   # TODO use Exceptions
  43
  44   def err
  45     @backend.lasterr
  46   end
  47
  48   ##
  49   # The last error message reported by the backend.
  50   #--
  51   # TODO use Exceptions
  52
  53   def errstr
  54     @backend.lasterrstr
  55   end
  56
  57   ##
  58   # Is this a read-only client?
  59
  60   def readonly?
  61     return @readonly
  62   end
  63
  64 end
  65