stefan pushed a commit to branch master.
http://git.enlightenment.org/core/efl.git/commit/?id=44b3fb5ebc29076de041703eb1417611ddc3f85a
commit 44b3fb5ebc29076de041703eb1417611ddc3f85a
Author: Stefan Schmidt <ste...@osg.samsung.com>
Date: Fri Nov 11 15:33:18 2016 +0100
docs: efl_net_dialer: add missing docs for efl_net_dialer
---
src/lib/ecore_con/efl_net_dialer.eo | 12 +++---
src/lib/ecore_con/efl_net_dialer_http.eo | 46 ++++++++++----------
src/lib/ecore_con/efl_net_dialer_ssl.eo | 6 +--
src/lib/ecore_con/efl_net_dialer_websocket.eo | 60 +++++++++++++--------------
4 files changed, 62 insertions(+), 62 deletions(-)
diff --git a/src/lib/ecore_con/efl_net_dialer.eo
b/src/lib/ecore_con/efl_net_dialer.eo
index e93fb2d..f9d6d02 100644
--- a/src/lib/ecore_con/efl_net_dialer.eo
+++ b/src/lib/ecore_con/efl_net_dialer.eo
@@ -32,9 +32,9 @@ interface Efl.Net.Dialer (Efl.Net.Socket) {
dispatched.
]]
params {
- address: string @nonull;
+ address: string @nonull; [[Remote address]]
}
- return: Eina.Error;
+ return: Eina.Error; [[0 on success, error code otherwise]]
}
@property address_dial {
@@ -47,7 +47,7 @@ interface Efl.Net.Dialer (Efl.Net.Socket) {
get { }
set @protected { }
values {
- address: string;
+ address: string; [[Remote address]]
}
}
@@ -60,7 +60,7 @@ interface Efl.Net.Dialer (Efl.Net.Socket) {
get { }
set @protected { }
values {
- connected: bool;
+ connected: bool; [[$true if the socket is connected, $false
otherwise]]
}
}
@@ -94,7 +94,7 @@ interface Efl.Net.Dialer (Efl.Net.Socket) {
get { }
set { }
values {
- proxy_url: string; [[may be empty or NULL to unset]]
+ proxy_url: string; [[May be empty or NULL to unset]]
}
}
@@ -106,7 +106,7 @@ interface Efl.Net.Dialer (Efl.Net.Socket) {
get { }
set { }
values {
- seconds: double;
+ seconds: double; [[Timeout value is seconds]]
}
}
}
diff --git a/src/lib/ecore_con/efl_net_dialer_http.eo
b/src/lib/ecore_con/efl_net_dialer_http.eo
index b8c327d..f3c331a 100644
--- a/src/lib/ecore_con/efl_net_dialer_http.eo
+++ b/src/lib/ecore_con/efl_net_dialer_http.eo
@@ -62,7 +62,7 @@ class Efl.Net.Dialer.Http (Efl.Loop_User, Efl.Net.Dialer,
Efl.Io.Sizer) {
get { }
set { }
values {
- method: string;
+ method: string; [[HTTP method]]
}
}
@@ -107,7 +107,7 @@ class Efl.Net.Dialer.Http (Efl.Loop_User, Efl.Net.Dialer,
Efl.Io.Sizer) {
}
set { }
values {
- primary_mode: Efl.Net.Dialer.Http.Primary_Mode;
+ primary_mode: Efl.Net.Dialer.Http.Primary_Mode; [[Primary HTTP
mode]]
}
}
@@ -119,7 +119,7 @@ class Efl.Net.Dialer.Http (Efl.Loop_User, Efl.Net.Dialer,
Efl.Io.Sizer) {
get { }
set { }
values {
- user_agent: string;
+ ser_agent: string; [[User-agent]]
}
}
@@ -134,7 +134,7 @@ class Efl.Net.Dialer.Http (Efl.Loop_User, Efl.Net.Dialer,
Efl.Io.Sizer) {
get { }
set { }
values {
- http_version: Efl.Net.Http.Version;
+ http_version: Efl.Net.Http.Version; [[HTTP version]]
}
}
@@ -146,10 +146,10 @@ class Efl.Net.Dialer.Http (Efl.Loop_User, Efl.Net.Dialer,
Efl.Io.Sizer) {
get { }
set { }
values {
- username: string;
- password: string;
- method: Efl.Net.Http.Authentication_Method @optional;
[[authentication method to use, defaults to
@Efl.Net.Http.Authentication_Method.basic]]
- restricted: bool @optional; [[restrict method]]
+ username: string; [[HTTP authentication username]]
+ password: string; [[HTTP authentication password]]
+ method: Efl.Net.Http.Authentication_Method @optional;
[[Authentication method to use, defaults to
@Efl.Net.Http.Authentication_Method.basic]]
+ restricted: bool @optional; [[Restrict method]]
}
}
@@ -161,7 +161,7 @@ class Efl.Net.Dialer.Http (Efl.Loop_User, Efl.Net.Dialer,
Efl.Io.Sizer) {
get { }
set { }
values {
- allow_redirects: bool;
+ allow_redirects: bool; [[$true if redirects are followed,
$false otherwise]]
}
}
@@ -173,8 +173,8 @@ class Efl.Net.Dialer.Http (Efl.Loop_User, Efl.Net.Dialer,
Efl.Io.Sizer) {
This should be called before dialing.
]]
params {
- @in key: string;
- @in value: string;
+ @in key: string; [[Request header key]]
+ @in value: string; [[Request header value]]
}
}
@@ -189,7 +189,7 @@ class Efl.Net.Dialer.Http (Efl.Loop_User, Efl.Net.Dialer,
Efl.Io.Sizer) {
request_headers_get {
[[Return an iterator to the key-value pairs for request headers]]
- return: free(own(iterator<Efl.Net.Http.Header>),
eina_iterator_free) @warn_unused;
+ return: free(own(iterator<Efl.Net.Http.Header>),
eina_iterator_free) @warn_unused; [[Iterator for request headers]]
}
@property request_content_length {
@@ -200,7 +200,7 @@ class Efl.Net.Dialer.Http (Efl.Loop_User, Efl.Net.Dialer,
Efl.Io.Sizer) {
get { }
set { }
values {
- length: int64;
+ length: int64; [[Length value]]
}
}
@@ -212,7 +212,7 @@ class Efl.Net.Dialer.Http (Efl.Loop_User, Efl.Net.Dialer,
Efl.Io.Sizer) {
get { }
set @protected { }
values {
- length: int64;
+ length: int64; [[Length value]]
}
}
@@ -221,7 +221,7 @@ class Efl.Net.Dialer.Http (Efl.Loop_User, Efl.Net.Dialer,
Efl.Io.Sizer) {
get { }
set @protected { }
values {
- content_type: string;
+ content_type: string; [[Content type header string]]
}
}
@@ -237,7 +237,7 @@ class Efl.Net.Dialer.Http (Efl.Loop_User, Efl.Net.Dialer,
Efl.Io.Sizer) {
]]
get { }
values {
- status_code: Efl.Net.Http.Status;
+ status_code: Efl.Net.Http.Status; [[HTTP status]]
}
}
@@ -252,7 +252,7 @@ class Efl.Net.Dialer.Http (Efl.Loop_User, Efl.Net.Dialer,
Efl.Io.Sizer) {
This will be usable after "headers,done" event is dispatched.
]]
- return: free(own(iterator<Efl.Net.Http.Header>),
eina_iterator_free) @warn_unused;
+ return: free(own(iterator<Efl.Net.Http.Header>),
eina_iterator_free) @warn_unused; [[Iterator for response headers]]
}
response_headers_all_get {
@@ -277,7 +277,7 @@ class Efl.Net.Dialer.Http (Efl.Loop_User, Efl.Net.Dialer,
Efl.Io.Sizer) {
This will be usable after "headers,done" event is dispatched.
]]
- return: free(own(iterator<Efl.Net.Http.Header>),
eina_iterator_free) @warn_unused;
+ return: free(own(iterator<Efl.Net.Http.Header>),
eina_iterator_free) @warn_unused; [[Iterator for all response headers]]
}
response_headers_clear {
@@ -288,8 +288,8 @@ class Efl.Net.Dialer.Http (Efl.Loop_User, Efl.Net.Dialer,
Efl.Io.Sizer) {
[[How many bytes were downloaded and how much was expected.]]
get { }
values {
- downloaded: uint64 @optional;
- total: uint64 @optional; [[0 if unknown]]
+ downloaded: uint64 @optional; [[Downloaded bytes so far]]
+ total: uint64 @optional; [[Download total in bytes, 0 if
unknown]]
}
}
@@ -297,8 +297,8 @@ class Efl.Net.Dialer.Http (Efl.Loop_User, Efl.Net.Dialer,
Efl.Io.Sizer) {
[[How many bytes were uploaded and how much was expected.]]
get { }
values {
- uploaded: uint64 @optional;
- total: uint64 @optional; [[0 if unknown]]
+ uploaded: uint64 @optional; [[Uploaded bytes so far]]
+ total: uint64 @optional; [[Upload total in bytes, 0 if
unknown]]
}
}
@@ -331,7 +331,7 @@ class Efl.Net.Dialer.Http (Efl.Loop_User, Efl.Net.Dialer,
Efl.Io.Sizer) {
get { }
set { }
values {
- path: string;
+ path: string; [[Path to cookie jar]]
}
}
}
diff --git a/src/lib/ecore_con/efl_net_dialer_ssl.eo
b/src/lib/ecore_con/efl_net_dialer_ssl.eo
index 2660c93..a4f8d25 100644
--- a/src/lib/ecore_con/efl_net_dialer_ssl.eo
+++ b/src/lib/ecore_con/efl_net_dialer_ssl.eo
@@ -35,7 +35,7 @@ class Efl.Net.Dialer.Ssl (Efl.Net.Socket.Ssl, Efl.Net.Dialer)
{
It must be called before @Efl.Object.finalize!
]]
values {
- ssl_context: Efl.Net.Ssl.Context;
+ ssl_context: Efl.Net.Ssl.Context; [[SSL context]]
}
}
@@ -46,7 +46,7 @@ class Efl.Net.Dialer.Ssl (Efl.Net.Socket.Ssl, Efl.Net.Dialer)
{
return: bool (false); [[$true on success]]
}
values {
- keep_alive: bool;
+ keep_alive: bool; [[$true if keep alive is enabled, $false
otherwise]]
}
}
@@ -57,7 +57,7 @@ class Efl.Net.Dialer.Ssl (Efl.Net.Socket.Ssl, Efl.Net.Dialer)
{
return: bool (false); [[$true on success]]
}
values {
- no_delay: bool;
+ no_delay: bool; [[$true if no delay is enabled, $false
otherwise]]
}
}
diff --git a/src/lib/ecore_con/efl_net_dialer_websocket.eo
b/src/lib/ecore_con/efl_net_dialer_websocket.eo
index 8408eb2..5ab3740 100644
--- a/src/lib/ecore_con/efl_net_dialer_websocket.eo
+++ b/src/lib/ecore_con/efl_net_dialer_websocket.eo
@@ -21,17 +21,17 @@ enum Efl.Net.Dialer.Websocket.Close_Reason {
@since 1.19
]]
- normal = 1000, [[indicates a normal closure, meaning that the purpose for
which the connection was established has been fulfilled.]]
- going_away = 1001, [[indicates that an endpoint is "going away", such as a
server going down or a browser having navigated away from a page.]]
- protocol_error = 1002, [[indicates that an endpoint is terminating the
connection due to a protocol error.]]
- no_reason = 1005, [[reserved value and MUST NOT be set as a status code in
a Close control frame by an endpoint. It is designated for use in applications
expecting a status code to indicate that no status code was actually present.]]
- abruptly = 1006, [[reserved value and MUST NOT be set as a status code in
a Close control frame by an endpoint. It is designated for use in applications
expecting a status code to indicate that the connection was closed abnormally,
e.g., without sending or receiving a Close control frame.]]
- unexpected_data = 1003, [[indicates that an endpoint is terminating the
connection because it has received a type of data it cannot accept (e.g., an
endpoint that understands only text data MAY send this if it receives a binary
message).]]
- inconsistent_data = 1007, [[indicates that an endpoint is terminating the
connection because it has received data within a message that was not
consistent with the type of the message (e.g., non-UTF-8 data within a text
message).]]
- policy_violation = 1008, [[indicates that an endpoint is terminating the
connection because it has received a message that violates its policy. This is
a generic status code that can be returned when there is no other more suitable
status code (e.g., 1003 or 1009) or if there is a need to hide specific details
about the policy.]]
- too_big = 1009, [[indicates that an endpoint is terminating the connection
because it has received a message that is too big for it to process.]]
- missing_extension = 1010, [[indicates that an endpoint (client) is
terminating the connection because it has expected the server to negotiate one
or more extension, but the server didn't return them in the response message of
the WebSocket handshake. The list of extensions that are needed SHOULD appear
in the reason part of the Close frame. Note that this status code is not used
by the server, because it can fail the WebSocket handshake instead.]]
- server_error = 1011, [[indicates that a server is terminating the
connection because it encountered an unexpected condition that prevented it
from fulfilling the request.]]
+ normal = 1000, [[Indicates a normal closure, meaning that the purpose for
which the connection was established has been fulfilled.]]
+ going_away = 1001, [[Indicates that an endpoint is "going away", such as a
server going down or a browser having navigated away from a page.]]
+ protocol_error = 1002, [[Indicates that an endpoint is terminating the
connection due to a protocol error.]]
+ no_reason = 1005, [[Reserved value and MUST NOT be set as a status code in
a Close control frame by an endpoint. It is designated for use in applications
expecting a status code to indicate that no status code was actually present.]]
+ abruptly = 1006, [[Reserved value and MUST NOT be set as a status code in
a Close control frame by an endpoint. It is designated for use in applications
expecting a status code to indicate that the connection was closed abnormally,
e.g., without sending or receiving a Close control frame.]]
+ unexpected_data = 1003, [[Indicates that an endpoint is terminating the
connection because it has received a type of data it cannot accept (e.g., an
endpoint that understands only text data MAY send this if it receives a binary
message).]]
+ inconsistent_data = 1007, [[Indicates that an endpoint is terminating the
connection because it has received data within a message that was not
consistent with the type of the message (e.g., non-UTF-8 data within a text
message).]]
+ policy_violation = 1008, [[Indicates that an endpoint is terminating the
connection because it has received a message that violates its policy. This is
a generic status code that can be returned when there is no other more suitable
status code (e.g., 1003 or 1009) or if there is a need to hide specific details
about the policy.]]
+ too_big = 1009, [[Indicates that an endpoint is terminating the connection
because it has received a message that is too big for it to process.]]
+ missing_extension = 1010, [[Indicates that an endpoint (client) is
terminating the connection because it has expected the server to negotiate one
or more extension, but the server didn't return them in the response message of
the WebSocket handshake. The list of extensions that are needed SHOULD appear
in the reason part of the Close frame. Note that this status code is not used
by the server, because it can fail the WebSocket handshake instead.]]
+ server_error = 1011, [[Indicates that a server is terminating the
connection because it encountered an unexpected condition that prevented it
from fulfilling the request.]]
iana_registry_start = 3000, [[IANA registry starts at 3000]]
iana_registry_end = 3999, [[IANA registry ends at 3999]]
private_start = 4000, [[Applications can use range 4000-4999]]
@@ -87,7 +87,7 @@ class Efl.Net.Dialer.Websocket (Efl.Loop_User,
Efl.Net.Dialer) {
]]
params {
- reason: string @optional;
+ reason: string @optional; [[Reason]]
}
}
@@ -101,7 +101,7 @@ class Efl.Net.Dialer.Websocket (Efl.Loop_User,
Efl.Net.Dialer) {
are kept after this method returns.
]]
params {
- text: string;
+ text: string; [[Text to send]]
}
}
@@ -115,7 +115,7 @@ class Efl.Net.Dialer.Websocket (Efl.Loop_User,
Efl.Net.Dialer) {
are kept after this method returns.
]]
params {
- blob: const(Eina.Slice);
+ blob: const(Eina.Slice); [[Binary blob to send]]
}
}
@@ -135,8 +135,8 @@ class Efl.Net.Dialer.Websocket (Efl.Loop_User,
Efl.Net.Dialer) {
close message, that will be reported as "closed,reason".
]]
params {
- reason: Efl.Net.Dialer.Websocket.Close_Reason;
- message: string @optional;
+ reason: Efl.Net.Dialer.Websocket.Close_Reason; [[Reason for
closing]]
+ message: string @optional; [[Additional closing message]]
}
}
@@ -146,13 +146,13 @@ class Efl.Net.Dialer.Websocket (Efl.Loop_User,
Efl.Net.Dialer) {
This should be set before dialing.
]]
params {
- protocol: string;
+ protocol: string; [[WebSocket protocol]]
}
}
request_protocols_get {
[[Return an iterator to the requested WebSocket protocols]]
- return: free(own(iterator<string>), eina_iterator_free)
@warn_unused;
+ return: free(own(iterator<string>), eina_iterator_free)
@warn_unused; [[Iterator to protocols]]
}
request_protocols_clear {
@@ -161,7 +161,7 @@ class Efl.Net.Dialer.Websocket (Efl.Loop_User,
Efl.Net.Dialer) {
response_protocols_get {
[[Return an iterator to the server-replied (response) WebSocket
protocols it supports]]
- return: free(own(iterator<string>), eina_iterator_free)
@warn_unused;
+ return: free(own(iterator<string>), eina_iterator_free)
@warn_unused; [[Iterator to server protocols]]
}
@property streaming_mode {
@@ -189,7 +189,7 @@ class Efl.Net.Dialer.Websocket (Efl.Loop_User,
Efl.Net.Dialer) {
get { }
set { }
values {
- streaming_mode: Efl.Net.Dialer.Websocket.Streaming_Mode;
+ streaming_mode: Efl.Net.Dialer.Websocket.Streaming_Mode;
[[Streaming mode]]
}
}
@@ -201,7 +201,7 @@ class Efl.Net.Dialer.Websocket (Efl.Loop_User,
Efl.Net.Dialer) {
get { }
set { }
values {
- user_agent: string;
+ user_agent: string; [[User-agent]]
}
}
@@ -213,10 +213,10 @@ class Efl.Net.Dialer.Websocket (Efl.Loop_User,
Efl.Net.Dialer) {
get { }
set { }
values {
- username: string;
- password: string;
- method: Efl.Net.Http.Authentication_Method @optional;
[[authentication method to use, defaults to
@Efl.Net.Http.Authentication_Method.basic]]
- restricted: bool @optional; [[restrict method]]
+ username: string; [[HTTP authentication username]]
+ password: string; [[HTTP authentication password]]
+ method: Efl.Net.Http.Authentication_Method @optional;
[[Authentication method to use, defaults to
@Efl.Net.Http.Authentication_Method.basic]]
+ restricted: bool @optional; [[Restrict method]]
}
}
@@ -228,7 +228,7 @@ class Efl.Net.Dialer.Websocket (Efl.Loop_User,
Efl.Net.Dialer) {
get { }
set { }
values {
- allow_redirects: bool;
+ allow_redirects: bool; [[$true when following redirects,
$false otherwise]]
}
}
@@ -252,8 +252,8 @@ class Efl.Net.Dialer.Websocket (Efl.Loop_User,
Efl.Net.Dialer) {
This should be called before dialing.
]]
params {
- @in key: string;
- @in value: string;
+ @in key: string; [[HTTP request header key]]
+ @in value: string; [[HTTP request header value]]
}
}
@@ -268,7 +268,7 @@ class Efl.Net.Dialer.Websocket (Efl.Loop_User,
Efl.Net.Dialer) {
request_headers_get {
[[Return an iterator to the key-value pairs for request headers]]
- return: free(own(iterator<Efl.Net.Http.Header>),
eina_iterator_free) @warn_unused;
+ return: free(own(iterator<Efl.Net.Http.Header>),
eina_iterator_free) @warn_unused; [[Iterator to key value pairs]]
}
@property cookie_jar {
@@ -300,7 +300,7 @@ class Efl.Net.Dialer.Websocket (Efl.Loop_User,
Efl.Net.Dialer) {
get { }
set { }
values {
- path: string;
+ path: string; [[Path to cookie jar]]
}
}
}
--
