godotengine
/
godot
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity
godot/modules/websocket/doc_classes/WebSocketPeer.xml

86 lines
3.7 KiB
XML
Raw Normal View History

Document websocket module, further document enet
2018-05-08 12:40:08 +00:00
<?xml version="1.0" encoding="UTF-8" ?>
Update docs to version 4.0
2020-02-01 01:03:48 +00:00
<class name="WebSocketPeer" inherits="PacketPeer" version="4.0">
Document websocket module, further document enet
2018-05-08 12:40:08 +00:00
<brief_description>
A class representing a specific WebSocket connection.
</brief_description>
<description>
This class represent a specific WebSocket connection, you can do lower level operations with it.
You can choose to write to the socket in binary or text mode, and you can recognize the mode used for writing by the other peer.
</description>
<tutorials>
</tutorials>
<methods>
<method name="close">
doc: Use self-closing tags for `return` and `argument` For the time being we don't support writing a description for those, preferring having all details in the method's description. Using self-closing tags saves half the lines, and prevents contributors from thinking that they should write the argument or return documentation there.
2021-07-30 13:28:05 +00:00
<return type="void" />
<argument index="0" name="code" type="int" default="1000" />
<argument index="1" name="reason" type="String" default="&quot;&quot;" />
Document websocket module, further document enet
2018-05-08 12:40:08 +00:00
<description>
Proofread and improve the whole class reference - Document a few more properties and methods - Add more information to many classes - Fix lots of typos and gramar mistakes - Use [code] tags for parameters consistently - Use [b] and [i] tags consistently - Put "Warning:" and "Note:" on their own line to be more visible, and make them always bold - Tweak formatting in code examples to be more readable - Use double quotes consistently - Add more links to third-party technologies
2019-06-21 23:04:47 +00:00
Closes this WebSocket connection. [code]code[/code] is the status code for the closure (see RFC 6455 section 7.4 for a list of valid status codes). [code]reason[/code] is the human readable reason for closing the connection (can be any UTF-8 string that's smaller than 123 bytes).
[b]Note:[/b] To achieve a clean close, you will need to keep polling until either [signal WebSocketClient.connection_closed] or [signal WebSocketServer.client_disconnected] is received.
[b]Note:[/b] The HTML5 export might not support all status codes. Please refer to browser-specific documentation for more details.
Document websocket module, further document enet
2018-05-08 12:40:08 +00:00
</description>
</method>
<method name="get_connected_host" qualifiers="const">
doc: Use self-closing tags for `return` and `argument` For the time being we don't support writing a description for those, preferring having all details in the method's description. Using self-closing tags saves half the lines, and prevents contributors from thinking that they should write the argument or return documentation there.
2021-07-30 13:28:05 +00:00
<return type="String" />
Document websocket module, further document enet
2018-05-08 12:40:08 +00:00
<description>
Proofread and improve the whole class reference - Document a few more properties and methods - Add more information to many classes - Fix lots of typos and gramar mistakes - Use [code] tags for parameters consistently - Use [b] and [i] tags consistently - Put "Warning:" and "Note:" on their own line to be more visible, and make them always bold - Tweak formatting in code examples to be more readable - Use double quotes consistently - Add more links to third-party technologies
2019-06-21 23:04:47 +00:00
Returns the IP address of the connected peer.
[b]Note:[/b] Not available in the HTML5 export.
Document websocket module, further document enet
2018-05-08 12:40:08 +00:00
</description>
</method>
<method name="get_connected_port" qualifiers="const">
doc: Use self-closing tags for `return` and `argument` For the time being we don't support writing a description for those, preferring having all details in the method's description. Using self-closing tags saves half the lines, and prevents contributors from thinking that they should write the argument or return documentation there.
2021-07-30 13:28:05 +00:00
<return type="int" />
Document websocket module, further document enet
2018-05-08 12:40:08 +00:00
<description>
Proofread and improve the whole class reference - Document a few more properties and methods - Add more information to many classes - Fix lots of typos and gramar mistakes - Use [code] tags for parameters consistently - Use [b] and [i] tags consistently - Put "Warning:" and "Note:" on their own line to be more visible, and make them always bold - Tweak formatting in code examples to be more readable - Use double quotes consistently - Add more links to third-party technologies
2019-06-21 23:04:47 +00:00
Returns the remote port of the connected peer.
[b]Note:[/b] Not available in the HTML5 export.
Document websocket module, further document enet
2018-05-08 12:40:08 +00:00
</description>
</method>
Websocket peer outbound buffer fixes. Expose outbound buffered amount.
2021-07-29 20:11:27 +00:00
<method name="get_current_outbound_buffered_amount" qualifiers="const">
<return type="int" />
<description>
Returns the current amount of data in the outbound websocket buffer. [b]Note:[/b] HTML5 exports use WebSocket.bufferedAmount, while other platforms use an internal buffer.
</description>
</method>
Document websocket module, further document enet
2018-05-08 12:40:08 +00:00
<method name="get_write_mode" qualifiers="const">
doc: Use self-closing tags for `return` and `argument` For the time being we don't support writing a description for those, preferring having all details in the method's description. Using self-closing tags saves half the lines, and prevents contributors from thinking that they should write the argument or return documentation there.
2021-07-30 13:28:05 +00:00
<return type="int" enum="WebSocketPeer.WriteMode" />
Document websocket module, further document enet
2018-05-08 12:40:08 +00:00
<description>
Proofread and improve the whole class reference - Document a few more properties and methods - Add more information to many classes - Fix lots of typos and gramar mistakes - Use [code] tags for parameters consistently - Use [b] and [i] tags consistently - Put "Warning:" and "Note:" on their own line to be more visible, and make them always bold - Tweak formatting in code examples to be more readable - Use double quotes consistently - Add more links to third-party technologies
2019-06-21 23:04:47 +00:00
Gets the current selected write mode. See [enum WriteMode].
Document websocket module, further document enet
2018-05-08 12:40:08 +00:00
</description>
</method>
<method name="is_connected_to_host" qualifiers="const">
doc: Use self-closing tags for `return` and `argument` For the time being we don't support writing a description for those, preferring having all details in the method's description. Using self-closing tags saves half the lines, and prevents contributors from thinking that they should write the argument or return documentation there.
2021-07-30 13:28:05 +00:00
<return type="bool" />
Document websocket module, further document enet
2018-05-08 12:40:08 +00:00
<description>
Returns [code]true[/code] if this peer is currently connected.
</description>
</method>
Disable Nagle's algorithm for WebSocket TCP. This should greatly decrease latency for the most common use cases. A new function WebSocketPeer::set_no_delay will allow to configure it if so desired.
2020-01-28 13:06:28 +00:00
<method name="set_no_delay">
doc: Use self-closing tags for `return` and `argument` For the time being we don't support writing a description for those, preferring having all details in the method's description. Using self-closing tags saves half the lines, and prevents contributors from thinking that they should write the argument or return documentation there.
2021-07-30 13:28:05 +00:00
<return type="void" />
<argument index="0" name="enabled" type="bool" />
Disable Nagle's algorithm for WebSocket TCP. This should greatly decrease latency for the most common use cases. A new function WebSocketPeer::set_no_delay will allow to configure it if so desired.
2020-01-28 13:06:28 +00:00
<description>
Disable Nagle's algorithm on the underling TCP socket (default). See [method StreamPeerTCP.set_no_delay] for more information.
[b]Note:[/b] Not available in the HTML5 export.
</description>
</method>
Document websocket module, further document enet
2018-05-08 12:40:08 +00:00
<method name="set_write_mode">
doc: Use self-closing tags for `return` and `argument` For the time being we don't support writing a description for those, preferring having all details in the method's description. Using self-closing tags saves half the lines, and prevents contributors from thinking that they should write the argument or return documentation there.
2021-07-30 13:28:05 +00:00
<return type="void" />
<argument index="0" name="mode" type="int" enum="WebSocketPeer.WriteMode" />
Document websocket module, further document enet
2018-05-08 12:40:08 +00:00
<description>
Sets the socket to use the given [enum WriteMode].
</description>
</method>
<method name="was_string_packet" qualifiers="const">
doc: Use self-closing tags for `return` and `argument` For the time being we don't support writing a description for those, preferring having all details in the method's description. Using self-closing tags saves half the lines, and prevents contributors from thinking that they should write the argument or return documentation there.
2021-07-30 13:28:05 +00:00
<return type="bool" />
Document websocket module, further document enet
2018-05-08 12:40:08 +00:00
<description>
doc: Misc updates for AnimationNode* and others - Add some missing descriptions. - Add links to tutorials for ARVR and AnimationTree. - Style fixes. - Engine changes: * Make `AnimationNodeTransition.input_<number>` properties internal so that they don't appear in the docs. They still appear in the inspector based on the actual number of inputs requested. * Drop unimplemented `CPUParticles.flatness`. It's only used for 3D particles in `ParticlesMaterial`, and thus only relevant for `CPUParticles3D`.
2020-01-23 10:14:14 +00:00
Returns [code]true[/code] if the last received packet was sent as a text payload. See [enum WriteMode].
Document websocket module, further document enet
2018-05-08 12:40:08 +00:00
</description>
</method>
</methods>
<constants>
<constant name="WRITE_MODE_TEXT" value="0" enum="WriteMode">
Proofread and improve the whole class reference - Document a few more properties and methods - Add more information to many classes - Fix lots of typos and gramar mistakes - Use [code] tags for parameters consistently - Use [b] and [i] tags consistently - Put "Warning:" and "Note:" on their own line to be more visible, and make them always bold - Tweak formatting in code examples to be more readable - Use double quotes consistently - Add more links to third-party technologies
2019-06-21 23:04:47 +00:00
Specifies that WebSockets messages should be transferred as text payload (only valid UTF-8 is allowed).
Document websocket module, further document enet
2018-05-08 12:40:08 +00:00
</constant>
<constant name="WRITE_MODE_BINARY" value="1" enum="WriteMode">
Proofread and improve the whole class reference - Document a few more properties and methods - Add more information to many classes - Fix lots of typos and gramar mistakes - Use [code] tags for parameters consistently - Use [b] and [i] tags consistently - Put "Warning:" and "Note:" on their own line to be more visible, and make them always bold - Tweak formatting in code examples to be more readable - Use double quotes consistently - Add more links to third-party technologies
2019-06-21 23:04:47 +00:00
Specifies that WebSockets messages should be transferred as binary payload (any byte combination is allowed).
Document websocket module, further document enet
2018-05-08 12:40:08 +00:00
</constant>
</constants>
</class>