summaryrefslogtreecommitdiff
path: root/pages/develop/api/efl/net/dialer/http
diff options
context:
space:
mode:
authorAndy Williams <andy@andywilliams.me>2017-12-22 17:35:24 +0000
committerAndy Williams <andy@andywilliams.me>2017-12-22 17:35:35 +0000
commitec209036c7a4457e953b8fb2e21d9e6939bd365c (patch)
tree5b7c843d8e073bb0a3d11bfd27fa1b7b16f20b16 /pages/develop/api/efl/net/dialer/http
parentb69a43f26785181659641d1111bad0bd0beca541 (diff)
api: Generate from latest .eo files
Diffstat (limited to 'pages/develop/api/efl/net/dialer/http')
-rw-r--r--pages/develop/api/efl/net/dialer/http/method/dial.txt4
-rw-r--r--pages/develop/api/efl/net/dialer/http/method/response_headers_all_get.txt8
-rw-r--r--pages/develop/api/efl/net/dialer/http/method/response_headers_clear.txt2
-rw-r--r--pages/develop/api/efl/net/dialer/http/method/response_headers_get.txt6
-rw-r--r--pages/develop/api/efl/net/dialer/http/method/write.txt2
-rw-r--r--pages/develop/api/efl/net/dialer/http/property/address_dial.txt2
-rw-r--r--pages/develop/api/efl/net/dialer/http/property/address_local.txt4
-rw-r--r--pages/develop/api/efl/net/dialer/http/property/address_remote.txt2
-rw-r--r--pages/develop/api/efl/net/dialer/http/property/authentication.txt2
-rw-r--r--pages/develop/api/efl/net/dialer/http/property/connected.txt2
-rw-r--r--pages/develop/api/efl/net/dialer/http/property/cookie_jar.txt12
-rw-r--r--pages/develop/api/efl/net/dialer/http/property/primary_mode.txt2
-rw-r--r--pages/develop/api/efl/net/dialer/http/property/proxy.txt2
-rw-r--r--pages/develop/api/efl/net/dialer/http/property/ssl_verify.txt2
14 files changed, 26 insertions, 26 deletions
diff --git a/pages/develop/api/efl/net/dialer/http/method/dial.txt b/pages/develop/api/efl/net/dialer/http/method/dial.txt
index 2b98ec8..86978ad 100644
--- a/pages/develop/api/efl/net/dialer/http/method/dial.txt
+++ b/pages/develop/api/efl/net/dialer/http/method/dial.txt
@@ -3,9 +3,9 @@
3 3
4%%Dials to the remote peer.%% 4%%Dials to the remote peer.%%
5 5
6%%This method starts the connection process, resolving address and then proceeding to the actual connection.%% 6%%This method starts the connection process, resolves the address and then proceeds to the actual connection.%%
7 7
8%%Once the connection is fully setup, "connected" event is dispatched.%% 8%%Once the connection is fully setup "connected" event is dispatched.%%
9 9
10//Since 1.19// 10//Since 1.19//
11{{page>:develop:api-include:efl:net:dialer:http:method:dial:description&nouser&nolink&nodate}} 11{{page>:develop:api-include:efl:net:dialer:http:method:dial:description&nouser&nolink&nodate}}
diff --git a/pages/develop/api/efl/net/dialer/http/method/response_headers_all_get.txt b/pages/develop/api/efl/net/dialer/http/method/response_headers_all_get.txt
index e1dd383..fa4ba38 100644
--- a/pages/develop/api/efl/net/dialer/http/method/response_headers_all_get.txt
+++ b/pages/develop/api/efl/net/dialer/http/method/response_headers_all_get.txt
@@ -3,15 +3,15 @@
3 3
4%%Returns an iterator to the key-value pairs for all response headers.%% 4%%Returns an iterator to the key-value pairs for all response headers.%%
5 5
6%%Since multiple requests can happen if %%[[:develop:api:efl:net:dialer:http:property:allow_redirects|Efl.Net.Dialer.Http.allow_redirects]]%% is true, then all headers will be accumulated. To know when new request is started, check for headers with keys being NULL, the value will be the "HTTP/VERSION RESPONSE" string received from the host, such as:%% 6%%Since multiple requests can occur if %%[[:develop:api:efl:net:dialer:http:property:allow_redirects|Efl.Net.Dialer.Http.allow_redirects]]%% is true, then all headers will be accumulated. To know when a new request's been started, check for headers with keys being NULL. The value will be the "HTTP/VERSION RESPONSE" string received from the host, such as:%%
7 7
8%%- key=NULL, value="HTTP/1.1 302 Found" - key="Location", value="http://someredirect.com" - key=NULL, value="HTTP/1.1 200 Ok" - key="Content-Type", value="text/html"%% 8%%- key=NULL, value="HTTP/1.1 302 Found" - key="Location", value="http://someredirect.com" - key=NULL, value="HTTP/1.1 200 Ok" - key="Content-Type", value="text/html"%%
9 9
10%%Which mean the original request had a redirect to http://someredirect.com.%% 10%%This means the original request had a redirect to http://someredirect.com.%%
11 11
12%%To receive an iterator to just the last request, use %%[[:develop:api:efl:net:dialer:http:method:response_headers_get|Efl.Net.Dialer.Http.response_headers_get]]%%%% 12%%To receive an iterator to only the last request, use %%[[:develop:api:efl:net:dialer:http:method:response_headers_get|Efl.Net.Dialer.Http.response_headers_get]]%%%%
13 13
14%%This will be usable after "headers,done" event is dispatched.%% 14%%This will be usable after the "headers,done" event is dispatched.%%
15 15
16//Since 1.19// 16//Since 1.19//
17{{page>:develop:api-include:efl:net:dialer:http:method:response_headers_all_get:description&nouser&nolink&nodate}} 17{{page>:develop:api-include:efl:net:dialer:http:method:response_headers_all_get:description&nouser&nolink&nodate}}
diff --git a/pages/develop/api/efl/net/dialer/http/method/response_headers_clear.txt b/pages/develop/api/efl/net/dialer/http/method/response_headers_clear.txt
index 2f548af..4ca6a69 100644
--- a/pages/develop/api/efl/net/dialer/http/method/response_headers_clear.txt
+++ b/pages/develop/api/efl/net/dialer/http/method/response_headers_clear.txt
@@ -1,7 +1,7 @@
1~~Title: Efl.Net.Dialer.Http.response_headers_clear~~ 1~~Title: Efl.Net.Dialer.Http.response_headers_clear~~
2===== Description ===== 2===== Description =====
3 3
4%%Saves some memory by disposing the received headers%% 4%%Saves memory by disposing of the received headers%%
5 5
6//Since 1.19// 6//Since 1.19//
7{{page>:develop:api-include:efl:net:dialer:http:method:response_headers_clear:description&nouser&nolink&nodate}} 7{{page>:develop:api-include:efl:net:dialer:http:method:response_headers_clear:description&nouser&nolink&nodate}}
diff --git a/pages/develop/api/efl/net/dialer/http/method/response_headers_get.txt b/pages/develop/api/efl/net/dialer/http/method/response_headers_get.txt
index 4b6e569..d36219a 100644
--- a/pages/develop/api/efl/net/dialer/http/method/response_headers_get.txt
+++ b/pages/develop/api/efl/net/dialer/http/method/response_headers_get.txt
@@ -3,11 +3,11 @@
3 3
4%%Returns an iterator to the key-value pairs for the last response headers.%% 4%%Returns an iterator to the key-value pairs for the last response headers.%%
5 5
6%%Since multiple requests can happen if %%[[:develop:api:efl:net:dialer:http:property:allow_redirects|Efl.Net.Dialer.Http.allow_redirects]]%% is true, then all headers will be accumulated. This method returns only the headers for the last request.%% 6%%Since multiple requests can occur if %%[[:develop:api:efl:net:dialer:http:property:allow_redirects|Efl.Net.Dialer.Http.allow_redirects]]%% is true, then all headers will be accumulated. This method returns only the headers for the last request.%%
7 7
8%%To know all the headers, check %%[[:develop:api:efl:net:dialer:http:method:response_headers_all_get|Efl.Net.Dialer.Http.response_headers_all_get]]%%.%% 8%%To list all the headers, check %%[[:develop:api:efl:net:dialer:http:method:response_headers_all_get|Efl.Net.Dialer.Http.response_headers_all_get]]%%.%%
9 9
10%%This will be usable after "headers,done" event is dispatched.%% 10%%This will be usable after the "headers,done" event is dispatched.%%
11 11
12//Since 1.19// 12//Since 1.19//
13{{page>:develop:api-include:efl:net:dialer:http:method:response_headers_get:description&nouser&nolink&nodate}} 13{{page>:develop:api-include:efl:net:dialer:http:method:response_headers_get:description&nouser&nolink&nodate}}
diff --git a/pages/develop/api/efl/net/dialer/http/method/write.txt b/pages/develop/api/efl/net/dialer/http/method/write.txt
index 8faf269..9789b15 100644
--- a/pages/develop/api/efl/net/dialer/http/method/write.txt
+++ b/pages/develop/api/efl/net/dialer/http/method/write.txt
@@ -3,7 +3,7 @@
3 3
4%%Writes data from a pre-populated buffer.%% 4%%Writes data from a pre-populated buffer.%%
5 5
6%%This operation will be executed immediately and may or may not block the caller thread for some time. The details of blocking behavior is to be defined by the implementation and may be subject to other parameters such as non-blocking flags, maximum timeout or even retry attempts.%% 6%%This operation will be executed immediately and may or may not block the caller thread for some time. The details of blocking behavior is defined by the implementation and may be subject to other parameters such as non-blocking flags, maximum timeout or even retry attempts.%%
7 7
8%%You can understand this method as write(2) libc function.%% 8%%You can understand this method as write(2) libc function.%%
9 9
diff --git a/pages/develop/api/efl/net/dialer/http/property/address_dial.txt b/pages/develop/api/efl/net/dialer/http/property/address_dial.txt
index 7d0f820..9c16825 100644
--- a/pages/develop/api/efl/net/dialer/http/property/address_dial.txt
+++ b/pages/develop/api/efl/net/dialer/http/property/address_dial.txt
@@ -3,7 +3,7 @@
3 3
4%%Returns the address given to %%[[:develop:api:efl:net:dialer:method:dial|Efl.Net.Dialer.dial]]%%.%% 4%%Returns the address given to %%[[:develop:api:efl:net:dialer:method:dial|Efl.Net.Dialer.dial]]%%.%%
5 5
6%%If the resolved address is desired, then listen to "resolved" event and use the %%[[:develop:api:efl:net:socket:property:address_remote|Efl.Net.Socket.address_remote]]%% property.%% 6%%If the resolved address is required, listen to "resolved" event and use the %%[[:develop:api:efl:net:socket:property:address_remote|Efl.Net.Socket.address_remote]]%% property.%%
7 7
8//Since 1.19// 8//Since 1.19//
9{{page>:develop:api-include:efl:net:dialer:http:property:address_dial:description&nouser&nolink&nodate}} 9{{page>:develop:api-include:efl:net:dialer:http:property:address_dial:description&nouser&nolink&nodate}}
diff --git a/pages/develop/api/efl/net/dialer/http/property/address_local.txt b/pages/develop/api/efl/net/dialer/http/property/address_local.txt
index 42ed481..85e6f2e 100644
--- a/pages/develop/api/efl/net/dialer/http/property/address_local.txt
+++ b/pages/develop/api/efl/net/dialer/http/property/address_local.txt
@@ -3,9 +3,9 @@
3 3
4%%The local address, similar to getsockname().%% 4%%The local address, similar to getsockname().%%
5 5
6%%The actual value depends on the type of socket, like an IPv4 (ip:port) or IPv6 ([ip]:port) formatted for a TCP/UDP socket, the path if an Unix Local...%% 6%%The actual value depends on the type of socket, such as an IPv4 (ip:port) or IPv6 ([ip]:port) formatted for a TCP/UDP socket, the path if an Unix Local...%%
7 7
8%%It's always resolved, then if operations are working with domain names or URL, this is the values the kernel reports. It's similar to getsockname() in behavior.%% 8%%It's always resolved. If operations are working with domain names or URLs, these are the values the kernel reports. It's similar to getsockname() in behavior.%%
9 9
10//Since 1.19// 10//Since 1.19//
11{{page>:develop:api-include:efl:net:dialer:http:property:address_local:description&nouser&nolink&nodate}} 11{{page>:develop:api-include:efl:net:dialer:http:property:address_local:description&nouser&nolink&nodate}}
diff --git a/pages/develop/api/efl/net/dialer/http/property/address_remote.txt b/pages/develop/api/efl/net/dialer/http/property/address_remote.txt
index c333409..4bbe42c 100644
--- a/pages/develop/api/efl/net/dialer/http/property/address_remote.txt
+++ b/pages/develop/api/efl/net/dialer/http/property/address_remote.txt
@@ -5,7 +5,7 @@
5 5
6%%The actual value depends on the type of socket, like an IPv4 (ip:port) or IPv6 ([ip]:port) formatted for a TCP/UDP socket, the path if an Unix Local...%% 6%%The actual value depends on the type of socket, like an IPv4 (ip:port) or IPv6 ([ip]:port) formatted for a TCP/UDP socket, the path if an Unix Local...%%
7 7
8%%It's always resolved, then if operations are working with domain names or URL, this is the values the kernel reports. It's similar to getpeername() in behavior.%% 8%%It's always resolved. If operations are working with domain names or URLs, these are the values the kernel reports. It's similar to getpeername() in behavior.%%
9 9
10//Since 1.19// 10//Since 1.19//
11{{page>:develop:api-include:efl:net:dialer:http:property:address_remote:description&nouser&nolink&nodate}} 11{{page>:develop:api-include:efl:net:dialer:http:property:address_remote:description&nouser&nolink&nodate}}
diff --git a/pages/develop/api/efl/net/dialer/http/property/authentication.txt b/pages/develop/api/efl/net/dialer/http/property/authentication.txt
index a0d9483..a5d6b54 100644
--- a/pages/develop/api/efl/net/dialer/http/property/authentication.txt
+++ b/pages/develop/api/efl/net/dialer/http/property/authentication.txt
@@ -12,7 +12,7 @@
12 12
13 * **username** - %%HTTP authentication username%% 13 * **username** - %%HTTP authentication username%%
14 * **password** - %%HTTP authentication password%% 14 * **password** - %%HTTP authentication password%%
15 * **method** - %%Authentication method to use, defaults to %%[[:develop:api:efl:net:http:authentication_method|Efl.Net.Http.Authentication_Method.basic]]%%%% 15 * **method** - %%Authentication method to use. Defaults to %%[[:develop:api:efl:net:http:authentication_method|Efl.Net.Http.Authentication_Method.basic]]%%%%
16 * **restricted** - %%Restrict method%% 16 * **restricted** - %%Restrict method%%
17 17
18===== Signature ===== 18===== Signature =====
diff --git a/pages/develop/api/efl/net/dialer/http/property/connected.txt b/pages/develop/api/efl/net/dialer/http/property/connected.txt
index 9735d6c..b85dddb 100644
--- a/pages/develop/api/efl/net/dialer/http/property/connected.txt
+++ b/pages/develop/api/efl/net/dialer/http/property/connected.txt
@@ -3,7 +3,7 @@
3 3
4%%Returns whenever the socket is connected or not.%% 4%%Returns whenever the socket is connected or not.%%
5 5
6%%Whenever this property becomes true, "connected" event should be dispatched.%% 6%%Whenever this property becomes true the "connected" event should be dispatched.%%
7 7
8//Since 1.19// 8//Since 1.19//
9{{page>:develop:api-include:efl:net:dialer:http:property:connected:description&nouser&nolink&nodate}} 9{{page>:develop:api-include:efl:net:dialer:http:property:connected:description&nouser&nolink&nodate}}
diff --git a/pages/develop/api/efl/net/dialer/http/property/cookie_jar.txt b/pages/develop/api/efl/net/dialer/http/property/cookie_jar.txt
index 6d77dd2..413fbad 100644
--- a/pages/develop/api/efl/net/dialer/http/property/cookie_jar.txt
+++ b/pages/develop/api/efl/net/dialer/http/property/cookie_jar.txt
@@ -1,17 +1,17 @@
1~~Title: Efl.Net.Dialer.Http.cookie_jar~~ 1~~Title: Efl.Net.Dialer.Http.cookie_jar~~
2===== Description ===== 2===== Description =====
3 3
4%%This property sets the filename where to read and write cookies.%% 4%%This property sets the filename to read and write cookies.%%
5 5
6%%By setting a file to load and persist cookies to, the internal cookie system will be activated, automatically handling HTTP headers such as 'Set-cookie:' and sending the appropriate cookies for a server.%% 6%%By setting a file to load and store cookies, the internal cookie system will be activated, automatically handling HTTP headers such as 'Set-cookie:' and sending the appropriate cookies for the server.%%
7 7
8%%If a new, empty session is to be used, start with an empty or non-existent file such as created with mkstemp() or tmpfile(). An alternative is to use an empty string ("") to keep it in memory.%% 8%%If a new, empty session is to be used, start with an empty or non-existent file such as created with mkstemp() or tmpfile(). Alternatively use an empty string ("") to store it in memory.%%
9 9
10%%If it is desired to start from a pre-existent cookie jar but do not want to modify that, first copy that file and then pass the new, temporary file.%% 10%%If you want to start from a pre-existing cookie jar but do not want to modify it, first copy that file and then pass the new, temporary file.%%
11 11
12%%Likewise, if it's desired to fill some cookies to the system, create a cookie jar and pass its path to this property.%% 12%%Likewise, if you want to add cookies to the system, create a cookie jar and pass its path to this property.%%
13 13
14%%@note that whenever this property is set, even if to the same value, it will flush all cookies to the previously set file, then erase all known cookies, then use the new file (if any).%% 14%%@note that whenever this property is set, even if to the same value, it will flush all cookies to the previously set file, then erase all known cookies. It will then use the new file (if any).%%
15 15
16//Since 1.19// 16//Since 1.19//
17{{page>:develop:api-include:efl:net:dialer:http:property:cookie_jar:description&nouser&nolink&nodate}} 17{{page>:develop:api-include:efl:net:dialer:http:property:cookie_jar:description&nouser&nolink&nodate}}
diff --git a/pages/develop/api/efl/net/dialer/http/property/primary_mode.txt b/pages/develop/api/efl/net/dialer/http/property/primary_mode.txt
index 0feeb5f..b71db16 100644
--- a/pages/develop/api/efl/net/dialer/http/property/primary_mode.txt
+++ b/pages/develop/api/efl/net/dialer/http/property/primary_mode.txt
@@ -11,7 +11,7 @@
11 11
12%%- If %%[[:develop:api:efl:net:dialer:http:primary_mode|Efl.Net.Dialer.Http.Primary_Mode.download]]%%, then %%[[:develop:api:efl:io:sizer:property:size|Efl.Io.Sizer.size.get]]%% will report the "Content-Length" provided by the server, if any.%% 12%%- If %%[[:develop:api:efl:net:dialer:http:primary_mode|Efl.Net.Dialer.Http.Primary_Mode.download]]%%, then %%[[:develop:api:efl:io:sizer:property:size|Efl.Io.Sizer.size.get]]%% will report the "Content-Length" provided by the server, if any.%%
13 13
14%%If is worth to mention that one can provide and retrieve these values using %%[[:develop:api:efl:net:dialer:http:method:request_headers_get|Efl.Net.Dialer.Http.request_headers_get]]%% (to send) and %%[[:develop:api:efl:net:dialer:http:method:response_headers_get|Efl.Net.Dialer.Http.response_headers_get]]%% (what was received), as well as using the specific properties %%[[:develop:api:efl:net:dialer:http:property:request_content_length|Efl.Net.Dialer.Http.request_content_length]]%% (upload) and %%[[:develop:api:efl:net:dialer:http:property:response_content_length|Efl.Net.Dialer.Http.response_content_length]]%% (download).%% 14%%You can also provide and retrieve these values using %%[[:develop:api:efl:net:dialer:http:method:request_headers_get|Efl.Net.Dialer.Http.request_headers_get]]%% (to send) and %%[[:develop:api:efl:net:dialer:http:method:response_headers_get|Efl.Net.Dialer.Http.response_headers_get]]%% (what was received), as well as using the specific properties %%[[:develop:api:efl:net:dialer:http:property:request_content_length|Efl.Net.Dialer.Http.request_content_length]]%% (upload) and %%[[:develop:api:efl:net:dialer:http:property:response_content_length|Efl.Net.Dialer.Http.response_content_length]]%% (download).%%
15 15
16//Since 1.19// 16//Since 1.19//
17 17
diff --git a/pages/develop/api/efl/net/dialer/http/property/proxy.txt b/pages/develop/api/efl/net/dialer/http/property/proxy.txt
index f96030c..4e45f58 100644
--- a/pages/develop/api/efl/net/dialer/http/property/proxy.txt
+++ b/pages/develop/api/efl/net/dialer/http/property/proxy.txt
@@ -7,7 +7,7 @@
7 7
8%%- protocol://username:password@proxyserver:port%% 8%%- protocol://username:password@proxyserver:port%%
9 9
10%%Where protocol is defined per class, such as a TCP or UDP dialer will use 'socks4', 'socks4a', 'socks5' or 'socks5h'; while http and websocket will want those or 'http'.%% 10%%Where protocol is defined by class, such as a TCP or UDP, dialer will use 'socks4', 'socks4a', 'socks5' or 'socks5h'; while http and websocket will want those or 'http'.%%
11 11
12%%Whenever appropriate dialers may use system proxy if the proxy is NULL (the default). To forcefully disable proxy, use an empty string ("").%% 12%%Whenever appropriate dialers may use system proxy if the proxy is NULL (the default). To forcefully disable proxy, use an empty string ("").%%
13 13
diff --git a/pages/develop/api/efl/net/dialer/http/property/ssl_verify.txt b/pages/develop/api/efl/net/dialer/http/property/ssl_verify.txt
index 2ac0f17..86b0002 100644
--- a/pages/develop/api/efl/net/dialer/http/property/ssl_verify.txt
+++ b/pages/develop/api/efl/net/dialer/http/property/ssl_verify.txt
@@ -11,7 +11,7 @@
11===== Values ===== 11===== Values =====
12 12
13 * **peer** - %%If %%''true''%%, SSL certificate will be verified. If %%''false''%%, untrusted certificates (including self signed) will be accepted.%% 13 * **peer** - %%If %%''true''%%, SSL certificate will be verified. If %%''false''%%, untrusted certificates (including self signed) will be accepted.%%
14 * **hostname** - %%If %%''true''%%, in addition to SSL certificate validation, the server name will be matched to certificate DNS entries%% 14 * **hostname** - %%If %%''true''%%, in addition to SSL certificate validation the server name will be matched to certificate DNS entries%%
15 15
16===== Signature ===== 16===== Signature =====
17 17