Difference between revisions of "enet.peer:timeout"
(Created page with "Returns or sets the parameters when a timeout is detected. This is happens either after a fixed timeout or a variable timeout of time that takes the round trip time into account....") |
(Separated the two functionalities.) |
||
| Line 9: | Line 9: | ||
{{param|number|minimum|Timeout value, in milliseconds, that a reliable packet has to be acknowledged if the variable timeout limit was exceeded before dropping the [[enet.peer | peer]].}} | {{param|number|minimum|Timeout value, in milliseconds, that a reliable packet has to be acknowledged if the variable timeout limit was exceeded before dropping the [[enet.peer | peer]].}} | ||
{{param|number|maximum|Fixed timeout in milliseconds for which any packet has to be acknowledged before dropping the [[enet.peer | peer]].}} | {{param|number|maximum|Fixed timeout in milliseconds for which any packet has to be acknowledged before dropping the [[enet.peer | peer]].}} | ||
| + | === Returns === | ||
| + | Nothing. | ||
| + | === Synopsis === | ||
| + | <source lang="lua"> | ||
| + | peer:timeout() | ||
| + | </source> | ||
| + | === Arguments === | ||
| + | None. | ||
=== Returns === | === Returns === | ||
{{param|number|limit|A factor that is multiplied with a value that based on the average [[enet.peer:round_trip_time | round trip time]] to compute the timeout limit.}} | {{param|number|limit|A factor that is multiplied with a value that based on the average [[enet.peer:round_trip_time | round trip time]] to compute the timeout limit.}} | ||
Latest revision as of 02:05, 30 October 2016
Returns or sets the parameters when a timeout is detected. This is happens either after a fixed timeout or a variable timeout of time that takes the round trip time into account. The former is specified with the maximum parameter.
Contents
Function
Synopsis
peer:timeout(limit, minimum, maximum)
Arguments
number limit- A factor that is multiplied with a value that based on the average round trip time to compute the timeout limit.
number minimum- Timeout value, in milliseconds, that a reliable packet has to be acknowledged if the variable timeout limit was exceeded before dropping the peer.
number maximum- Fixed timeout in milliseconds for which any packet has to be acknowledged before dropping the peer.
Returns
Nothing.
Synopsis
peer:timeout()
Arguments
None.
Returns
number limit- A factor that is multiplied with a value that based on the average round trip time to compute the timeout limit.
number minimum- Timeout value, in milliseconds, that a reliable packet has to be acknowledged if the variable timeout limit was exceeded before dropping the peer.
number maximum- Fixed timeout in milliseconds for which any packet has to be acknowledged before dropping the peer.
See Also
Other Languages
Dansk –
Deutsch –
English –
Español –
Français –
Indonesia –
Italiano –
Lietuviškai –
Magyar –
Nederlands –
Polski –
Português –
Română –
Slovenský –
Suomi –
Svenska –
Türkçe –
Česky –
Ελληνικά –
Български –
Русский –
Српски –
Українська –
עברית –
ไทย –
日本語 –
正體中文 –
简体中文 –
Tiếng Việt –
한국어
More info
