From dc35925eb0aa9a499986403788b893697e44fd98 Mon Sep 17 00:00:00 2001 From: jvelilla Date: Mon, 6 Apr 2015 12:24:47 -0300 Subject: [PATCH] Added Missing Class and feature descriptions. Removed author entry. --- .../examples/demo/application_execution.e | 1 - .../demo/autocompletion/contact_autocompletion.e | 1 - .../demo/autocompletion/flag_autocompletion.e | 1 - .../demo/autocompletion/google_autocompletion.e | 1 - .../server/wsf_js_widget/examples/demo/base_page.e | 1 - .../wsf_js_widget/examples/demo/codeview_page.e | 1 - .../examples/demo/googlenews/google_news.e | 1 - .../demo/googlenews/google_news_datasource.e | 1 - .../examples/demo/googlenews/google_news_repeater.e | 1 - .../server/wsf_js_widget/examples/demo/grid_page.e | 1 - .../wsf_js_widget/examples/demo/own_validator.e | 1 - .../demo/progress/increasing_progresssource.e | 1 - .../wsf_js_widget/examples/demo/repeater_page.e | 1 - .../wsf_js_widget/examples/demo/sample_page.e | 1 - .../wsf_js_widget/examples/demo/slider_page.e | 1 - .../wsf_js_widget/examples/demo/upload_page.e | 1 - .../concurrency/scoop/httpd_connection_handler.e | 7 +++++++ .../src/httpd/httpd_connection_handler_i.e | 1 + .../standalone/src/httpd/httpd_request_handler_i.e | 13 +++++++++++-- .../connectors/standalone/test_standalone-safe.ecf | 8 ++++++-- library/server/wsf/src/wsf_execution.e | 6 ++++-- 21 files changed, 29 insertions(+), 22 deletions(-) diff --git a/draft/library/server/wsf_js_widget/examples/demo/application_execution.e b/draft/library/server/wsf_js_widget/examples/demo/application_execution.e index b0582128..564f5c85 100644 --- a/draft/library/server/wsf_js_widget/examples/demo/application_execution.e +++ b/draft/library/server/wsf_js_widget/examples/demo/application_execution.e @@ -1,6 +1,5 @@ note description: "Summary description for {APPLICATION_EXECUTION}." - author: "" date: "$Date$" revision: "$Revision$" diff --git a/draft/library/server/wsf_js_widget/examples/demo/autocompletion/contact_autocompletion.e b/draft/library/server/wsf_js_widget/examples/demo/autocompletion/contact_autocompletion.e index 20382b1a..2bf5fc7f 100644 --- a/draft/library/server/wsf_js_widget/examples/demo/autocompletion/contact_autocompletion.e +++ b/draft/library/server/wsf_js_widget/examples/demo/autocompletion/contact_autocompletion.e @@ -1,6 +1,5 @@ note description: "Summary description for {CONTACT_AUTOCOMPLETION}." - author: "" date: "$Date$" revision: "$Revision$" diff --git a/draft/library/server/wsf_js_widget/examples/demo/autocompletion/flag_autocompletion.e b/draft/library/server/wsf_js_widget/examples/demo/autocompletion/flag_autocompletion.e index f7ff00a3..18fb6d74 100644 --- a/draft/library/server/wsf_js_widget/examples/demo/autocompletion/flag_autocompletion.e +++ b/draft/library/server/wsf_js_widget/examples/demo/autocompletion/flag_autocompletion.e @@ -1,6 +1,5 @@ note description: "Summary description for {FLAG_AUTOCOMPLETION}." - author: "" date: "$Date$" revision: "$Revision$" diff --git a/draft/library/server/wsf_js_widget/examples/demo/autocompletion/google_autocompletion.e b/draft/library/server/wsf_js_widget/examples/demo/autocompletion/google_autocompletion.e index 8ff832a9..95403ae2 100644 --- a/draft/library/server/wsf_js_widget/examples/demo/autocompletion/google_autocompletion.e +++ b/draft/library/server/wsf_js_widget/examples/demo/autocompletion/google_autocompletion.e @@ -1,6 +1,5 @@ note description: "Summary description for {GOOGLE_AUTOCOMPLETION}." - author: "" date: "$Date$" revision: "$Revision$" diff --git a/draft/library/server/wsf_js_widget/examples/demo/base_page.e b/draft/library/server/wsf_js_widget/examples/demo/base_page.e index 672df4f1..33ea23ff 100644 --- a/draft/library/server/wsf_js_widget/examples/demo/base_page.e +++ b/draft/library/server/wsf_js_widget/examples/demo/base_page.e @@ -1,6 +1,5 @@ note description: "Summary description for {BASE_PAGE}." - author: "" date: "$Date$" revision: "$Revision$" diff --git a/draft/library/server/wsf_js_widget/examples/demo/codeview_page.e b/draft/library/server/wsf_js_widget/examples/demo/codeview_page.e index 68b51521..b2ef9849 100644 --- a/draft/library/server/wsf_js_widget/examples/demo/codeview_page.e +++ b/draft/library/server/wsf_js_widget/examples/demo/codeview_page.e @@ -1,6 +1,5 @@ note description: "Summary description for {CODEVIEW_PAGE}." - author: "" date: "$Date$" revision: "$Revision$" diff --git a/draft/library/server/wsf_js_widget/examples/demo/googlenews/google_news.e b/draft/library/server/wsf_js_widget/examples/demo/googlenews/google_news.e index 11386b42..18cc5ce6 100644 --- a/draft/library/server/wsf_js_widget/examples/demo/googlenews/google_news.e +++ b/draft/library/server/wsf_js_widget/examples/demo/googlenews/google_news.e @@ -1,6 +1,5 @@ note description: "Summary description for {GOOGLE_NEWS}." - author: "" date: "$Date$" revision: "$Revision$" diff --git a/draft/library/server/wsf_js_widget/examples/demo/googlenews/google_news_datasource.e b/draft/library/server/wsf_js_widget/examples/demo/googlenews/google_news_datasource.e index 8c4b0de1..07019133 100644 --- a/draft/library/server/wsf_js_widget/examples/demo/googlenews/google_news_datasource.e +++ b/draft/library/server/wsf_js_widget/examples/demo/googlenews/google_news_datasource.e @@ -1,6 +1,5 @@ note description: "Summary description for {GOOGLE_NEWS_DATASOURCE}." - author: "" date: "$Date$" revision: "$Revision$" diff --git a/draft/library/server/wsf_js_widget/examples/demo/googlenews/google_news_repeater.e b/draft/library/server/wsf_js_widget/examples/demo/googlenews/google_news_repeater.e index b5631025..c3b4813c 100644 --- a/draft/library/server/wsf_js_widget/examples/demo/googlenews/google_news_repeater.e +++ b/draft/library/server/wsf_js_widget/examples/demo/googlenews/google_news_repeater.e @@ -1,6 +1,5 @@ note description: "Summary description for {GOOGLE_NEWS_REPEATER}." - author: "" date: "$Date$" revision: "$Revision$" diff --git a/draft/library/server/wsf_js_widget/examples/demo/grid_page.e b/draft/library/server/wsf_js_widget/examples/demo/grid_page.e index 124f31ff..09119d67 100644 --- a/draft/library/server/wsf_js_widget/examples/demo/grid_page.e +++ b/draft/library/server/wsf_js_widget/examples/demo/grid_page.e @@ -1,6 +1,5 @@ note description: "Summary description for {GRID_PAGE}." - author: "" date: "$Date$" revision: "$Revision$" diff --git a/draft/library/server/wsf_js_widget/examples/demo/own_validator.e b/draft/library/server/wsf_js_widget/examples/demo/own_validator.e index b0a0b3b9..bb0dda47 100644 --- a/draft/library/server/wsf_js_widget/examples/demo/own_validator.e +++ b/draft/library/server/wsf_js_widget/examples/demo/own_validator.e @@ -1,6 +1,5 @@ note description: "Summary description for {OWN_VALIDATOR}." - author: "" date: "$Date$" revision: "$Revision$" diff --git a/draft/library/server/wsf_js_widget/examples/demo/progress/increasing_progresssource.e b/draft/library/server/wsf_js_widget/examples/demo/progress/increasing_progresssource.e index 1881abe0..f7ed2011 100644 --- a/draft/library/server/wsf_js_widget/examples/demo/progress/increasing_progresssource.e +++ b/draft/library/server/wsf_js_widget/examples/demo/progress/increasing_progresssource.e @@ -1,6 +1,5 @@ note description: "Summary description for {INCREASING_PROGRESSSOURCE}." - author: "" date: "$Date$" revision: "$Revision$" diff --git a/draft/library/server/wsf_js_widget/examples/demo/repeater_page.e b/draft/library/server/wsf_js_widget/examples/demo/repeater_page.e index 3af98551..02e88c36 100644 --- a/draft/library/server/wsf_js_widget/examples/demo/repeater_page.e +++ b/draft/library/server/wsf_js_widget/examples/demo/repeater_page.e @@ -1,6 +1,5 @@ note description: "Summary description for {REPEATER_PAGE}." - author: "" date: "$Date$" revision: "$Revision$" diff --git a/draft/library/server/wsf_js_widget/examples/demo/sample_page.e b/draft/library/server/wsf_js_widget/examples/demo/sample_page.e index 1febf1fe..4797b42c 100644 --- a/draft/library/server/wsf_js_widget/examples/demo/sample_page.e +++ b/draft/library/server/wsf_js_widget/examples/demo/sample_page.e @@ -1,6 +1,5 @@ note description: "Summary description for {SAMPLE_PAGE}." - author: "" date: "$Date$" revision: "$Revision$" diff --git a/draft/library/server/wsf_js_widget/examples/demo/slider_page.e b/draft/library/server/wsf_js_widget/examples/demo/slider_page.e index aa3abff5..448aca56 100644 --- a/draft/library/server/wsf_js_widget/examples/demo/slider_page.e +++ b/draft/library/server/wsf_js_widget/examples/demo/slider_page.e @@ -1,6 +1,5 @@ note description: "Summary description for {SLIDER_PAGE}." - author: "" date: "$Date$" revision: "$Revision$" diff --git a/draft/library/server/wsf_js_widget/examples/demo/upload_page.e b/draft/library/server/wsf_js_widget/examples/demo/upload_page.e index 6c125136..454fdd15 100644 --- a/draft/library/server/wsf_js_widget/examples/demo/upload_page.e +++ b/draft/library/server/wsf_js_widget/examples/demo/upload_page.e @@ -1,6 +1,5 @@ note description: "Summary description for {UPLOAD_PAGE}." - author: "" date: "$Date$" revision: "$Revision$" diff --git a/library/server/ewsgi/connectors/standalone/src/httpd/concurrency/scoop/httpd_connection_handler.e b/library/server/ewsgi/connectors/standalone/src/httpd/concurrency/scoop/httpd_connection_handler.e index 25b458ab..0b28c038 100644 --- a/library/server/ewsgi/connectors/standalone/src/httpd/concurrency/scoop/httpd_connection_handler.e +++ b/library/server/ewsgi/connectors/standalone/src/httpd/concurrency/scoop/httpd_connection_handler.e @@ -31,6 +31,8 @@ feature {NONE} -- Initialization end initialize_pool (p: like pool; n: INTEGER) + -- Initialize pool of separate connection handlers. + --| set the pool capacity to n. do p.set_count (n) end @@ -49,6 +51,7 @@ feature -- Access feature {HTTPD_SERVER_I} -- Execution shutdown + -- do if not is_shutdown_requested then is_shutdown_requested := True @@ -57,11 +60,13 @@ feature {HTTPD_SERVER_I} -- Execution end pool_gracefull_stop (p: like pool) + -- Graceful stop pool of separate connection handlers. do p.gracefull_stop end accept_incoming_connection (a_listening_socket: HTTPD_STREAM_SOCKET) + -- do accept_connection_on_pool (pool, a_listening_socket) -- Wait on not pool.is_full or is_stop_requested end @@ -92,6 +97,7 @@ feature {HTTPD_SERVER_I} -- Execution end process_handler (hdl: separate HTTPD_REQUEST_HANDLER) + -- Process request handler `hdl' with exclusive access. require hdl.is_connected do @@ -99,6 +105,7 @@ feature {HTTPD_SERVER_I} -- Execution end separate_client_socket (hdl: separate HTTPD_REQUEST_HANDLER): separate HTTPD_STREAM_SOCKET + -- Separate client socket from a request handler `hdl'. do Result := hdl.client_socket end diff --git a/library/server/ewsgi/connectors/standalone/src/httpd/httpd_connection_handler_i.e b/library/server/ewsgi/connectors/standalone/src/httpd/httpd_connection_handler_i.e index 017e2a69..fa89d1fa 100644 --- a/library/server/ewsgi/connectors/standalone/src/httpd/httpd_connection_handler_i.e +++ b/library/server/ewsgi/connectors/standalone/src/httpd/httpd_connection_handler_i.e @@ -79,6 +79,7 @@ feature {NONE} -- Implementation end separate_server_log (a_server: like server; a_message: separate READABLE_STRING_8) + -- Separete log from a server `a_server' with message `a_message'. do a_server.log (a_message) end diff --git a/library/server/ewsgi/connectors/standalone/src/httpd/httpd_request_handler_i.e b/library/server/ewsgi/connectors/standalone/src/httpd/httpd_request_handler_i.e index bf526b93..67b327cd 100644 --- a/library/server/ewsgi/connectors/standalone/src/httpd/httpd_request_handler_i.e +++ b/library/server/ewsgi/connectors/standalone/src/httpd/httpd_request_handler_i.e @@ -1,6 +1,5 @@ note - description: "Summary description for {HTTPD_REQUEST_HANDLER_I}." - author: "" + description: "Represent a handler interface for components that process HTTP requests." date: "$Date$" revision: "$Revision$" @@ -117,13 +116,17 @@ feature -- Status report feature -- Change set_is_verbose (b: BOOLEAN) + -- Set `is_verbose' with `b'. do is_verbose := b + ensure + is_verbose_set: is_verbose = b end feature -- Execution safe_execute + -- Execute incoming request. local retried: BOOLEAN do @@ -194,6 +197,8 @@ feature -- Execution dbglog (generator + ".execute_request socket=" + l_socket.descriptor.out + " ENTER") end l_socket.set_timeout (5) -- 5 seconds! + --| TODO: add configuration options for socket timeout. + --| set by default 5 seconds. l_ready_for_reading := l_socket.ready_for_reading if l_ready_for_reading then create l_remote_info @@ -364,11 +369,15 @@ feature -- Output logger: detachable HTTPD_LOGGER set_logger (a_logger: like logger) + -- Set `logger' with `a_logger'. do logger := a_logger + ensure + logger_set: logger = a_logger end log (m: STRING) + -- Log message `m'. do if attached logger as l_logger then l_logger.log (m) diff --git a/library/server/ewsgi/connectors/standalone/test_standalone-safe.ecf b/library/server/ewsgi/connectors/standalone/test_standalone-safe.ecf index 4bb190b4..d6c14438 100644 --- a/library/server/ewsgi/connectors/standalone/test_standalone-safe.ecf +++ b/library/server/ewsgi/connectors/standalone/test_standalone-safe.ecf @@ -10,8 +10,12 @@ - - + + + + diff --git a/library/server/wsf/src/wsf_execution.e b/library/server/wsf/src/wsf_execution.e index 79c69336..36d5d7d4 100644 --- a/library/server/wsf/src/wsf_execution.e +++ b/library/server/wsf/src/wsf_execution.e @@ -1,6 +1,5 @@ note - description: "Summary description for {WSF_EXECUTION}." - author: "" + description: "Object that represent a request execution with request and response. " date: "$Date$" revision: "$Revision$" @@ -75,6 +74,7 @@ feature -- Status report feature -- Helpers put_character (c: CHARACTER_8) + -- Send the character `c'. require message_writable: message_writable do @@ -82,6 +82,7 @@ feature -- Helpers end put_string (s: READABLE_STRING_8) + -- Send the string `s'. require message_writable: message_writable do @@ -89,6 +90,7 @@ feature -- Helpers end put_error (err: READABLE_STRING_8) + -- Report error described by `a_message'. require message_writable: message_writable do