Skip to content

Commit fffa763

Browse files
committed
Updated a few comments.
1 parent d015c06 commit fffa763

File tree

6 files changed

+22
-26
lines changed

6 files changed

+22
-26
lines changed

library/server/ewsgi/connectors/standalone/src/httpd/concurrency/scoop/httpd_connection_handler.e

Lines changed: 4 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -31,8 +31,7 @@ feature {NONE} -- Initialization
3131
end
3232

3333
initialize_pool (p: like pool; n: INTEGER)
34-
-- Initialize pool of separate connection handlers.
35-
--| set the pool capacity to n.
34+
-- Initialize Concurrent pool of `n' potential separate connection handlers.
3635
do
3736
p.set_count (n)
3837
end
@@ -60,7 +59,7 @@ feature {HTTPD_SERVER_I} -- Execution
6059
end
6160

6261
pool_gracefull_stop (p: like pool)
63-
-- Graceful stop pool of separate connection handlers.
62+
-- Graceful stop concurrent pool of separate connection handlers.
6463
do
6564
p.gracefull_stop
6665
end
@@ -97,7 +96,7 @@ feature {HTTPD_SERVER_I} -- Execution
9796
end
9897

9998
process_handler (hdl: separate HTTPD_REQUEST_HANDLER)
100-
-- Process request handler `hdl' concurrently.
99+
-- Process request handler `hdl' as soon as `hdl' is connected to accepted socket.
101100
require
102101
hdl.is_connected
103102
do
@@ -123,7 +122,7 @@ feature {HTTPD_SERVER_I} -- Status report
123122
feature {NONE} -- Implementation
124123

125124
separate_client_socket (hdl: separate HTTPD_REQUEST_HANDLER): separate HTTPD_STREAM_SOCKET
126-
-- Client socket for handler `hdl'.
125+
-- Client socket for request handler `hdl'.
127126
do
128127
Result := hdl.client_socket
129128
end

library/server/ewsgi/connectors/standalone/src/httpd/configuration/httpd_configuration_i.e

Lines changed: 7 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -63,22 +63,22 @@ feature -- Access: SSL
6363
-- private key to the certificate.
6464

6565
ssl_protocol: NATURAL
66-
-- By default protocol is tls 1.2.
66+
-- By default protocol is tls 1.2.
6767

6868
feature -- Element change
6969

7070
set_http_server_name (v: detachable separate READABLE_STRING_8)
7171
do
7272
if v = Void then
7373
unset_http_server_name
74-
-- http_server_name := Void
7574
else
7675
create {IMMUTABLE_STRING_8} http_server_name.make_from_separate (v)
7776
end
7877
--| Missing postcondition.
7978
end
8079

8180
unset_http_server_name
81+
-- Unset `http_server_name' value.
8282
do
8383
http_server_name := Void
8484
ensure
@@ -162,12 +162,11 @@ feature -- Element change
162162
else
163163
is_secure := False
164164
end
165-
--| Missing postcondition
166-
--| ensure
167-
-- is_secure_set : has_ssl_support implies is_secure
168-
-- http_server_port_set: has_ssl_support implies http_server_port = 443
169-
-- is_not_secure: not has_ssl_support implies not is_secure
170-
-- default_port: not has_ssl_support implies http_server_port = 80
165+
ensure
166+
is_secure_set: has_ssl_support implies is_secure
167+
-- http_server_port_set: has_ssl_support implies http_server_port = 443
168+
is_not_secure: not has_ssl_support implies not is_secure
169+
-- default_port: not has_ssl_support implies http_server_port = 80
171170
end
172171

173172
feature -- Element change

library/server/ewsgi/connectors/standalone/src/httpd/httpd_connection_handler_i.e

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -79,7 +79,7 @@ feature {NONE} -- Implementation
7979
end
8080

8181
separate_server_log (a_server: like server; a_message: separate READABLE_STRING_8)
82-
-- Separete log from a server `a_server' with message `a_message'.
82+
-- Concurrent call to `a_server.log (a_message)'.
8383
do
8484
a_server.log (a_message)
8585
end

library/server/ewsgi/connectors/standalone/src/httpd/httpd_request_handler_i.e

Lines changed: 2 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
note
2-
description: "Represent a handler interface that process HTTP requests."
2+
description: "HTTPD handler interface processing request."
33
date: "$Date$"
44
revision: "$Revision$"
55

@@ -126,7 +126,7 @@ feature -- Change
126126
feature -- Execution
127127

128128
safe_execute
129-
-- Execute incoming request.
129+
-- Execute accepted incoming connection as request.
130130
local
131131
retried: BOOLEAN
132132
do
@@ -219,7 +219,6 @@ feature -- Execution
219219
if has_error then
220220
-- check catch_bad_incoming_connection: False end
221221
if is_verbose then
222-
-- check invalid_incoming_request: False end
223222
log ("ERROR: invalid HTTP incoming request")
224223
end
225224
else

library/server/ewsgi/connectors/standalone/src/httpd/httpd_server_i.e

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -14,9 +14,10 @@ inherit
1414
feature {NONE} -- Initialization
1515

1616
make (a_factory: like factory)
17+
-- Create current httpd server with `a_factory' of connection handlers.
1718
-- `a_factory': connection handler builder
1819
require
19-
fac_is_separated: {PLATFORM}.is_scoop_capable implies not attached {HTTPD_REQUEST_HANDLER_FACTORY} a_factory
20+
a_factory_is_separated: {PLATFORM}.is_scoop_capable implies not attached {HTTPD_REQUEST_HANDLER_FACTORY} a_factory
2021
do
2122
make_configured (create {like configuration}.make, a_factory)
2223
end
@@ -66,7 +67,7 @@ feature -- Callbacks
6667
observer: detachable separate HTTPD_SERVER_OBSERVER
6768

6869
set_observer (obs: like observer)
69-
-- Set `observer' with `obs'
70+
-- Set `observer' to `obs'.
7071
do
7172
observer := obs
7273
end
@@ -252,7 +253,6 @@ feature -- Event
252253
require
253254
not_launched: not is_launched
254255
do
255-
-- print ("port=" + a_port.out + "%N")
256256
is_launched := True
257257
port := a_port
258258
if attached observer as obs then
@@ -320,15 +320,15 @@ feature -- Output
320320
output: detachable FILE
321321

322322
set_log_output (f: FILE)
323-
-- Set `output' with `f'.
323+
-- Set `output' to `f'.
324324
do
325325
output := f
326326
ensure
327327
output_set: output = f
328328
end
329329

330330
log (a_message: separate READABLE_STRING_8)
331-
-- Log `a_message'
331+
-- Log `a_message'.
332332
local
333333
m: STRING
334334
do

library/server/wsf/src/wsf_execution.e

Lines changed: 3 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
note
2-
description: "Object that represent a request execution with request and response. "
2+
description: "Request execution based on attributes `request' and `response'. "
33
date: "$Date$"
44
revision: "$Revision$"
55

@@ -51,7 +51,7 @@ feature -- Access
5151
feature -- Execution
5252

5353
execute
54-
-- Execute Current `request',
54+
-- Execute Current request,
5555
-- getting data from `request'
5656
-- and response to client via `response'.
5757
deferred
@@ -90,14 +90,13 @@ feature -- Helpers
9090
end
9191

9292
put_error (err: READABLE_STRING_8)
93-
-- Report error described by `a_message'.
93+
-- Report error message `err' on the error output of the associated connector.
9494
require
9595
message_writable: message_writable
9696
do
9797
response.put_error (err)
9898
end
9999

100-
101100
feature -- Cleaning
102101

103102
clean

0 commit comments

Comments
 (0)