class PhusionPassenger::ClassicRails::FrameworkSpawner

Starting it synchronously with AbstractServer#start_synchronously has not been tested.
Note: FrameworkSpawner may only be started asynchronously with AbstractServer#start.
FrameworkSpawner uses ApplicationSpawner internally.
RoR versions, use multiple FrameworkSpawner instances.
that you spawn through it must require the same RoR version. To handle multiple
framework version. So be careful when using FrameworkSpawner: the applications
A single FrameworkSpawner instance can only hold a single Ruby on Rails
before spawning the application instances.
quickly. This is done by preloading the Ruby on Rails framework into memory,
This class is capable of spawning Ruby on Rails application instances

def before_fork # :nodoc:

:nodoc:
Overrided method.
def before_fork # :nodoc:
	if GC.copy_on_write_friendly?
		# Garbage collect now so that the child process doesn't have to
		# do that (to prevent making pages dirty).
		GC.start
	end
end

def finalize_server # :nodoc:

:nodoc:
Overrided method.
def finalize_server # :nodoc:
	@spawners.cleanup
end

def handle_reload(client, app_group_name = nil)

def handle_reload(client, app_group_name = nil)
	@spawners.synchronize do
		if app_group_name
			@spawners.delete(app_group_name)
		else
			@spawners.clear
		end
	end
end

def handle_spawn_application(client, *options)

def handle_spawn_application(client, *options)
	app_process = nil
	options = sanitize_spawn_options(Hash[*options])
	app_group_name = options["app_group_name"]
	@spawners.synchronize do
		begin
			spawner = @spawners.lookup_or_add(app_group_name) do
				spawner = ApplicationSpawner.new(@options.merge(options))
				if options["app_spawner_timeout"] && options["app_spawner_timeout"] != -1
					spawner.max_idle_time = options["app_spawner_timeout"]
				end
				spawner.start
				spawner
			end
		rescue InvalidPath, AppInitError, ApplicationSpawner::Error => e
			client.write('exception')
			client.write_scalar(marshal_exception(e))
			if e.respond_to?(:child_exception) && e.child_exception.is_a?(LoadError)
				# A source file failed to load, maybe because of a
				# missing gem. If that's the case then the sysadmin
				# will install probably the gem. So we clear RubyGems's
				# cache so that it can detect new gems.
				Gem.clear_paths
			end
			return
		end
		begin
			app_process = spawner.spawn_application(options)
		rescue ApplicationSpawner::Error => e
			spawner.stop
			@spawners.delete(app_group_name)
			client.write('exception')
			client.write_scalar(marshal_exception(e))
			return
		end
	end
	client.write('success')
	app_process.write_to_channel(client)
ensure
	app_process.close if app_process
end

def initialize(options = {})

then restart the server by calling AbstractServer#stop and AbstractServer#start.
of the FrameworkSpawner server. If you wish to reload the Rails framework's code,
Note that the specified Rails framework will be loaded during the entire life time

All other options will be passed on to ApplicationSpawner and RequestHandler.

this version is actually installed.
- framework_version: The Ruby on Rails version to use. It is not checked whether
Extra supported options:

Creates a new instance of FrameworkSpawner.
def initialize(options = {})
	if !options.respond_to?(:'[]')
		raise ArgumentError, "The 'options' argument does not seem to be an options hash"
	end
	@framework_version = options["framework_version"]
	if options.has_key?("print_framework_loading_exceptions")
		@print_framework_loading_exceptions = options["print_framework_loading_exceptions"]
	else
		@print_framework_loading_exceptions = true
	end
	if !@framework_version
		raise ArgumentError, "The 'framework_version' option must specified"
	end
	
	super()
	@options = options
	self.max_idle_time = DEFAULT_FRAMEWORK_SPAWNER_MAX_IDLE_TIME
	define_message_handler(:spawn_application, :handle_spawn_application)
	define_message_handler(:reload, :handle_reload)
end

def initialize_server # :nodoc:

:nodoc:
Overrided method.
def initialize_server # :nodoc:
	$0 = "Passenger FrameworkSpawner: #{@framework_version}"
	@spawners = AbstractServerCollection.new
	channel = MessageChannel.new(@owner_socket)
	begin
		preload_rails
	rescue StandardError, ScriptError, NoMemoryError => e
		channel.write('exception')
		channel.write_scalar(marshal_exception(e))
		return
	end
	channel.write('success')
end

def preload_rails

