Updated various indexing notes.

Removed a few obsolete classes. Cosmetics
2015-05-06 22:15:46 +02:00
parent 9e1083eba8
commit 8246bc1444
92 changed files with 300 additions and 1066 deletions
@@ -1,6 +1,7 @@
 note
-	description: "Summary description for {HTTPD_CONNECTION_HANDLER}."
-	author: ""
+	description: "[
+			Implementation of HTTPD_CONNECTION_HANDLER_I for concurrency mode: none
+		]"
 	date: "$Date$"
 	revision: "$Revision$"

@@ -29,7 +30,7 @@ feature -- Access
 			Result := a_server.controller.shutdown_requested
 		end

-feature -- Execution
+feature {HTTPD_SERVER_I} -- Execution

 	accept_incoming_connection (a_listening_socket: HTTPD_STREAM_SOCKET)
 		local
@@ -1,6 +1,5 @@
 note
-	description: "Summary description for {HTTPD_REQUEST_HANDLER_FACTORY}."
-	author: ""
+	description: "Implementation of request handler factory for concurrency mode: none"
 	date: "$Date$"
 	revision: "$Revision$"

@@ -1,5 +1,7 @@
 note
-	description: "Summary description for {HTTPD_CONNECTION_HANDLER}."
+	description: "[
+			Implementation of HTTPD_CONNECTION_HANDLER_I for concurrency mode: SCOOP
+		]"
 	date: "$Date$"
 	revision: "$Revision$"

@@ -36,8 +38,10 @@ feature {NONE} -- Initialization
 feature -- Access

 	is_shutdown_requested: BOOLEAN
+			-- <Precursor>

 	max_concurrent_connections (a_server: like server): INTEGER
+			-- Max concurrent connection settings from server `a_server'.
 		do
 			Result := a_server.configuration.max_concurrent_connections
 		end
@@ -87,11 +91,6 @@ feature {HTTPD_SERVER_I} -- Execution
 			end
 		end

-	separate_client_socket (hdl: separate HTTPD_REQUEST_HANDLER): separate HTTPD_STREAM_SOCKET
-		do
-			Result := hdl.client_socket
-		end
-
 	process_handler (hdl: separate HTTPD_REQUEST_HANDLER)
 		require
 			hdl.is_connected
@@ -99,22 +98,28 @@ feature {HTTPD_SERVER_I} -- Execution
 			hdl.safe_execute
 		end

+	separate_client_socket (hdl: separate HTTPD_REQUEST_HANDLER): separate HTTPD_STREAM_SOCKET
+		do
+			Result := hdl.client_socket
+		end
+
 feature {HTTPD_SERVER_I} -- Status report

 	wait_for_completion
-			-- Wait until Current is ready for shutdown
+			-- Wait until Current is ready for shutdown.
 		do
 			wait_for_pool_completion (pool)
 		end

 	wait_for_pool_completion (p: like pool)
+			-- Wait until concurrent pool is empty and terminated.
 		require
-			p.is_empty
+			p.is_empty -- SCOOP wait condition.
 		do
 			p.terminate
 		end

-feature {NONE} -- Access
+feature {NONE} -- Implementation

 	pool: separate CONCURRENT_POOL [HTTPD_REQUEST_HANDLER]
 			-- Pool of separate connection handlers.
@@ -1,6 +1,5 @@
 note
-	description: "Summary description for {HTTPD_REQUEST_HANDLER_FACTORY}."
-	author: ""
+	description: "Implementation of request handler factory for concurrency mode: SCOOP"
 	date: "$Date$"
 	revision: "$Revision$"

@@ -1,6 +1,5 @@
 note
-	description: "Summary description for {CONCURRENT_POOL}."
-	author: ""
+	description: "Concurrent pool for SCOOP concurrency mode."
 	date: "$Date$"
 	revision: "$Revision$"

@@ -19,7 +18,6 @@ feature {NONE} -- Initialization
 		do
 			capacity := n
 			create items.make_empty (n)
--			create busy_items.make_filled (False, n)
 			create busy_items.make_empty (n)
 		end

@@ -1,6 +1,5 @@
 note
-	description: "Summary description for {CONCURRENT_POOL_FACTORY}."
-	author: ""
+	description: "Factory in charge of creating new concurrent pool item."
 	date: "$Date$"
 	revision: "$Revision$"

@@ -1,6 +1,8 @@
 note
-	description: "Summary description for {CONCURRENT_POOL_ITEM}."
-	author: ""
+	description: "[
+			Item create by the CONCURRENT_POOL_FACTORY, and managed by the CONCURRENT_POOL 
+			for SCOOP concurrency mode.
+		]"
 	date: "$Date$"
 	revision: "$Revision$"

@@ -10,10 +12,12 @@ deferred class
 feature	{NONE} -- Access

 	pool: detachable separate CONCURRENT_POOL [CONCURRENT_POOL_ITEM]
+			-- Associated concurrent pool component.

 feature {CONCURRENT_POOL} -- Change

 	set_pool (p: like pool)
+			-- Set associated `pool' to `p'.
 		do
 			pool := p
 		end
@@ -1,6 +1,7 @@
 note
-	description: "Summary description for {HTTPD_CONNECTION_HANDLER}."
-	author: ""
+	description: "[
+			Implementation of HTTPD_CONNECTION_HANDLER_I for concurrency mode: Thread
+		]"
 	date: "$Date$"
 	revision: "$Revision$"

@@ -1,6 +1,5 @@
 note
-	description: "Summary description for {HTTPD_REQUEST_HANDLER_FACTORY}."
-	author: ""
+	description: "Implementation of request handler factory for concurrency mode: Thread"
 	date: "$Date$"
 	revision: "$Revision$"

@@ -1,5 +1,5 @@
 note
