diff options
| author | Juan Linietsky <reduzio@gmail.com> | 2017-09-12 17:42:36 -0300 |
|---|---|---|
| committer | Juan Linietsky <reduzio@gmail.com> | 2017-09-12 17:45:41 -0300 |
| commit | 4f929a0fdfae24b1ca5acf0b732219119090ee43 (patch) | |
| tree | 730471182cae00f2e47c7430db441d057383d29b /doc/classes/PacketPeerStream.xml | |
| parent | 175777596ec3521731665dd750fd7087793b10fc (diff) | |
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will
recognize them.
Diffstat (limited to 'doc/classes/PacketPeerStream.xml')
| -rw-r--r-- | doc/classes/PacketPeerStream.xml | 54 |
1 files changed, 54 insertions, 0 deletions
diff --git a/doc/classes/PacketPeerStream.xml b/doc/classes/PacketPeerStream.xml new file mode 100644 index 0000000000..531046a4ba --- /dev/null +++ b/doc/classes/PacketPeerStream.xml @@ -0,0 +1,54 @@ +<?xml version="1.0" encoding="UTF-8" ?> +<class name="PacketPeerStream" inherits="PacketPeer" category="Core" version="3.0.alpha.custom_build"> + <brief_description> + Wrapper to use a PacketPeer over a StreamPeer. + </brief_description> + <description> + PacketStreamPeer provides a wrapper for working using packets over a stream. This allows for using packet based code with StreamPeers. PacketPeerStream implements a custom protocol over the StreamPeer, so the user should not read or write to the wrapped StreamPeer directly. + </description> + <tutorials> + </tutorials> + <demos> + </demos> + <methods> + <method name="get_input_buffer_max_size" qualifiers="const"> + <return type="int"> + </return> + <description> + </description> + </method> + <method name="get_output_buffer_max_size" qualifiers="const"> + <return type="int"> + </return> + <description> + </description> + </method> + <method name="set_input_buffer_max_size"> + <return type="void"> + </return> + <argument index="0" name="max_size_bytes" type="int"> + </argument> + <description> + </description> + </method> + <method name="set_output_buffer_max_size"> + <return type="void"> + </return> + <argument index="0" name="max_size_bytes" type="int"> + </argument> + <description> + </description> + </method> + <method name="set_stream_peer"> + <return type="void"> + </return> + <argument index="0" name="peer" type="Reference"> + </argument> + <description> + Set the [StreamPeer] object to be wrapped. + </description> + </method> + </methods> + <constants> + </constants> +</class> |