Class: Minecraft

Inherits:

Object

• Object
• Minecraft

Defined in:

lib/minecraft.rb

Defined Under Namespace

Classes: HistoryQueue, MessageQueue, ServerNotRunningError, StartupFailedError

Instance Attribute Summary

• #server_pid ⇒ Object readonly

  Returns the value of attribute server_pid.

Instance Method Summary

• #command(cmd) ⇒ Object
• #error(msg) ⇒ Object
• #history ⇒ Object
• #initialize(cmd, options = {}) ⇒ Minecraft constructor

  A new instance of Minecraft.

• #list ⇒ Object
• #log(msg) ⇒ Object
• #method_missing(m, *args) ⇒ Object
• #running? ⇒ Boolean
• #save_all ⇒ Object
• #start ⇒ Object
• #stop ⇒ Object
• #with_message_collector(collector, &operations) ⇒ Object

Constructor Details

#initialize(cmd, options = {}) ⇒ Minecraft

Returns a new instance of Minecraft.

# File 'lib/minecraft.rb', line 105

def initialize(cmd, options = {})
  @cmd = cmd
  @in_queue = Queue.new
  @message_queue = MessageQueue.new

  @startup_timeout = (options[:startup_timeout] or 120)
  @command_timeout = (options[:command_timeout] or 40)

  @server_pid = nil

  @collector = nil
end

Dynamic Method Handling

This class handles dynamic methods through the method_missing method

#method_missing(m, *args) ⇒ Object

# File 'lib/minecraft.rb', line 242

def method_missing(m, *args)
  command(([m.to_s.tr('_', '-')] + args).join(' '))
end

Instance Attribute Details

#server_pid ⇒ Object (readonly)

Returns the value of attribute server_pid.

# File 'lib/minecraft.rb', line 118

def server_pid
  @server_pid
end

Instance Method Details

#command(cmd) ⇒ Object

Raises:

• (ServerNotRunningError)

# File 'lib/minecraft.rb', line 246

def command(cmd)
  raise ServerNotRunningError unless running?
  @in_queue << "#{cmd}\n"
  if block_given?
    yield 
  else
    active_wait
  end
end

#error(msg) ⇒ Object

# File 'lib/minecraft.rb', line 143

def error(msg)
  @message_queue.error(msg)
end

#history ⇒ Object

# File 'lib/minecraft.rb', line 256

def history
  @message_queue.history
end

#list ⇒ Object

# File 'lib/minecraft.rb', line 236

def list
  command('list') do
    wait_msg{|m| m.msg =~ /Connected players:/}
  end
end

#log(msg) ⇒ Object

# File 'lib/minecraft.rb', line 139

def log(msg)
  @message_queue.log(msg)
end

#running? ⇒ Boolean

Returns:

• (Boolean)

# File 'lib/minecraft.rb', line 135

def running?
  @out_reader and @in_writter.alive?
end

#save_all ⇒ Object

# File 'lib/minecraft.rb', line 228

def save_all
  command('save-all') do
    time_operation("Save") do
      wait_msg{|m| m.msg =~ /Save complete/}
    end
  end
end

#start ⇒ Object

# File 'lib/minecraft.rb', line 147

def start
  if running?
    log "Server already running"
  else
    time_operation("Server start") do
      begin
        log "Starting minecraft: #{@cmd}"

        pid, @stdin, @stdout, @stderr = Spawn::spawn(@cmd)
        @server_pid = pid

        log "Started server process with pid: #{@server_pid}"

        @in_writter = Thread.new do
          begin
            loop do
              msg = @in_queue.pop
              @stdin.write(msg)
            end
          rescue IOError, Errno::EPIPE
          end
        end

        @err_reader = Thread.new do
          begin
            @stderr.each do |line|
              @message_queue.err(line.strip)
            end
          rescue IOError
          end
        end

        @out_reader = Thread.new do
          begin
            @stdout.each do |line|
              @message_queue.out(line.strip)
            end
          rescue IOError
          ensure
            @in_writter.kill
            @err_reader.kill

            @stdin.close unless @stdin.closed?
            @stderr.close unless @stderr.closed?
            @stdout.close unless @stdout.closed?

            log "Minecraft exits"
          end
        end

        wait_msg(false, @startup_timeout) do |m|
          m.msg =~ /Done \(([^n]*)ns\)!/ or m.msg =~ /Minecraft exits/
        end

        unless running?
          Process.wait(@server_pid)
          @server_pid = nil
          raise StartupFailedError, @cmd 
        end
      rescue Errno::ENOENT
        raise StartupFailedError, @cmd 
      end
    end
  end
end

#stop ⇒ Object

# File 'lib/minecraft.rb', line 213

def stop
  unless running?
    log "Server already stopped"
  else
    command('stop') do
      time_operation("Server stop") do
        wait_msg{|m| m.msg == "Minecraft exits"}
        Process.wait(@server_pid)
        @server_pid = nil
        log "Server stopped"
      end
    end
  end
end

#with_message_collector(collector, &operations) ⇒ Object

# File 'lib/minecraft.rb', line 120

def with_message_collector(collector, &operations)
  @message_queue.flush
  @collector = collector
  begin
    instance_eval &operations
  rescue Timeout::Error
    error "Command timed out"
  ensure
    @message_queue.flush do |msg|
      collect(msg)
    end
    @collector = nil
  end
end