forked from enlightenment/efl
ecore_con_base: converted docs
This commit is contained in:
parent
9f8f6c2b53
commit
69b9f0044b
|
@ -4,40 +4,36 @@ abstract Ecore.Con.Base (Eo.Base) {
|
|||
data: null;
|
||||
methods {
|
||||
@property ip {
|
||||
/*@
|
||||
* Control the IP address of a server that has been connected to.
|
||||
*
|
||||
* The param is a pointer to an internal string that contains the IP address of
|
||||
* the connected server in the form "XXX.YYY.ZZZ.AAA" IP notation.
|
||||
* This string should not be modified or trusted to stay valid after
|
||||
* deletion for the @p svr object. If no IP is known @c NULL is
|
||||
* returned.
|
||||
*/
|
||||
[[Control the IP address of a server that has been connected to.
|
||||
|
||||
The param is a pointer to an internal string that contains the IP
|
||||
address of the connected server in the form "XXX.YYY.ZZZ.AAA" IP
|
||||
notation. This string should not be modified or trusted to stay
|
||||
valid after deletion for the svr object. If no IP is known
|
||||
null is returned.
|
||||
]]
|
||||
get {
|
||||
legacy: null;
|
||||
}
|
||||
values {
|
||||
ip: const(char)*; /*@ The IP address */
|
||||
ip: const(char)*; [[The IP address]]
|
||||
}
|
||||
}
|
||||
@property uptime {
|
||||
/*@
|
||||
* @brief Check how long the object has been connected
|
||||
*
|
||||
* This function is used to find out how long a client has been connected for.
|
||||
*/
|
||||
[[Check how long the object has been connected
|
||||
|
||||
This function is used to find out how long a client has been
|
||||
connected for.
|
||||
]]
|
||||
get {
|
||||
legacy: null;
|
||||
}
|
||||
values {
|
||||
uptime: double; /*@ The total time, in seconds, that the object has been connected. */
|
||||
uptime: double; [[The total time, in seconds, that the object has been connected.]]
|
||||
}
|
||||
}
|
||||
@property port {
|
||||
/*@
|
||||
* @brief Return the port that the obj is connected to
|
||||
*
|
||||
*/
|
||||
[[Return the port that the obj is connected to]]
|
||||
set {
|
||||
legacy: null;
|
||||
}
|
||||
|
@ -45,50 +41,54 @@ abstract Ecore.Con.Base (Eo.Base) {
|
|||
legacy: null;
|
||||
}
|
||||
values {
|
||||
port: int; /*@ The The port that obj is connected to, or -1 on error. */
|
||||
port: int; [[The The port that obj is connected to, or -1 on error.]]
|
||||
}
|
||||
}
|
||||
@property fd {
|
||||
/*@
|
||||
* Get the fd that the server is connected to
|
||||
*
|
||||
* This function returns the fd which is used by the underlying server connection.
|
||||
* It should not be tampered with unless you REALLY know what you are doing.
|
||||
* @note This function is only valid for servers created with ecore_con_server_connect()
|
||||
* @warning Seriously. Don't use this unless you know what you are doing.
|
||||
* @since 1.1
|
||||
*/
|
||||
[[Get the fd that the server is connected to
|
||||
|
||||
This function returns the fd which is used by the underlying server
|
||||
connection. It should not be tampered with unless you REALLY know
|
||||
what you are doing.
|
||||
|
||||
Note: This function is only valid for servers created with
|
||||
@ecore_con_server_connect.
|
||||
|
||||
Warning: Seriously. Don't use this unless you know what you are doing.
|
||||
|
||||
@since 1.1
|
||||
]]
|
||||
get {
|
||||
legacy: null;
|
||||
}
|
||||
values {
|
||||
fd: int; /*@ The fd, or -1 on failure. */
|
||||
fd: int; [[The fd, or -1 on failure.]]
|
||||
}
|
||||
}
|
||||
@property connected {
|
||||
/*@
|
||||
* Returns whether the client is still connected
|
||||
*/
|
||||
[[Returns whether the client is still connected]]
|
||||
get {
|
||||
legacy: null;
|
||||
}
|
||||
values {
|
||||
connected: bool; /*@ Returns True if connected, False otherwise. */
|
||||
connected: bool; [[Returns true if connected, false otherwise.]]
|
||||
}
|
||||
}
|
||||
@property timeout {
|
||||
/*@
|
||||
* Control the default time after which an inactive client will be disconnected
|
||||
*
|
||||
* This function is used by the server to set the default idle timeout on
|
||||
* clients. If the any of the clients becomes idle for a time higher than this
|
||||
* value, it will be disconnected. A value of < 1 disables the idle timeout.
|
||||
*
|
||||
* This timeout is not affected by the one set by
|
||||
* ecore_con_client_timeout_set(). A client will be disconnected whenever the
|
||||
* client or the server timeout is reached. That means, the lower timeout value
|
||||
* will be used for that client if ecore_con_client_timeout_set() is used on it.
|
||||
*/
|
||||
[[Control the default time after which an inactive client will be
|
||||
disconnected.
|
||||
|
||||
This function is used by the server to set the default idle timeout
|
||||
on clients. If the any of the clients becomes idle for a time higher
|
||||
than this value, it will be disconnected. A value of < 1 disables
|
||||
the idle timeout.
|
||||
|
||||
This timeout is not affected by the one set by
|
||||
@ecore_con_client_timeout_set. A client will be disconnected
|
||||
whenever the client or the server timeout is reached. That means,
|
||||
the lower timeout value will be used for that client if
|
||||
@ecore_con_client_timeout_set is used on it.
|
||||
]]
|
||||
set {
|
||||
legacy: null;
|
||||
}
|
||||
|
@ -96,62 +96,53 @@ abstract Ecore.Con.Base (Eo.Base) {
|
|||
legacy: null;
|
||||
}
|
||||
values {
|
||||
timeout: double; /*@ The timeout, in seconds, to disconnect after. */
|
||||
timeout: double; [[The timeout, in seconds, to disconnect after.]]
|
||||
}
|
||||
}
|
||||
flush {
|
||||
/*@
|
||||
* Flushes all pending data to the given server.
|
||||
*
|
||||
* This function will block until all data is sent to the server.
|
||||
*/
|
||||
[[Flushes all pending data to the given server.
|
||||
|
||||
This function will block until all data is sent to the server.
|
||||
]]
|
||||
legacy: null;
|
||||
}
|
||||
send {
|
||||
/*@
|
||||
* Sends the given data to the given server.
|
||||
*
|
||||
* This function will send the given data to the server as soon as the program
|
||||
* is back to the main loop. Thus, this function returns immediately
|
||||
* (non-blocking). If the data needs to be sent @b now, call
|
||||
* ecore_con_server_flush() after this one.
|
||||
*
|
||||
* @see ecore_con_client_send()
|
||||
* @see ecore_con_server_flush()
|
||||
*/
|
||||
[[Sends the given data to the given server.
|
||||
|
||||
This function will send the given data to the server as soon as the
|
||||
program is back to the main loop. Thus, this function returns
|
||||
immediately (non-blocking). If the data needs to be sent now, call
|
||||
@ecore_con_server_flush after this one.
|
||||
|
||||
See also @ecore_con_client_send and @ecore_con_server_flush.
|
||||
]]
|
||||
legacy: null;
|
||||
|
||||
params {
|
||||
data: const(void)*; /*@ The given data */
|
||||
size: int; /*@ Length of the data, in bytes. */
|
||||
data: const(void)*; [[The given data]]
|
||||
size: int; [[Length of the data, in bytes.]]
|
||||
}
|
||||
return: int; /*@ The number of bytes sent. @c 0 will be returned if there is an error. */
|
||||
return: int; [[The number of bytes sent. 0 will be returned if there
|
||||
is an error.]]
|
||||
}
|
||||
lookup @class {
|
||||
/*@
|
||||
* Do an asynchronous DNS lookup.
|
||||
*
|
||||
* @param name IP address or server name to translate.
|
||||
* @param done_cb Callback to notify when done.
|
||||
* @param data User data to be given to done_cb.
|
||||
* @return @c EINA_TRUE if the request did not fail to be set up, @c EINA_FALSE
|
||||
* if it failed.
|
||||
*
|
||||
* This function performs a DNS lookup on the hostname specified by @p name,
|
||||
* then calls @p done_cb with the result and the @p data given as parameter.
|
||||
* The result will be given to the @p done_cb as follows:
|
||||
* @li @c canonname - the canonical name of the address
|
||||
* @li @c ip - the resolved ip address
|
||||
* @li @c addr - a pointer to the socket address
|
||||
* @li @c addrlen - the length of the socket address, in bytes
|
||||
* @li @c data - the data pointer given as parameter to ecore_con_lookup()
|
||||
*/
|
||||
[[Do an asynchronous DNS lookup.
|
||||
|
||||
This function performs a DNS lookup on the hostname specified by name,
|
||||
then calls done_cb with the result and the data given as parameter.
|
||||
The result will be given to the done_cb as follows:
|
||||
|
||||
canonname - the canonical name of the address, ip - the resolved ip
|
||||
address, addr - a pointer to the socket address, addrlen - the length
|
||||
of the socket address, in bytes, data - the data pointer given as
|
||||
arameter to @ecore_con_lookup.
|
||||
]]
|
||||
params {
|
||||
name: const(char)* @nonull; /*@ Hostname to lookup. */
|
||||
done_cb: Ecore_Con_Dns_Cb; /*@ The callback to be called wehn lookup is done. */
|
||||
data: const(void)*; /*@ User data for the callback. */
|
||||
name: const(char)* @nonull; [[IP address or server name to translate.]]
|
||||
done_cb: Ecore_Con_Dns_Cb; [[Callback to notify when done.]]
|
||||
data: const(void)*; [[User data to be given to done_cb.]]
|
||||
}
|
||||
return: bool;
|
||||
return: bool; [[true if the request did not fail to be set up, false otherwise.]]
|
||||
}
|
||||
}
|
||||
implements {
|
||||
|
|
Loading…
Reference in New Issue