-	description: "Summary description for {HTTPD_CONFIGURATION_I}."
+	description: "Configuration for the standalone HTTPd server."
 	date: "$Date$"
 	revision: "$Revision$"

@@ -24,6 +24,7 @@ feature {NONE} -- Initialization
 feature -- Access

 	Server_details: STRING_8
+			-- Detail of the server.
 		deferred
 		end

@@ -1,6 +1,12 @@
 note
-	description: "Summary description for {HTTPD_CONNECTION_HANDLER_I}."
-	author: ""
+	description: "[
+			Interface for the incoming connection handler.
+
+			Each incoming socket connection is processed by 
+			an implementation of HTTPD_CONNECTION_HANDLER_I.
+
+			Note there are 3 implementations, one for each concurrent mode: none, thread, scoop.
+		]"
 	date: "$Date$"
 	revision: "$Revision$"

@@ -23,41 +29,40 @@ feature {NONE} -- Initialization
 		deferred
 		end

-	separate_factory (a_server: like server): like factory
-			-- Separate factory from `a_server'.
-			--| required by SCOOP design.
-		do
-			Result := a_server.factory
-		end
-
 feature {NONE} -- Access

 	factory: separate HTTPD_REQUEST_HANDLER_FACTORY
+			-- Request handler factory.

 	server: separate HTTPD_SERVER_I
+			-- Associated server.

 feature {HTTPD_SERVER_I} -- Execution

 	accept_incoming_connection (a_listening_socket: HTTPD_STREAM_SOCKET)
+			-- Accept incoming connection from `a_listening_socket'.
 		deferred
 		end

 	shutdown
+			-- Shutdown server.
 		deferred
 		end

 	wait_for_completion
-			-- Wait until Current completed any pending task
+			-- Wait until Current completed any pending task.
+			--| Used for SCOOP synchronisation.
 		deferred
 		end

 feature {HTTPD_SERVER} -- Status report

 	is_shutdown_requested: BOOLEAN
+			-- Any request to shutdown the server?
 		deferred
 		end

-feature {NONE} -- Output
+feature {NONE} -- Implementation

 	log (a_message: separate READABLE_STRING_8)
 			-- Log `a_message'
@@ -66,6 +71,13 @@ feature {NONE} -- Output
 			separate_server_log (server, a_message)
 		end

+	separate_factory (a_server: like server): like factory
+			-- Separate factory from `a_server'.
+			--| required by SCOOP design.
+		do
+			Result := a_server.factory
+		end
+
 	separate_server_log (a_server: like server; a_message: separate READABLE_STRING_8)
 		do
 			a_server.log (a_message)
@@ -1,6 +1,8 @@
 note
-	description: "Summary description for {HTTPD_CONTROLLER}."
-	author: ""
+	description: "[
+			Object used to control (i.e shutdown) the server.
+			Mostly needed in SCOOP concurrency mode.
+		]"
 	date: "$Date$"
 	revision: "$Revision$"

@@ -10,11 +12,15 @@ class
 feature -- Operation

 	shutdown
+			-- Request the associated server to be shutdown.
 		do
 			shutdown_requested := True
 		end

+feature -- Status report.		
+
 	shutdown_requested: BOOLEAN
+			-- Shutdown requested.

 ;note
 	copyright: "2011-2013, Javier Velilla, Jocelyn Fiat and others"
@@ -1,6 +1,5 @@
 note
-	description: "Summary description for {HTTPD_DEBUG_FACILITIES}."
-	author: ""
+	description: " Routines used for debug logging."
 	date: "$Date$"
 	revision: "$Revision$"

@@ -1,6 +1,5 @@
 note
-	description: "Summary description for {HTTPD_LOGGER}."
-	author: ""
+	description: "Logging facilities component"
 	date: "$Date$"
 	revision: "$Revision$"

@@ -1,6 +1,5 @@
 note
 	description: "Summary description for {HTTPD_SERVER_OBSERVER}."
-	author: ""
 	date: "$Date$"
 	revision: "$Revision$"

@@ -10,14 +9,18 @@ deferred class
 feature -- Event

 	on_launched (a_port: INTEGER)
+			-- Associated server launched listening on port `a_port'.
 		deferred
 		end

 	on_stopped
+			-- Associated server stopped.
+			--| the server may restart itself after being rescued.
 		deferred
 		end

 	on_terminated
+			-- Associated server terminated.
 		deferred
 		end

@@ -1,5 +1,5 @@
 note
-	description: "Summary description for {HTTPD_CONFIGURATION}."
+	description: "Standalone server configuration (ssl NOT supported)."
 	date: "$Date$"
 	revision: "$Revision$"

@@ -14,7 +14,7 @@ create

 feature -- Status

-	Server_details: STRING_8 = "Server : NINO Eiffel Server"
+	Server_details: STRING_8 = "Server: Standalone Eiffel Server"

 	has_ssl_support: BOOLEAN = False
 			-- Precursor
@@ -1,5 +1,5 @@
 note
-	description: "Summary description for {HTTPD_CONFIGURATION}."
+	description: "Standalone server configuration (ssl supported)."
 	date: "$Date$"
 	revision: "$Revision$"

@@ -25,7 +25,7 @@ feature {NONE} -- Initialization

 feature -- Access

-	Server_details: STRING_8 = "Server : NINO Eiffel Server (https)"
+	Server_details: STRING_8 = "Server: Standalone Eiffel Server (https)"

 	has_ssl_support: BOOLEAN = True
 			-- Precursor		
@@ -1,6 +1,5 @@
 note
-	description: "Summary description for {SSL_TCP_STREAM_SOCKET}."
-	author: ""
+	description: "SSL tcp stream socket."
 	date: "$Date$"
 	revision: "$Revision$"