asgardius/virtualx-engine
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions
virtualx-engine/modules/webrtc/doc_classes/WebRTCDataChannelExtension.xml

107 lines
3.1 KiB
XML
Raw Normal View History

[Net/Docs] Update extensions documentation.
2021-09-08 01:50:22 +02:00
<?xml version="1.0" encoding="UTF-8" ?>
Doctool: Remove version attribute from XML header We don't use that info for anything, and it generates unnecessary diffs every time we bump the minor version (and CI failures if we forget to sync some files from opt-in modules (mono, text_server_fb).
2023-07-06 10:08:05 +02:00
<class name="WebRTCDataChannelExtension" inherits="WebRTCDataChannel" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="../../../doc/class.xsd">
[Net/Docs] Update extensions documentation.
2021-09-08 01:50:22 +02:00
<brief_description>
</brief_description>
<description>
</description>
<tutorials>
</tutorials>
<methods>
<method name="_close" qualifiers="virtual">
<return type="void" />
<description>
</description>
</method>
<method name="_get_available_packet_count" qualifiers="virtual const">
<return type="int" />
<description>
</description>
</method>
<method name="_get_buffered_amount" qualifiers="virtual const">
<return type="int" />
<description>
</description>
</method>
<method name="_get_id" qualifiers="virtual const">
<return type="int" />
<description>
</description>
</method>
<method name="_get_label" qualifiers="virtual const">
<return type="String" />
<description>
</description>
</method>
<method name="_get_max_packet_life_time" qualifiers="virtual const">
<return type="int" />
<description>
</description>
</method>
<method name="_get_max_packet_size" qualifiers="virtual const">
<return type="int" />
<description>
</description>
</method>
<method name="_get_max_retransmits" qualifiers="virtual const">
<return type="int" />
<description>
</description>
</method>
<method name="_get_packet" qualifiers="virtual">
Simplify network GDExtension bindings using EXBIND macros. Simplify StreamPeer, PacketPeer, MultiplayerPeer extension. Simplify and update WebRTC*Extension with newly supported types.
2022-09-01 05:09:07 +02:00
<return type="int" enum="Error" />
Rename the argument tag to param in XML documentation
2022-08-06 20:11:48 +02:00
<param index="0" name="r_buffer" type="const uint8_t **" />
<param index="1" name="r_buffer_size" type="int32_t*" />
[Net/Docs] Update extensions documentation.
2021-09-08 01:50:22 +02:00
<description>
</description>
</method>
<method name="_get_protocol" qualifiers="virtual const">
<return type="String" />
<description>
</description>
</method>
<method name="_get_ready_state" qualifiers="virtual const">
Simplify network GDExtension bindings using EXBIND macros. Simplify StreamPeer, PacketPeer, MultiplayerPeer extension. Simplify and update WebRTC*Extension with newly supported types.
2022-09-01 05:09:07 +02:00
<return type="int" enum="WebRTCDataChannel.ChannelState" />
[Net/Docs] Update extensions documentation.
2021-09-08 01:50:22 +02:00
<description>
</description>
</method>
<method name="_get_write_mode" qualifiers="virtual const">
Simplify network GDExtension bindings using EXBIND macros. Simplify StreamPeer, PacketPeer, MultiplayerPeer extension. Simplify and update WebRTC*Extension with newly supported types.
2022-09-01 05:09:07 +02:00
<return type="int" enum="WebRTCDataChannel.WriteMode" />
[Net/Docs] Update extensions documentation.
2021-09-08 01:50:22 +02:00
<description>
</description>
</method>
<method name="_is_negotiated" qualifiers="virtual const">
<return type="bool" />
<description>
</description>
</method>
<method name="_is_ordered" qualifiers="virtual const">
<return type="bool" />
<description>
</description>
</method>
<method name="_poll" qualifiers="virtual">
Simplify network GDExtension bindings using EXBIND macros. Simplify StreamPeer, PacketPeer, MultiplayerPeer extension. Simplify and update WebRTC*Extension with newly supported types.
2022-09-01 05:09:07 +02:00
<return type="int" enum="Error" />
[Net/Docs] Update extensions documentation.
2021-09-08 01:50:22 +02:00
<description>
</description>
</method>
<method name="_put_packet" qualifiers="virtual">
Simplify network GDExtension bindings using EXBIND macros. Simplify StreamPeer, PacketPeer, MultiplayerPeer extension. Simplify and update WebRTC*Extension with newly supported types.
2022-09-01 05:09:07 +02:00
<return type="int" enum="Error" />
Rename the argument tag to param in XML documentation
2022-08-06 20:11:48 +02:00
<param index="0" name="p_buffer" type="const uint8_t*" />
<param index="1" name="p_buffer_size" type="int" />
[Net/Docs] Update extensions documentation.
2021-09-08 01:50:22 +02:00
<description>
</description>
</method>
<method name="_set_write_mode" qualifiers="virtual">
<return type="void" />
Simplify network GDExtension bindings using EXBIND macros. Simplify StreamPeer, PacketPeer, MultiplayerPeer extension. Simplify and update WebRTC*Extension with newly supported types.
2022-09-01 05:09:07 +02:00
<param index="0" name="p_write_mode" type="int" enum="WebRTCDataChannel.WriteMode" />
[Net/Docs] Update extensions documentation.
2021-09-08 01:50:22 +02:00
<description>
</description>
</method>
<method name="_was_string_packet" qualifiers="virtual const">
<return type="bool" />
<description>
</description>
</method>
</methods>
</class>
Reference in a new issue Copy permalink