Added Missing Class and feature descriptions.

Removed author entry.
This commit is contained in:
jvelilla
2015-04-06 12:24:47 -03:00
committed by Jocelyn Fiat
parent a1a620a9c3
commit dc35925eb0
21 changed files with 29 additions and 22 deletions

View File

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

View File

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

View File

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

View File

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

View File

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

View File

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

View File

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

View File

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

View File

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

View File

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

View File

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

View File

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

View File

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

View File

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

View File

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

View File

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

View File

@@ -31,6 +31,8 @@ feature {NONE} -- Initialization
end end
initialize_pool (p: like pool; n: INTEGER) initialize_pool (p: like pool; n: INTEGER)
-- Initialize pool of separate connection handlers.
--| set the pool capacity to n.
do do
p.set_count (n) p.set_count (n)
end end
@@ -49,6 +51,7 @@ feature -- Access
feature {HTTPD_SERVER_I} -- Execution feature {HTTPD_SERVER_I} -- Execution
shutdown shutdown
-- <Precursor>
do do
if not is_shutdown_requested then if not is_shutdown_requested then
is_shutdown_requested := True is_shutdown_requested := True
@@ -57,11 +60,13 @@ feature {HTTPD_SERVER_I} -- Execution
end end
pool_gracefull_stop (p: like pool) pool_gracefull_stop (p: like pool)
-- Graceful stop pool of separate connection handlers.
do do
p.gracefull_stop p.gracefull_stop
end end
accept_incoming_connection (a_listening_socket: HTTPD_STREAM_SOCKET) accept_incoming_connection (a_listening_socket: HTTPD_STREAM_SOCKET)
-- <Precursor>
do do
accept_connection_on_pool (pool, a_listening_socket) -- Wait on not pool.is_full or is_stop_requested accept_connection_on_pool (pool, a_listening_socket) -- Wait on not pool.is_full or is_stop_requested
end end
@@ -92,6 +97,7 @@ feature {HTTPD_SERVER_I} -- Execution
end end
process_handler (hdl: separate HTTPD_REQUEST_HANDLER) process_handler (hdl: separate HTTPD_REQUEST_HANDLER)
-- Process request handler `hdl' with exclusive access.
require require
hdl.is_connected hdl.is_connected
do do
@@ -99,6 +105,7 @@ feature {HTTPD_SERVER_I} -- Execution
end end
separate_client_socket (hdl: separate HTTPD_REQUEST_HANDLER): separate HTTPD_STREAM_SOCKET separate_client_socket (hdl: separate HTTPD_REQUEST_HANDLER): separate HTTPD_STREAM_SOCKET
-- Separate client socket from a request handler `hdl'.
do do
Result := hdl.client_socket Result := hdl.client_socket
end end

View File

@@ -79,6 +79,7 @@ feature {NONE} -- Implementation
end end
separate_server_log (a_server: like server; a_message: separate READABLE_STRING_8) 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 do
a_server.log (a_message) a_server.log (a_message)
end end

View File

@@ -1,6 +1,5 @@
note note
description: "Summary description for {HTTPD_REQUEST_HANDLER_I}." description: "Represent a handler interface for components that process HTTP requests."
author: ""
date: "$Date$" date: "$Date$"
revision: "$Revision$" revision: "$Revision$"
@@ -117,13 +116,17 @@ feature -- Status report
feature -- Change feature -- Change
set_is_verbose (b: BOOLEAN) set_is_verbose (b: BOOLEAN)
-- Set `is_verbose' with `b'.
do do
is_verbose := b is_verbose := b
ensure
is_verbose_set: is_verbose = b
end end
feature -- Execution feature -- Execution
safe_execute safe_execute
-- Execute incoming request.
local local
retried: BOOLEAN retried: BOOLEAN
do do
@@ -194,6 +197,8 @@ feature -- Execution
dbglog (generator + ".execute_request socket=" + l_socket.descriptor.out + " ENTER") dbglog (generator + ".execute_request socket=" + l_socket.descriptor.out + " ENTER")
end end
l_socket.set_timeout (5) -- 5 seconds! 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 l_ready_for_reading := l_socket.ready_for_reading
if l_ready_for_reading then if l_ready_for_reading then
create l_remote_info create l_remote_info
@@ -364,11 +369,15 @@ feature -- Output
logger: detachable HTTPD_LOGGER logger: detachable HTTPD_LOGGER
set_logger (a_logger: like logger) set_logger (a_logger: like logger)
-- Set `logger' with `a_logger'.
do do
logger := a_logger logger := a_logger
ensure
logger_set: logger = a_logger
end end
log (m: STRING) log (m: STRING)
-- Log message `m'.
do do
if attached logger as l_logger then if attached logger as l_logger then
l_logger.log (m) l_logger.log (m)

View File

@@ -10,8 +10,12 @@
<library name="base" location="$ISE_LIBRARY\library\base\base-safe.ecf"/> <library name="base" location="$ISE_LIBRARY\library\base\base-safe.ecf"/>
<library name="connector_standalone" location="standalone-safe.ecf" readonly="false"/> <library name="connector_standalone" location="standalone-safe.ecf" readonly="false"/>
<library name="ewsgi" location="..\..\ewsgi-safe.ecf" readonly="false"/> <library name="ewsgi" location="..\..\ewsgi-safe.ecf" readonly="false"/>
<library name="httpd_EDIT" location="src\httpd\httpd-safe.ecf" readonly="false"/> <library name="httpd_edit" location="src\httpd\httpd-safe.ecf" readonly="false">
<library name="net_ssl_EDIT" location="$ISE_LIBRARY\unstable\library\network\socket\netssl\net_ssl-safe.ecf" readonly="false"/> <option debug="true">
<debug name="dbglog" enabled="true"/>
</option>
</library>
<library name="net_ssl_edit" location="$ISE_LIBRARY\unstable\library\network\socket\netssl\net_ssl-safe.ecf" readonly="false"/>
<library name="wsf" location="..\..\..\wsf\wsf-safe.ecf" readonly="false"/> <library name="wsf" location="..\..\..\wsf\wsf-safe.ecf" readonly="false"/>
<cluster name="tests" location="tests\" recursive="true"/> <cluster name="tests" location="tests\" recursive="true"/>
</target> </target>

View File

@@ -1,6 +1,5 @@
note note
description: "Summary description for {WSF_EXECUTION}." description: "Object that represent a request execution with request and response. "
author: ""
date: "$Date$" date: "$Date$"
revision: "$Revision$" revision: "$Revision$"
@@ -75,6 +74,7 @@ feature -- Status report
feature -- Helpers feature -- Helpers
put_character (c: CHARACTER_8) put_character (c: CHARACTER_8)
-- Send the character `c'.
require require
message_writable: message_writable message_writable: message_writable
do do
@@ -82,6 +82,7 @@ feature -- Helpers
end end
put_string (s: READABLE_STRING_8) put_string (s: READABLE_STRING_8)
-- Send the string `s'.
require require
message_writable: message_writable message_writable: message_writable
do do
@@ -89,6 +90,7 @@ feature -- Helpers
end end
put_error (err: READABLE_STRING_8) put_error (err: READABLE_STRING_8)
-- Report error described by `a_message'.
require require
message_writable: message_writable message_writable: message_writable
do do