Added descriptions and comments

This commit is contained in:
jvelilla
2015-04-06 17:46:59 -03:00
committed by Jocelyn Fiat
parent a0e9a41e21
commit 9c7e29b836
4 changed files with 24 additions and 5 deletions

View File

@@ -60,7 +60,7 @@ feature -- Access: SSL
-- the signed certificate. -- the signed certificate.
ca_key: STRING ca_key: STRING
-- private key to the sertificate. -- private key to the certificate.
ssl_protocol: NATURAL ssl_protocol: NATURAL
-- By default protocol is tls 1.2. -- By default protocol is tls 1.2.
@@ -75,6 +75,7 @@ feature -- Element change
else else
create {IMMUTABLE_STRING_8} http_server_name.make_from_separate (v) create {IMMUTABLE_STRING_8} http_server_name.make_from_separate (v)
end end
--| Missing postcondition.
end end
unset_http_server_name unset_http_server_name
@@ -201,31 +202,43 @@ feature -- SSL Helpers
set_ssl_protocol_to_ssl_2_or_3 set_ssl_protocol_to_ssl_2_or_3
-- Set `ssl_protocol' with `Ssl_23'. -- Set `ssl_protocol' with `Ssl_23'.
deferred deferred
ensure
ssl_protocol_set: ssl_protocol = {SSL_PROTOCOL}.Ssl_23
end end
set_ssl_protocol_to_ssl_3 set_ssl_protocol_to_ssl_3
-- Set `ssl_protocol' with `Ssl_3'. -- Set `ssl_protocol' with `Ssl_3'.
deferred deferred
ensure
ssl_protocol_set: ssl_protocol = {SSL_PROTOCOL}.Ssl_3
end end
set_ssl_protocol_to_tls_1_0 set_ssl_protocol_to_tls_1_0
-- Set `ssl_protocol' with `Tls_1_0'. -- Set `ssl_protocol' with `Tls_1_0'.
deferred deferred
ensure
ssl_protocol_set: ssl_protocol = {SSL_PROTOCOL}.Tls_1_0
end end
set_ssl_protocol_to_tls_1_1 set_ssl_protocol_to_tls_1_1
-- Set `ssl_protocol' with `Tls_1_1'. -- Set `ssl_protocol' with `Tls_1_1'.
deferred deferred
ensure
ssl_protocol_set: ssl_protocol = {SSL_PROTOCOL}.Tls_1_1
end end
set_ssl_protocol_to_tls_1_2 set_ssl_protocol_to_tls_1_2
-- Set `ssl_protocol' with `Tls_1_2'. -- Set `ssl_protocol' with `Tls_1_2'.
deferred deferred
ensure
ssl_protocol_set: ssl_protocol = {SSL_PROTOCOL}.Tls_1_2
end end
set_ssl_protocol_to_dtls_1_0 set_ssl_protocol_to_dtls_1_0
-- Set `ssl_protocol' with `Dtls_1_0'. -- Set `ssl_protocol' with `Dtls_1_0'.
deferred deferred
ensure
ssl_protocol_set: ssl_protocol = {SSL_PROTOCOL}.Dtls_1_0
end end
note note

View File

@@ -1,5 +1,5 @@
note note
description: "Summary description for {HTTPD_SERVER_I}." description: "HTTPD server interface"
date: "$Date$" date: "$Date$"
revision: "$Revision$" revision: "$Revision$"
@@ -14,7 +14,6 @@ inherit
feature {NONE} -- Initialization feature {NONE} -- Initialization
make (a_factory: like factory) make (a_factory: like factory)
-- `a_cfg': server configuration
-- `a_factory': connection handler builder -- `a_factory': connection handler builder
require require
fac_is_separated: {PLATFORM}.is_scoop_capable implies not attached {HTTPD_REQUEST_HANDLER_FACTORY} a_factory fac_is_separated: {PLATFORM}.is_scoop_capable implies not attached {HTTPD_REQUEST_HANDLER_FACTORY} a_factory
@@ -67,6 +66,7 @@ feature -- Callbacks
observer: detachable separate HTTPD_SERVER_OBSERVER observer: detachable separate HTTPD_SERVER_OBSERVER
set_observer (obs: like observer) set_observer (obs: like observer)
-- Set `observer' with `obs'
do do
observer := obs observer := obs
end end
@@ -320,8 +320,11 @@ feature -- Output
output: detachable FILE output: detachable FILE
set_log_output (f: FILE) set_log_output (f: FILE)
-- Set `output' with `f'.
do do
output := f output := f
ensure
output_set: output = f
end end
log (a_message: separate READABLE_STRING_8) log (a_message: separate READABLE_STRING_8)

View File

@@ -18,9 +18,12 @@ create
feature {NONE} -- Initialization feature {NONE} -- Initialization
make make
-- Create a new instance and set ssl protocol to tls_1_2.
do do
Precursor Precursor
ssl_protocol := {SSL_PROTOCOL}.tls_1_2 set_ssl_protocol_to_tls_1_2
ensure then
ssl_protocol_set: ssl_protocol = {SSL_PROTOCOL}.tls_1_2
end end
feature -- Access feature -- Access

View File

@@ -1,5 +1,5 @@
note note
description: "Summary description for {WGI_HTTPD_REQUEST_HANDLER_FACTORY}." description: "Implementation of WGI request handler factory for WGI_STANDALOE_CONNECTOR."
date: "$Date$" date: "$Date$"
revision: "$Revision$" revision: "$Revision$"