Control

Close the control port connection.

# File lib/mongrel2/control.rb, line 160
def close
        self.socket.close
end

Returns an Array of Hashes, one for each connection to the server.

Example:

[
  {:id=>9, :fd=>27, :type=>1, :last_ping=>0, :last_read=>0, :last_write=>0,
   :bytes_read=>319, :bytes_written=>1065}
]

# File lib/mongrel2/control.rb, line 133
def conn_status
        self.request( :status, :what => 'net' )
end

Shuts down the control port permanently in case you want to keep it from being accessed for some reason.

# File lib/mongrel2/control.rb, line 154
def control_stop
        self.request( :control_stop )
end

Return an Array of Hashes, one for each command the server supports.

Example:

[
  {:name=>"stop", :help=>"stop the server (SIGINT)"},
  {:name=>"reload", :help=>"reload the server"},
  {:name=>"help", :help=>"this command"},
  {:name=>"control_stop", :help=>"stop control port"},
  {:name=>"kill", :help=>"kill a connection"},
  {:name=>"status", :help=>"status, what=['net'|'tasks']"},
  {:name=>"terminate", :help=>"terminate the server (SIGTERM)"},
  {:name=>"time", :help=>"the server's time"},
  {:name=>"uuid", :help=>"the server's uuid"},
  {:name=>"info", :help=>"information about this server"}
]

# File lib/mongrel2/control.rb, line 81
def help
        self.request( :help )
end

Return information about the server.

Example:

[{:port=>7337,
  :bind_addr=>"0.0.0.0",
  :uuid=>"28F6DCCF-28EB-48A4-A5B0-ED71D224FAE0",
  :chroot=>"/var/www",
  :access_log=>"/var/www/logs/admin-access.log",
  :error_log=>"/logs/admin-error.log",
  :pid_file=>"./run/admin.pid",
  :default_hostname=>"localhost"}]

# File lib/mongrel2/control.rb, line 106
def info
        self.request( :info )
end

Does a forced close on the socket that is at the specified conn_id.

# File lib/mongrel2/control.rb, line 147
def kill( conn_id )
        self.request( :kill, :id => conn_id )
end

Reloads the server using a SIGHUP. Returns a hash with a ':msg' key that describes what happened on success.

# File lib/mongrel2/control.rb, line 53
def reload
        self.request( :reload )
end

Stops the server using a SIGINT. Returns a hash with a ':msg' key that describes what happened on success.

# File lib/mongrel2/control.rb, line 46
def stop
        self.request( :stop )
end

Returns an Array of Hashes, one for each currently running task.

Example:

[
  {:id=>1, :system=>false, :name=>"SERVER", :state=>"read fd", :status=>"idle"},
  {:id=>2, :system=>false, :name=>"Handler_task", :state=>"read handler", :status=>"idle"},
  {:id=>3, :system=>false, :name=>"control", :state=>"read handler", :status=>"running"},
  {:id=>4, :system=>false, :name=>"ticker", :state=>"", :status=>"idle"},
  {:id=>5, :system=>true, :name=>"fdtask", :state=>"yield", :status=>"ready"}
]

# File lib/mongrel2/control.rb, line 121
def tasklist
        self.request( :status, :what => 'tasks' )
end

Terminates the server with SIGTERM. Returns a hash with a ':msg' key that describes what happened on success.

# File lib/mongrel2/control.rb, line 61
def terminate
        self.request( :terminate )
end

Returns the server's time as a Time object.

# File lib/mongrel2/control.rb, line 139
def time
        response = self.request( :time )
        return nil if response.empty?
        return Time.at( response.first[:time].to_i )
end

Returns the server’s UUID as a String.

Example:

[{:uuid=>"28F6DCCF-28EB-48A4-A5B0-ED71D224FAE0"}]

# File lib/mongrel2/control.rb, line 90
def uuid
        self.request( :uuid )
end