Class Engine
In: lib/engine/engine.rb
Parent: Object
Engine Singleton dot/f_17.png

The Engine class sets up the server, polls it regularly and observes acceptor for incoming connections.

Methods

graceful_shutdown   handle_signal   new   run   update  

Included Modules

Singleton

Attributes

db  [R] 
eventmgr  [R] 
shutdown  [RW] 
world  [R] 

Public Class methods

new()

Create the an engine.

return
A handle to the engine.

[Source]

# File lib/engine/engine.rb, line 42
  def initialize
    # Display options
    log.debug "Configuration: #{options.inspect}"
    @shutdown = false
    if options['trace']
      set_trace_func proc { |event, file, line, id, binding, classname|
        if file !~ /\/usr\/lib\/ruby/
          printf "%8s %s:%-2d %10s %8s\n", event, file, line, id, classname
        end
      }
    end
  end

Public Instance methods

graceful_shutdown()

[Source]

# File lib/engine/engine.rb, line 129
  def graceful_shutdown
    @world.shutdown
    @server.stop
    log.info "Saving world..."
    @db.save
    @db.close
    exit
  end
handle_signal(sig)

Setup traps - invoke one of these signals to shut down the mud

[Source]

# File lib/engine/engine.rb, line 124
  def handle_signal(sig)
    log.warn "Signal caught request to shutdown."
    graceful_shutdown
  end
run()

main loop to run engine.

note:@shutdown never set by anyone yet

[Source]

# File lib/engine/engine.rb, line 57
  def run
    case options['dbtype']
    when :yaml
      require 'storage/yamlstore'
      @db = YamlStore.new(options['dbfile'])
    when :xml
      require 'storage/xmlstore'
      @db = XmlStore.new(options['dbfile'])
    when :gdbm
      require 'storage/gdbmstore'
      @db = GdbmStore.new(options['dbfile'])
    when :sdbm
      require 'storage/sdbmstore'
      @db = SdbmStore.new(options['dbfile'])
    when :dbm
      require 'storage/dbmstore'
      @db = DbmStore.new(options['dbfile'])
    when :sqlite
      require 'storage/sqlitestore'
      @db = SqliteStore.new(options['dbfile'])
    when :sqlite3
      require 'storage/sqlite3store'
      @db = Sqlite3Store.new(options['dbfile'])
    else
      log.fatal "Invalid 'dbtype' in Configuration"
      raise RunTimeError
    end

    # Get the world object
    @world = @db.get(0)
#    log.debug @world.inspect
    @db.makenoswap(0)
    @world.startup

    @eventmgr = EventManager.new
    log.info "Booting server on port #{options['server_port'] || 4000}"
    @server = Reactor.new(options['server_port'] || 4000,
      options['server_type'], options['server_io'],
      options['server_negotiation'], options['server_filters'],
      address=nil)

    raise "Unable to start server" unless @server.start(self)
    log.info "TMUD is ready"

    Signal.trap("INT", method(:handle_signal))
    Signal.trap("TERM", method(:handle_signal))
    Signal.trap("KILL", method(:handle_signal))
    until @shutdown
      @server.poll(0.3)
      @eventmgr.process_events
    end # until
    graceful_shutdown
  rescue
    log.fatal "Engine failed in run"
    log.fatal $!
  end
update(newconn)

Update is called by an acceptor passing us a new session. We create an incoming object and set it and the connection to watch each other.

[Source]

# File lib/engine/engine.rb, line 116
  def update(newconn)
    inc = Account.new(newconn)
    # Observe each other
    newconn.subscribe(inc)
    inc.subscribe(newconn)
  end

[Validate]