diff options
| author | Fabio Alessandrelli <fabio.alessandrelli@gmail.com> | 2019-06-15 17:13:26 +0200 |
|---|---|---|
| committer | Fabio Alessandrelli <fabio.alessandrelli@gmail.com> | 2019-06-15 17:21:08 +0200 |
| commit | 5b2f098ed4444572432eb2e67c154f89852039ec (patch) | |
| tree | 5ebc7fdcad6dff1e48fc4fece39000d28a2b22d1 /modules/websocket/doc_classes | |
| parent | ee90da4acbf8769d37b32e971434733d051a5e49 (diff) | |
Expose WebSocket set_buffers and document it.
Diffstat (limited to 'modules/websocket/doc_classes')
| -rw-r--r-- | modules/websocket/doc_classes/WebSocketMultiplayerPeer.xml | 18 |
1 files changed, 18 insertions, 0 deletions
diff --git a/modules/websocket/doc_classes/WebSocketMultiplayerPeer.xml b/modules/websocket/doc_classes/WebSocketMultiplayerPeer.xml index 8548d21323..103dbd771b 100644 --- a/modules/websocket/doc_classes/WebSocketMultiplayerPeer.xml +++ b/modules/websocket/doc_classes/WebSocketMultiplayerPeer.xml @@ -18,6 +18,24 @@ Returns the [WebSocketPeer] associated to the given [code]peer_id[/code]. </description> </method> + <method name="set_buffers"> + <return type="int" enum="Error"> + </return> + <argument index="0" name="input_buffer_size_kb" type="int"> + </argument> + <argument index="1" name="input_max_packets" type="int"> + </argument> + <argument index="2" name="output_buffer_size_kb" type="int"> + </argument> + <argument index="3" name="output_max_packets" type="int"> + </argument> + <description> + Configure the buffers sizes for this WebSocket peer. Default values can be specified in project settings under [code]network/limits[/code]. For server, values are meant per connected peer. + The first two parameters define the size and queued packets limits of the input buffer, the last two of the output buffer. + Buffer sizes are expressed in KiB, so [code]4 = 2^12 = 4096 bytes[/code]. All parameters will be rounded up to the nearest power of two. + NOTE: HTML5 exports only use the input buffer since the output one is managed by browsers. + </description> + </method> </methods> <signals> <signal name="peer_packet"> |