Contents

#
# Author:: R.J.Sharp
# Email:: robert(a)osburn-sharp.ath.cx
# Copyright:: Copyright (c) 2011 
# License:: Open Software Licence v3.0
#
# This software is licensed for use under the Open Software Licence v. 3.0
# The terms of this licence can be found at http://www.opensource.org/licenses/osl-3.0.php
# and in the file LICENCE. Under the terms of this licence, all derivative works
# must themselves be licensed under the Open Software Licence v. 3.0
#
# 
require 'jerbil/jerbil_service/base'
require 'jerbil/jerbil_service/support'
require 'jerbil/support'
require 'jerbil/config'

# pull in things to do with jeeves

require 'jeeves/listings'
require 'jeeves/store'
require 'jeeves/tags'
require 'jeeves/config'
require 'jeeves/errors'

#
# == Jeeves Service
#
# Synopsis of the whole service
#
module Jeeves

  # add generic class methods
  extend JerbilService::Support

  # === Jeeves Service class
  #
  # Description of how the service class works
  #
  # class Service < JerbilService::Base
  # 
  #   # Document the constructor as required.
  #   #
  #   # pkey:: string - private key that must be used for
  #   #        supervision calls (e.g. stop_callback)
  #   # options:: hash of options, preferably as created by Jeckyl. See documentation
  #   #           on JerbilService::Base for assumed options re logging etc
  #   #
  #   def initialize(pkey, options)
  # 
  #     # do things that cannot be done when $SAFE > 0
  # 
  #     # the symbol should be the app name and must correspond to a service in /etc/services
  #     super(:jeeves, pkey, options)
  # 
  #     # DRb is now working, this process may have daemonized and $SAFE = 1
  # 
  #   end
  # 
  #   #
  #   # define additional class methods to make things happen
  #   #
  # 
  #   # do not redefine the superclass methods unless you are absolutely sure you know
  #   # what you are doing.
  # 
  # end
end

Version data entries

1 entries across 1 versions & 1 rubygems

Version	Path
jeeves-pvr-0.2.0	lib/jeeves.rb