docs: ecore_con: add missing docs for new efl_net_* components

This commit is contained in:
Stefan Schmidt 2016-11-07 15:58:54 +01:00
parent a06aa07001
commit 9a10b83281
5 changed files with 23 additions and 23 deletions

View File

@ -47,7 +47,7 @@ interface Efl.Net.Server {
dispatched.
]]
params {
address: string @nonull;
address: string @nonull; [[Address to run server on]]
}
return: Eina.Error;
}
@ -66,7 +66,7 @@ interface Efl.Net.Server {
get { }
set @protected { }
values {
address: string;
address: string; [[Address the server is bound to]]
}
}
@ -75,7 +75,7 @@ interface Efl.Net.Server {
get { }
set @protected { }
values {
count: uint;
count: uint; [[Number of connected clients]]
}
}
@ -94,8 +94,8 @@ interface Efl.Net.Server {
alredy exceeds the limit, no connections will be closed.
]]
values {
limit: uint;
reject_excess: bool @optional;
limit: uint; [[Number of allowed client connections]]
reject_excess: bool @optional; [[If $true connection is accepted and immediately closed]]
}
}
@ -108,7 +108,7 @@ interface Efl.Net.Server {
get { }
set @protected { }
values {
serving: bool;
serving: bool; [[$true if server is ready to accept connections, $false otherwise]]
}
}
}

View File

@ -64,7 +64,7 @@ class Efl.Net.Server.Fd (Efl.Loop.Fd, Efl.Net.Server) {
get { }
set @protected { }
values {
family: int;
family: int; [[Socket address family]]
}
}
@ -80,7 +80,7 @@ class Efl.Net.Server.Fd (Efl.Loop.Fd, Efl.Net.Server) {
return: bool (false); [[$true on success]]
}
values {
close_on_exec: bool;
close_on_exec: bool; [[If $true close on exec will be used, $false otherwise]]
}
}
@ -91,7 +91,7 @@ class Efl.Net.Server.Fd (Efl.Loop.Fd, Efl.Net.Server) {
return: bool (false); [[$true on success]]
}
values {
reuse_address: bool;
reuse_address: bool; [[If $true the server will reuse the address, $false otherwise]]
}
}
@ -102,7 +102,7 @@ class Efl.Net.Server.Fd (Efl.Loop.Fd, Efl.Net.Server) {
return: bool (false); [[$true on success]]
}
values {
reuse_port: bool;
reuse_port: bool; [[If $true the server will reuse the port, $false otherwise]]
}
}

View File

@ -14,7 +14,7 @@ class Efl.Net.Server.Ssl (Efl.Loop_User, Efl.Net.Server) {
If changed in runtime, it will only affect new clients.
]]
values {
ssl_context: Efl.Net.Ssl.Context;
ssl_context: Efl.Net.Ssl.Context; [[SSL context]]
}
}
@ -64,7 +64,7 @@ class Efl.Net.Server.Ssl (Efl.Loop_User, Efl.Net.Server) {
]]
get { }
values {
family: int;
family: int; [[Socket address family]]
}
}
@ -80,7 +80,7 @@ class Efl.Net.Server.Ssl (Efl.Loop_User, Efl.Net.Server) {
return: bool (false); [[$true on success]]
}
values {
close_on_exec: bool;
close_on_exec: bool; [[If $true close on exec will be used, $false otherwise]]
}
}
@ -91,7 +91,7 @@ class Efl.Net.Server.Ssl (Efl.Loop_User, Efl.Net.Server) {
return: bool (false); [[$true on success]]
}
values {
reuse_address: bool;
reuse_address: bool; [[If $true the server will reuse the address, $false otherwise]]
}
}
@ -102,7 +102,7 @@ class Efl.Net.Server.Ssl (Efl.Loop_User, Efl.Net.Server) {
return: bool (false); [[$true on success]]
}
values {
reuse_port: bool;
reuse_port: bool; [[If $true the server will reuse the port, $false otherwise]]
}
}
@ -129,7 +129,7 @@ class Efl.Net.Server.Ssl (Efl.Loop_User, Efl.Net.Server) {
(allows only IPv6 clients).
]]
values {
ipv6_only: bool;
ipv6_only: bool; [[If $true the server will only accept IPv6 clients, $false otherwise]]
}
}
}

View File

@ -28,7 +28,7 @@ class Efl.Net.Server.Tcp (Efl.Net.Server.Fd) {
(allows only IPv6 clients).
]]
values {
ipv6_only: bool;
ipv6_only: bool; [[If $true the server will only accept IPv6 clients, $false otherwise]]
}
}
}

View File

@ -28,7 +28,7 @@ class Efl.Net.Server.Udp (Efl.Net.Server.Fd) {
(allows only IPv6 clients).
]]
values {
ipv6_only: bool;
ipv6_only: bool; [[If $true the server will only accept IPv6 clients, $false otherwise]]
}
}
@ -45,7 +45,7 @@ class Efl.Net.Server.Udp (Efl.Net.Server.Fd) {
return: bool (false); [[$true on success]]
}
values {
dont_route: bool;
dont_route: bool; [[If $true limit packets to the local network, $false otherwise]]
}
}
@ -65,7 +65,7 @@ class Efl.Net.Server.Udp (Efl.Net.Server.Fd) {
ff02::1@1 - use loopback interface (idx=1)
]]
params {
address: string @nonull;
address: string @nonull; [[Multicast group address]]
}
return: Eina.Error;
}
@ -76,7 +76,7 @@ class Efl.Net.Server.Udp (Efl.Net.Server.Fd) {
This reverses the effect of @.multicast_join.
]]
params {
address: string @nonull;
address: string @nonull; [[Multicast group address]]
}
return: Eina.Error;
}
@ -87,7 +87,7 @@ class Efl.Net.Server.Udp (Efl.Net.Server.Fd) {
The iterator is only valid until a new group is joined
or left using @.multicast_join or @.multicast_leave.
]]
return: free(own(iterator<string>), eina_iterator_free);
return: free(own(iterator<string>), eina_iterator_free); [[List of multicast groups]]
}
@property multicast_time_to_live {
@ -115,7 +115,7 @@ class Efl.Net.Server.Udp (Efl.Net.Server.Fd) {
return: Eina.Error; [[0 on success, error code otherwise]]
}
values {
loopback: bool;
loopback: bool; [[$true when multicast packets are looped back, $false otherwise]]
}
}
}