def preload_rails
	Object.const_set(:RAILS_ROOT, ".")
	gem 'rails', "=#{@framework_version}"
	require 'initializer'
	require 'active_support'
	require 'active_record'
	require 'action_controller'
	require 'action_view'
	require 'action_pack'
	require 'action_mailer'
	require 'dispatcher'
	begin
		if ::Rails::VERSION::MAJOR >= 2
			require 'active_resource'
		else
			require 'action_web_service'
		end
		require 'ruby_version_check'
		require 'active_support/whiny_nil'
	rescue NameError
		# Rails < 1.1
		require 'action_web_service'
	end
	Object.send(:remove_const, :RAILS_ROOT)
end

def reload(app_group_name = nil)

- FrameworkSpawner::Error: The FrameworkSpawner server exited unexpectedly.
Raises:

code will be freshly loaded into memory.
that the next time an application instance is spawned, the application
This method makes sure that any cached application code is removed, so
application, such as after deploying a new version of the application.
once it a while, it will be necessary to reload the code for an
Application code might be cached in memory by a FrameworkSpawner. But
Long description:

instances will be removed, no matter the group name.
If nil is specified as group name, then all cached application
Remove the cached application instances at the given group name.
def reload(app_group_name = nil)
	connect do |channel|
		if app_group_name.nil?
			channel.write("reload")
		else
			channel.write("reload", app_group_name)
		end
	end
rescue SystemCallError, IOError, SocketError
	raise Error, "The framework spawner server exited unexpectedly: #{e}"
end

def spawn_application(options = {})

- FrameworkSpawner::Error: The FrameworkSpawner server exited unexpectedly.
- ApplicationSpawner::Error: The ApplicationSpawner server exited unexpectedly.
- AppInitError: The application raised an exception or called exit() during startup.
- AbstractServer::ServerNotStarted: The FrameworkSpawner server hasn't already been started.
Raises:

- Reload the application by calling reload with the correct app_root argument.
- Restart this FrameworkSpawner by calling AbstractServer#stop, then AbstractServer#start.
the application's code, you must do one of these things:
speed up future spawning attempts. This implies that, if you've changed
FrameworkSpawner will internally cache the code of applications, in order to

All options accepted by ApplicationSpawner.new and RequestHandler.new are accepted.

the spawned RoR application.
When successful, an Application object will be returned, which represents
version associated with this FrameworkSpawner.
Spawn a RoR application using the Ruby on Rails framework
def spawn_application(options = {})
	app_root = options["app_root"]
	options = sanitize_spawn_options(options)
	options["app_root"] = app_root
	# No need for the ApplicationSpawner to print exceptions. All
	# exceptions raised by the ApplicationSpawner are sent back here,
	# so we just need to decide here whether we want to print it.
	print_exceptions = options["print_exceptions"]
	options["print_exceptions"] = false
	
	begin
		connect do |channel|
			channel.write("spawn_application", *options.to_a.flatten)
			result = channel.read
			if result.nil?
				raise IOError, "Connection closed"
			end
			if result[0] == 'exception'
				e = unmarshal_exception(channel.read_scalar)
				if print_exceptions && e.respond_to?(:child_exception) && e.child_exception
					print_exception(self.class.to_s, e.child_exception)
				elsif print_exceptions
					print_exception(self.class.to_s, e)
				end
				raise e
			else
				return AppProcess.read_from_channel(channel)
			end
		end
	rescue SystemCallError, IOError, SocketError => e
		raise Error, "The framework spawner server exited unexpectedly: #{e}"
	end
end

def start

- FrameworkSpawner::Error: The FrameworkSpawner server exited unexpectedly.
- FrameworkInitError: An error occurred while loading the specified Ruby on Rails framework.
May raise these additional exceptions:

Overrided from AbstractServer#start.
def start
	super
	begin
		channel = MessageChannel.new(@owner_socket)
		result = channel.read
		if result.nil?
			raise Error, "The framework spawner server exited unexpectedly."
		else
			status = result[0]
		end
		if status == 'exception'
			child_exception = unmarshal_exception(channel.read_scalar)
			stop
			message = "Could not load Ruby on Rails framework version #{@framework_version}: " <<
				"#{child_exception.class} (#{child_exception.message})"
			options = { :version => @framework_version }
			if @print_framework_loading_exceptions
				print_exception(self.class.to_s, child_exception)
			end
			raise FrameworkInitError.new(message, child_exception, options)
		end
	rescue IOError, SystemCallError, SocketError => e
		stop if started?
		raise Error, "The framework spawner server exited unexpectedly: #{e}"
	rescue
		stop if started?
		raise
	end
end