summaryrefslogtreecommitdiff
path: root/pages/develop/api/efl/net/dialer/http
diff options
context:
space:
mode:
authorAndy Williams <andy@andywilliams.me>2017-12-11 17:26:46 +0000
committerAndy Williams <andy@andywilliams.me>2017-12-11 17:26:51 +0000
commit33400287a1b67d493751e3e6a75a96e77f89e8a6 (patch)
tree15a8df52042726bdf3c91eb21958f79e7a195ff7 /pages/develop/api/efl/net/dialer/http
parentfe20efc8058230f9f592077e18421823c5246c22 (diff)
Fix API linking in docs
Diffstat (limited to 'pages/develop/api/efl/net/dialer/http')
-rw-r--r--pages/develop/api/efl/net/dialer/http/method/request_header_add.txt2
-rw-r--r--pages/develop/api/efl/net/dialer/http/method/request_headers_clear.txt2
-rw-r--r--pages/develop/api/efl/net/dialer/http/method/response_headers_all_get.txt4
-rw-r--r--pages/develop/api/efl/net/dialer/http/method/response_headers_get.txt4
-rw-r--r--pages/develop/api/efl/net/dialer/http/property/address_dial.txt4
-rw-r--r--pages/develop/api/efl/net/dialer/http/property/authentication.txt2
-rw-r--r--pages/develop/api/efl/net/dialer/http/property/can_read.txt2
-rw-r--r--pages/develop/api/efl/net/dialer/http/property/can_write.txt2
-rw-r--r--pages/develop/api/efl/net/dialer/http/property/primary_mode.txt12
9 files changed, 17 insertions, 17 deletions
diff --git a/pages/develop/api/efl/net/dialer/http/method/request_header_add.txt b/pages/develop/api/efl/net/dialer/http/method/request_header_add.txt
index 61ade1f..915f9fe 100644
--- a/pages/develop/api/efl/net/dialer/http/method/request_header_add.txt
+++ b/pages/develop/api/efl/net/dialer/http/method/request_header_add.txt
@@ -25,7 +25,7 @@ void efl_net_dialer_http_request_header_add(Eo *obj, const char *key, const char
25 25
26%%Adds a request header 'key: value'.%% 26%%Adds a request header 'key: value'.%%
27 27
28%%See %%[[:develop:api:class:efl:net:dialer:http:method:request_headers_clear|Efl.Net.Dialer.Http.request_headers_clear]]%%%% 28%%See %%[[:develop:api:efl:net:dialer:http:method:request_headers_clear|Efl.Net.Dialer.Http.request_headers_clear]]%%%%
29 29
30%%This should be called before dialing.%% 30%%This should be called before dialing.%%
31 31
diff --git a/pages/develop/api/efl/net/dialer/http/method/request_headers_clear.txt b/pages/develop/api/efl/net/dialer/http/method/request_headers_clear.txt
index 275fff7..452a7b8 100644
--- a/pages/develop/api/efl/net/dialer/http/method/request_headers_clear.txt
+++ b/pages/develop/api/efl/net/dialer/http/method/request_headers_clear.txt
@@ -15,7 +15,7 @@ void efl_net_dialer_http_request_headers_clear(Eo *obj);
15 15
16%%Clears all request headers.%% 16%%Clears all request headers.%%
17 17
18%%See %%[[:develop:api:class:efl:net:dialer:http:method:request_header_add|Efl.Net.Dialer.Http.request_header_add]]%%%% 18%%See %%[[:develop:api:efl:net:dialer:http:method:request_header_add|Efl.Net.Dialer.Http.request_header_add]]%%%%
19 19
20%%This should be called before dialing.%% 20%%This should be called before dialing.%%
21 21
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 efeb507..2f08040 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
@@ -17,13 +17,13 @@ Eina_Iterator *efl_net_dialer_http_response_headers_all_get(Eo *obj);
17 17
18%%Returns an iterator to the key-value pairs for all response headers.%% 18%%Returns an iterator to the key-value pairs for all response headers.%%
19 19
20%%Since multiple requests can happen if %%[[:develop:api:class: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:%% 20%%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:%%
21 21
22%%- 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"%% 22%%- 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"%%
23 23
24%%Which mean the original request had a redirect to http://someredirect.com.%% 24%%Which mean the original request had a redirect to http://someredirect.com.%%
25 25
26%%To receive an iterator to just the last request, use %%[[:develop:api:class:efl:net:dialer:http:method:response_headers_get|Efl.Net.Dialer.Http.response_headers_get]]%%%% 26%%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]]%%%%
27 27
28%%This will be usable after "headers,done" event is dispatched.%% 28%%This will be usable after "headers,done" event is dispatched.%%
29 29
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 d6346ad..490d9d3 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
@@ -17,9 +17,9 @@ Eina_Iterator *efl_net_dialer_http_response_headers_get(Eo *obj);
17 17
18%%Returns an iterator to the key-value pairs for the last response headers.%% 18%%Returns an iterator to the key-value pairs for the last response headers.%%
19 19
20%%Since multiple requests can happen if %%[[:develop:api:class: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.%% 20%%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.%%
21 21
22%%To know all the headers, check %%[[:develop:api:class:efl:net:dialer:http:method:response_headers_all_get|Efl.Net.Dialer.Http.response_headers_all_get]]%%.%% 22%%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]]%%.%%
23 23
24%%This will be usable after "headers,done" event is dispatched.%% 24%%This will be usable after "headers,done" event is dispatched.%%
25 25
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 b247112..506b8ae 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
@@ -28,9 +28,9 @@ void efl_net_dialer_address_dial_set(Eo *obj, const char *address);
28 * **address** - %%Remote address%% 28 * **address** - %%Remote address%%
29===== Description ===== 29===== Description =====
30 30
31%%Returns the address given to %%[[:develop:api:interface:efl:net:dialer:method:dial|Efl.Net.Dialer.dial]]%%.%% 31%%Returns the address given to %%[[:develop:api:efl:net:dialer:method:dial|Efl.Net.Dialer.dial]]%%.%%
32 32
33%%If the resolved address is desired, then listen to "resolved" event and use the %%[[:develop:api:interface:efl:net:socket:property:address_remote|Efl.Net.Socket.address_remote]]%% property.%% 33%%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.%%
34 34
35//Since 1.19// 35//Since 1.19//
36{{page>:develop:api-include:efl:net:dialer:http:property:address_dial:description&nouser&nolink&nodate}} 36{{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/authentication.txt b/pages/develop/api/efl/net/dialer/http/property/authentication.txt
index 2f472ef..1eac9b7 100644
--- a/pages/develop/api/efl/net/dialer/http/property/authentication.txt
+++ b/pages/develop/api/efl/net/dialer/http/property/authentication.txt
@@ -33,7 +33,7 @@ void efl_net_dialer_http_authentication_set(Eo *obj, const char *username, const
33 33
34 * **username** - %%HTTP authentication username%% 34 * **username** - %%HTTP authentication username%%
35 * **password** - %%HTTP authentication password%% 35 * **password** - %%HTTP authentication password%%
36 * **method** - %%Authentication method to use, defaults to %%[[:develop:api:enum:efl:net:http:authentication_method|Efl.Net.Http.Authentication_Method.basic]]%%%% 36 * **method** - %%Authentication method to use, defaults to %%[[:develop:api:efl:net:http:authentication_method|Efl.Net.Http.Authentication_Method.basic]]%%%%
37 * **restricted** - %%Restrict method%% 37 * **restricted** - %%Restrict method%%
38===== Description ===== 38===== Description =====
39 39
diff --git a/pages/develop/api/efl/net/dialer/http/property/can_read.txt b/pages/develop/api/efl/net/dialer/http/property/can_read.txt
index b29b8d0..42237af 100644
--- a/pages/develop/api/efl/net/dialer/http/property/can_read.txt
+++ b/pages/develop/api/efl/net/dialer/http/property/can_read.txt
@@ -28,7 +28,7 @@ void efl_io_reader_can_read_set(Eo *obj, Eina_Bool can_read);
28 * **can_read** - %%%%''true''%% if it can be read without blocking or failing, %%''false''%% otherwise%% 28 * **can_read** - %%%%''true''%% if it can be read without blocking or failing, %%''false''%% otherwise%%
29===== Description ===== 29===== Description =====
30 30
31%%If %%''true''%% will notify %%[[:develop:api:interface:efl:io:reader:method:read|Efl.Io.Reader.read]]%% can be called without blocking or failing.%% 31%%If %%''true''%% will notify %%[[:develop:api:efl:io:reader:method:read|Efl.Io.Reader.read]]%% can be called without blocking or failing.%%
32 32
33//Since 1.19// 33//Since 1.19//
34{{page>:develop:api-include:efl:net:dialer:http:property:can_read:description&nouser&nolink&nodate}} 34{{page>:develop:api-include:efl:net:dialer:http:property:can_read:description&nouser&nolink&nodate}}
diff --git a/pages/develop/api/efl/net/dialer/http/property/can_write.txt b/pages/develop/api/efl/net/dialer/http/property/can_write.txt
index 4983a9e..83748ad 100644
--- a/pages/develop/api/efl/net/dialer/http/property/can_write.txt
+++ b/pages/develop/api/efl/net/dialer/http/property/can_write.txt
@@ -28,7 +28,7 @@ void efl_io_writer_can_write_set(Eo *obj, Eina_Bool can_write);
28 * **can_write** - %%%%''true''%% if it can be written without blocking or failure, %%''false''%% otherwise%% 28 * **can_write** - %%%%''true''%% if it can be written without blocking or failure, %%''false''%% otherwise%%
29===== Description ===== 29===== Description =====
30 30
31%%If %%''true''%% will notify %%[[:develop:api:interface:efl:io:writer:method:write|Efl.Io.Writer.write]]%% can be called without blocking or failing.%% 31%%If %%''true''%% will notify %%[[:develop:api:efl:io:writer:method:write|Efl.Io.Writer.write]]%% can be called without blocking or failing.%%
32 32
33//Since 1.19// 33//Since 1.19//
34{{page>:develop:api-include:efl:net:dialer:http:property:can_write:description&nouser&nolink&nodate}} 34{{page>:develop:api-include:efl:net:dialer:http:property:can_write: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 19a8caf..15f0951 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
@@ -30,15 +30,15 @@ void efl_net_dialer_http_primary_mode_set(Eo *obj, Efl_Net_Dialer_Http_Primary_M
30 30
31%%Is this request primarily a download or upload?%% 31%%Is this request primarily a download or upload?%%
32 32
33%%This property will change the behavior of %%[[:develop:api:mixin:efl:io:sizer|Efl.Io.Sizer]]%%:%% 33%%This property will change the behavior of %%[[:develop:api:efl:io:sizer|Efl.Io.Sizer]]%%:%%
34 34
35%%- If %%[[:develop:api:enum:efl:net:dialer:http:primary_mode|Efl.Net.Dialer.Http.Primary_Mode.auto]]%%, then %%[[:develop:api:enum:efl:net:dialer:http:primary_mode|Efl.Net.Dialer.Http.Primary_Mode.download]]%% or %%[[:develop:api:enum:efl:net:dialer:http:primary_mode|Efl.Net.Dialer.Http.Primary_Mode.upload]]%% will be choosen based on the %%[[:develop:api:class:efl:net:dialer:http:property:method|Efl.Net.Dialer.Http.method]]%%: if "PUT", then it's upload, otherwise it's download.%% 35%%- If %%[[:develop:api:efl:net:dialer:http:primary_mode|Efl.Net.Dialer.Http.Primary_Mode.auto]]%%, then %%[[:develop:api:efl:net:dialer:http:primary_mode|Efl.Net.Dialer.Http.Primary_Mode.download]]%% or %%[[:develop:api:efl:net:dialer:http:primary_mode|Efl.Net.Dialer.Http.Primary_Mode.upload]]%% will be choosen based on the %%[[:develop:api:efl:net:dialer:http:property:method|Efl.Net.Dialer.Http.method]]%%: if "PUT", then it's upload, otherwise it's download.%%
36 36
37%%- If %%[[:develop:api:enum:efl:net:dialer:http:primary_mode|Efl.Net.Dialer.Http.Primary_Mode.upload]]%%, applying a new size with %%[[:develop:api:mixin:efl:io:sizer:method:resize|Efl.Io.Sizer.resize]]%% or %%[[:develop:api:mixin:efl:io:sizer:property:size|Efl.Io.Sizer.size.set]]%% will specify the "Content-Length" to upload. If no size is previously set, then the upload will happen in "Transfer-encoding: chunked".%% 37%%- If %%[[:develop:api:efl:net:dialer:http:primary_mode|Efl.Net.Dialer.Http.Primary_Mode.upload]]%%, applying a new size with %%[[:develop:api:efl:io:sizer:method:resize|Efl.Io.Sizer.resize]]%% or %%[[:develop:api:efl:io:sizer:property:size|Efl.Io.Sizer.size.set]]%% will specify the "Content-Length" to upload. If no size is previously set, then the upload will happen in "Transfer-encoding: chunked".%%
38 38
39%%- If %%[[:develop:api:enum:efl:net:dialer:http:primary_mode|Efl.Net.Dialer.Http.Primary_Mode.download]]%%, then %%[[:develop:api:mixin:efl:io:sizer:property:size|Efl.Io.Sizer.size.get]]%% will report the "Content-Length" provided by the server, if any.%% 39%%- 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.%%
40 40
41%%If is worth to mention that one can provide and retrieve these values using %%[[:develop:api:class:efl:net:dialer:http:method:request_headers_get|Efl.Net.Dialer.Http.request_headers_get]]%% (to send) and %%[[:develop:api:class: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:class:efl:net:dialer:http:property:request_content_length|Efl.Net.Dialer.Http.request_content_length]]%% (upload) and %%[[:develop:api:class:efl:net:dialer:http:property:response_content_length|Efl.Net.Dialer.Http.response_content_length]]%% (download).%% 41%%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).%%
42 42
43//Since 1.19// 43//Since 1.19//
44 44
@@ -49,7 +49,7 @@ void efl_net_dialer_http_primary_mode_set(Eo *obj, Efl_Net_Dialer_Http_Primary_M
49 49
50%%The effective primary mode.%% 50%%The effective primary mode.%%
51 51
52%%This will return one of %%[[:develop:api:enum:efl:net:dialer:http:primary_mode|Efl.Net.Dialer.Http.Primary_Mode.download]]%% or %%[[:develop:api:enum:efl:net:dialer:http:primary_mode|Efl.Net.Dialer.Http.Primary_Mode.upload]]%%. If "auto" was set (the default), then it will pick the best based on the %%[[:develop:api:class:efl:net:dialer:http:property:method|Efl.Net.Dialer.Http.method]]%% in use.%% 52%%This will return one of %%[[:develop:api:efl:net:dialer:http:primary_mode|Efl.Net.Dialer.Http.Primary_Mode.download]]%% or %%[[:develop:api:efl:net:dialer:http:primary_mode|Efl.Net.Dialer.Http.Primary_Mode.upload]]%%. If "auto" was set (the default), then it will pick the best based on the %%[[:develop:api:efl:net:dialer:http:property:method|Efl.Net.Dialer.Http.method]]%% in use.%%
53 53
54//Since 1.19// 54//Since 1.19//
55{{page>:develop:api-include:efl:net:dialer:http:property:primary_mode:getter_description&nouser&nolink&nodate}} 55{{page>:develop:api-include:efl:net:dialer:http:property:primary_mode:getter_description&nouser&nolink&nodate}}