dev0/SLikeNet
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Init

Browse Source
This commit is contained in:
dev0
2025-11-24 14:19:51 +05:30
commit f5c1412b28
6734 changed files with 1527575 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files

421
Help/Doxygen/html/df/dd9/_file_list_transfer_c_b_interface_8h.xhtml Normal file
View File

@ -0,0 +1,421 @@
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<title>SLikeNet: Source/include/slikenet/FileListTransferCBInterface.h File Reference</title>
<link href="../../tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="../../jquery.js"></script>
<script type="text/javascript" src="../../dynsections.js"></script>
<link href="../../navtree.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="../../resize.js"></script>
<script type="text/javascript" src="../../navtree.js"></script>
<script type="text/javascript">
$(document).ready(initResizable);
</script>
<link href="../../search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="../../search/search.js"></script>
<script type="text/javascript">
$(document).ready(function() { searchBox.OnSelectItem(0); });
</script>
<link href="../../doxygen.css" rel="stylesheet" type="text/css" />
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
<tbody>
<tr style="height: 56px;">
<td style="padding-left: 0.5em;">
<div id="projectname">SLikeNet
&#160;<span id="projectnumber">0.1.3</span>
</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.2 -->
<script type="text/javascript">
var searchBox = new SearchBox("searchBox", "../../search",false,'Search');
</script>
<div id="navrow1" class="tabs">
<ul class="tablist">
<li><a href="../../index.xhtml"><span>Main&#160;Page</span></a></li>
<li><a href="../../pages.xhtml"><span>Related&#160;Pages</span></a></li>
<li><a href="../../modules.xhtml"><span>Modules</span></a></li>
<li><a href="../../namespaces.xhtml"><span>Namespaces</span></a></li>
<li><a href="../../annotated.xhtml"><span>Classes</span></a></li>
<li class="current"><a href="../../files.xhtml"><span>Files</span></a></li>
<li>
<div id="MSearchBox" class="MSearchBoxInactive">
<span class="left">
<img id="MSearchSelect" src="../../search/mag_sel.png"
onmouseover="return searchBox.OnSearchSelectShow()"
onmouseout="return searchBox.OnSearchSelectHide()"
alt=""/>
<input type="text" id="MSearchField" value="Search" accesskey="S"
onfocus="searchBox.OnSearchFieldFocus(true)"
onblur="searchBox.OnSearchFieldFocus(false)"
onkeyup="searchBox.OnSearchFieldChange(event)"/>
</span><span class="right">
<a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="../../search/close.png" alt=""/></a>
</span>
</div>
</li>
</ul>
</div>
<div id="navrow2" class="tabs2">
<ul class="tablist">
<li><a href="../../files.xhtml"><span>File&#160;List</span></a></li>
<li><a href="../../globals.xhtml"><span>File&#160;Members</span></a></li>
</ul>
</div>
</div><!-- top -->
<div id="side-nav" class="ui-resizable side-nav-resizable">
<div id="nav-tree">
<div id="nav-tree-contents">
<div id="nav-sync" class="sync"></div>
</div>
</div>
<div id="splitbar" style="-moz-user-select:none;"
class="ui-resizable-handle">
</div>
</div>
<script type="text/javascript">
$(document).ready(function(){initNavTree('df/dd9/_file_list_transfer_c_b_interface_8h.xhtml','../../');});
</script>
<div id="doc-content">
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
onmouseover="return searchBox.OnSearchSelectShow()"
onmouseout="return searchBox.OnSearchSelectHide()"
onkeydown="return searchBox.OnSearchSelectKey(event)">
<a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(0)"><span class="SelectionMark">&#160;</span>All</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(1)"><span class="SelectionMark">&#160;</span>Classes</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(2)"><span class="SelectionMark">&#160;</span>Namespaces</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(3)"><span class="SelectionMark">&#160;</span>Files</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(4)"><span class="SelectionMark">&#160;</span>Functions</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(5)"><span class="SelectionMark">&#160;</span>Variables</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(6)"><span class="SelectionMark">&#160;</span>Typedefs</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(7)"><span class="SelectionMark">&#160;</span>Enumerations</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(8)"><span class="SelectionMark">&#160;</span>Enumerator</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(9)"><span class="SelectionMark">&#160;</span>Friends</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(10)"><span class="SelectionMark">&#160;</span>Macros</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(11)"><span class="SelectionMark">&#160;</span>Groups</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(12)"><span class="SelectionMark">&#160;</span>Pages</a></div>
<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<iframe src="javascript:void(0)" frameborder="0"
name="MSearchResults" id="MSearchResults">
</iframe>
</div>
<div class="header">
<div class="summary">
<a href="#nested-classes">Classes</a> &#124;
<a href="#namespaces">Namespaces</a> </div>
<div class="headertitle">
<div class="title">FileListTransferCBInterface.h File Reference</div> </div>
</div><!--header-->
<div class="contents">
<div class="textblock"><code>#include &quot;<a class="el" href="../../dd/dc5/memoryoverride_8h_source.xhtml">memoryoverride.h</a>&quot;</code><br/>
<code>#include &quot;<a class="el" href="../../dc/df9/_file_list_node_context_8h_source.xhtml">FileListNodeContext.h</a>&quot;</code><br/>
</div>
<p><a href="../../df/dd9/_file_list_transfer_c_b_interface_8h_source.xhtml">Go to the source code of this file.</a></p>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="nested-classes"></a>
Classes</h2></td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">class &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="../../d9/d93/class_s_l_net_1_1_file_list_transfer_c_b_interface.xhtml">SLNet::FileListTransferCBInterface</a></td></tr>
<tr class="memdesc:"><td class="mdescLeft">&#160;</td><td class="mdescRight">Used by <a class="el" href="../../d0/dae/group___f_i_l_e___l_i_s_t___t_r_a_n_s_f_e_r___g_r_o_u_p.xhtml#dd/df6/class_s_l_net_1_1_file_list_transfer" title="A plugin to provide a simple way to compress and incrementally send the files in the FileList structu...">FileListTransfer</a> plugin as a callback for when we get a file. <a href="../../d9/d93/class_s_l_net_1_1_file_list_transfer_c_b_interface.xhtml#details">More...</a><br/></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:d1/d50/struct_s_l_net_1_1_file_list_transfer_c_b_interface_1_1_on_file_struct"><td class="memItemLeft" align="right" valign="top">struct &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="../../d9/d93/class_s_l_net_1_1_file_list_transfer_c_b_interface.xhtml#d1/d50/struct_s_l_net_1_1_file_list_transfer_c_b_interface_1_1_on_file_struct">SLNet::FileListTransferCBInterface::OnFileStruct</a></td></tr>
<tr class="separator:d1/d50/struct_s_l_net_1_1_file_list_transfer_c_b_interface_1_1_on_file_struct"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:d8/da1/struct_s_l_net_1_1_file_list_transfer_c_b_interface_1_1_file_progress_struct"><td class="memItemLeft" align="right" valign="top">struct &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="../../d9/d93/class_s_l_net_1_1_file_list_transfer_c_b_interface.xhtml#d8/da1/struct_s_l_net_1_1_file_list_transfer_c_b_interface_1_1_file_progress_struct">SLNet::FileListTransferCBInterface::FileProgressStruct</a></td></tr>
<tr class="separator:d8/da1/struct_s_l_net_1_1_file_list_transfer_c_b_interface_1_1_file_progress_struct"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:dd/db9/struct_s_l_net_1_1_file_list_transfer_c_b_interface_1_1_download_complete_struct"><td class="memItemLeft" align="right" valign="top">struct &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="../../d9/d93/class_s_l_net_1_1_file_list_transfer_c_b_interface.xhtml#dd/db9/struct_s_l_net_1_1_file_list_transfer_c_b_interface_1_1_download_complete_struct">SLNet::FileListTransferCBInterface::DownloadCompleteStruct</a></td></tr>
<tr class="separator:dd/db9/struct_s_l_net_1_1_file_list_transfer_c_b_interface_1_1_download_complete_struct"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="namespaces"></a>
Namespaces</h2></td></tr>
<tr class="memitem:dd/d30/namespace_s_l_net"><td class="memItemLeft" align="right" valign="top">namespace &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="../../dd/d30/namespace_s_l_net.xhtml">SLNet</a></td></tr>
<tr class="memdesc:dd/d30/namespace_s_l_net"><td class="mdescLeft">&#160;</td><td class="mdescRight">Simple class to send changes between directories. In essence, a simple autopatcher that can be used for transmitting levels, skins, etc. <br/></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<hr/><h2 class="groupheader">Class Documentation</h2>
<a name="d1/d50/struct_s_l_net_1_1_file_list_transfer_c_b_interface_1_1_on_file_struct" id="d1/d50/struct_s_l_net_1_1_file_list_transfer_c_b_interface_1_1_on_file_struct"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">struct SLNet::FileListTransferCBInterface::OnFileStruct</td>
</tr>
</table>
</div><div class="memdoc">
<div class="textblock">
<p>Definition at line <a class="el" href="../../df/dd9/_file_list_transfer_c_b_interface_8h_source.xhtml#l00036">36</a> of file <a class="el" href="../../df/dd9/_file_list_transfer_c_b_interface_8h_source.xhtml">FileListTransferCBInterface.h</a>.</p>
</div><table class="fieldtable">
<tr><th colspan="3">Class Members</th></tr>
<tr><td class="fieldtype">
<a class="anchor" id="a1150f5d4c01a00a7b6837f989e23ddc4"></a><a class="el" href="../../dd/d30/namespace_s_l_net.xhtml#a227d2a5f9683a34d9d1e70772fd556ec">BitSize_t</a></td>
<td class="fieldname">
byteLengthOfThisFile</td>
<td class="fielddoc">
The amount of data to be downloaded for this file. </td></tr>
<tr><td class="fieldtype">
<a class="anchor" id="a036e574fd5ce390a05dd4c581334e2f3"></a>unsigned</td>
<td class="fieldname">
byteLengthOfThisSet</td>
<td class="fielddoc">
The total length of the transmitted files for this set, after being uncompressed. </td></tr>
<tr><td class="fieldtype">
<a class="anchor" id="aeab7ef5abd159f9c3c095032b4b5fd02"></a><a class="el" href="../../dd/d30/namespace_s_l_net.xhtml#a227d2a5f9683a34d9d1e70772fd556ec">BitSize_t</a></td>
<td class="fieldname">
bytesDownloadedForThisFile</td>
<td class="fielddoc">
How many bytes of this file has been downloaded. </td></tr>
<tr><td class="fieldtype">
<a class="anchor" id="a9a41afb708b1f76a506c900a430584d1"></a>unsigned</td>
<td class="fieldname">
bytesDownloadedForThisSet</td>
<td class="fielddoc">
The total length, in bytes, downloaded for this set. </td></tr>
<tr><td class="fieldtype">
<a class="anchor" id="af5f941dc32d509bb66c15c5a7fe44794"></a><a class="el" href="../../d6/dff/struct_file_list_node_context.xhtml">FileListNodeContext</a></td>
<td class="fieldname">
context</td>
<td class="fielddoc">
User data passed to one of the functions in the <a class="el" href="../../d7/d87/class_s_l_net_1_1_file_list.xhtml">FileList</a> class. However, on error, this is instead changed to one of the enumerations in the PatchContext structure. </td></tr>
<tr><td class="fieldtype">
<a class="anchor" id="a7f33f08b1d0a0a0d1e7448e20ce9836d"></a>char *</td>
<td class="fieldname">
fileData</td>
<td class="fielddoc">
The data pointed to by the file. </td></tr>
<tr><td class="fieldtype">
<a class="anchor" id="a3928099fd6ca6a67a5a03052c346108e"></a>unsigned</td>
<td class="fieldname">
fileIndex</td>
<td class="fielddoc">
The index into the set of files, from 0 to numberOfFilesInThisSet. </td></tr>
<tr><td class="fieldtype">
<a class="anchor" id="a9bcdd45b835eb946daf6d711dd8ef9b1"></a>char</td>
<td class="fieldname">
fileName</td>
<td class="fielddoc">
The name of the file. </td></tr>
<tr><td class="fieldtype">
<a class="anchor" id="a125a510be0663479ca3a4661523580d4"></a>unsigned</td>
<td class="fieldname">
numberOfFilesInThisSet</td>
<td class="fielddoc">
The number of files that are in this set. </td></tr>
<tr><td class="fieldtype">
<a class="anchor" id="a261ee334b67f04dce9587441a2e43ca8"></a><a class="el" href="../../dd/d3f/struct_s_l_net_1_1_rak_net_g_u_i_d.xhtml">RakNetGUID</a></td>
<td class="fieldname">
senderGuid</td>
<td class="fielddoc">
Who sent this file. Not valid when using TCP, only <a class="el" href="../../d5/dbf/class_s_l_net_1_1_rak_peer.xhtml" title="Main interface for network communications.">RakPeer</a> (UDP) </td></tr>
<tr><td class="fieldtype">
<a class="anchor" id="a08b4cc5136d250aa796a30dbde103ad8"></a><a class="el" href="../../d8/dbe/struct_s_l_net_1_1_system_address.xhtml">SystemAddress</a></td>
<td class="fieldname">
senderSystemAddress</td>
<td class="fielddoc">
Who sent this file. </td></tr>
<tr><td class="fieldtype">
<a class="anchor" id="a5822e23f90012acc26d1da1348630fcb"></a>unsigned short</td>
<td class="fieldname">
setID</td>
<td class="fielddoc">
Files are transmitted in sets, where more than one set of files can be transmitted at the same time. This is the identifier for the set, which is returned by <a class="el" href="../../d0/dae/group___f_i_l_e___l_i_s_t___t_r_a_n_s_f_e_r___g_r_o_u_p.xhtml#afae76315465d8734ca83b576f92c1cd6" title="Allows one corresponding Send() call from another system to arrive.">FileListTransfer::SetupReceive</a> </td></tr>
</table>
</div>
</div>
<a name="d8/da1/struct_s_l_net_1_1_file_list_transfer_c_b_interface_1_1_file_progress_struct" id="d8/da1/struct_s_l_net_1_1_file_list_transfer_c_b_interface_1_1_file_progress_struct"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">struct SLNet::FileListTransferCBInterface::FileProgressStruct</td>
</tr>
</table>
</div><div class="memdoc">
<div class="textblock">
<p>Definition at line <a class="el" href="../../df/dd9/_file_list_transfer_c_b_interface_8h_source.xhtml#l00078">78</a> of file <a class="el" href="../../df/dd9/_file_list_transfer_c_b_interface_8h_source.xhtml">FileListTransferCBInterface.h</a>.</p>
</div><table class="fieldtable">
<tr><th colspan="3">Class Members</th></tr>
<tr><td class="fieldtype">
<a class="anchor" id="adf41b25c775b2e6e38826d479c32ccce"></a>bool</td>
<td class="fieldname">
allocateIrIDataChunkAutomatically</td>
<td class="fielddoc">
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">allocateIrIDataChunkAutomatically</td><td>If true, then RakNet will hold iriDataChunk for you and return it in OnFile. Defaults to true </td></tr>
</table>
</dd>
</dl>
</td></tr>
<tr><td class="fieldtype">
<a class="anchor" id="ad2dd133df159031571410d08d4d0c086"></a>unsigned int</td>
<td class="fieldname">
dataChunkLength</td>
<td class="fielddoc">
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[out]</td><td class="paramname">dataChunkLength</td><td>How many bytes long firstDataChunk and iriDataChunk are </td></tr>
</table>
</dd>
</dl>
</td></tr>
<tr><td class="fieldtype">
<a class="anchor" id="a666ea1a0b1f49ba8e62b4b669dac0cbe"></a>char *</td>
<td class="fieldname">
firstDataChunk</td>
<td class="fielddoc">
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[out]</td><td class="paramname">firstDataChunk</td><td>The first <em>partLength</em> of the final file. If you store identifying information about the file in the first <em>partLength</em> bytes, you can read them while the download is taking place. If this hasn't arrived yet, firstDataChunk will be 0 </td></tr>
</table>
</dd>
</dl>
</td></tr>
<tr><td class="fieldtype">
<a class="anchor" id="a422219fd25a3821150f187888895ede5"></a>char *</td>
<td class="fieldname">
iriDataChunk</td>
<td class="fielddoc">
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[out]</td><td class="paramname">iriDataChunk</td><td>If the remote system is sending this file using <a class="el" href="../../df/d02/class_s_l_net_1_1_incremental_read_interface.xhtml">IncrementalReadInterface</a>, then this is the chunk we just downloaded. It will not exist in memory after this callback. You should either store this to disk, or in memory. If it is 0, then the file is smaller than one chunk, and will be held in memory automatically </td></tr>
</table>
</dd>
</dl>
</td></tr>
<tr><td class="fieldtype">
<a class="anchor" id="aef3f9c7a702692cf7d4cdf25b006ec8e"></a>unsigned int</td>
<td class="fieldname">
iriWriteOffset</td>
<td class="fielddoc">
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[out]</td><td class="paramname">iriWriteOffset</td><td>Offset in bytes from the start of the file for the data pointed to by iriDataChunk </td></tr>
</table>
</dd>
</dl>
</td></tr>
<tr><td class="fieldtype">
<a class="anchor" id="ae1ff21757fa0ba73f1466e3e321293c3"></a><a class="el" href="../../d9/d93/class_s_l_net_1_1_file_list_transfer_c_b_interface.xhtml#d1/d50/struct_s_l_net_1_1_file_list_transfer_c_b_interface_1_1_on_file_struct">OnFileStruct</a> *</td>
<td class="fieldname">
onFileStruct</td>
<td class="fielddoc">
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[out]</td><td class="paramname">onFileStruct</td><td>General information about this file, such as the filename and the first <em>partLength</em> bytes. You do NOT need to save this data yourself. The complete file will arrive normally. </td></tr>
</table>
</dd>
</dl>
</td></tr>
<tr><td class="fieldtype">
<a class="anchor" id="a75dd91b8c1b1f6d22fff32615ac06e00"></a>unsigned int</td>
<td class="fieldname">
partCount</td>
<td class="fielddoc">
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[out]</td><td class="paramname">partCount</td><td>The zero based index into partTotal. The percentage complete done of this file is 100 * (partCount+1)/partTotal </td></tr>
</table>
</dd>
</dl>
</td></tr>
<tr><td class="fieldtype">
<a class="anchor" id="a81d4a6ae6bc72562b77f9d37626ba3cc"></a>unsigned int</td>
<td class="fieldname">
partTotal</td>
<td class="fielddoc">
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[out]</td><td class="paramname">partTotal</td><td>The total number of parts this file was split into. Each part will be roughly the MTU size, minus the UDP header and RakNet headers </td></tr>
</table>
</dd>
</dl>
</td></tr>
<tr><td class="fieldtype">
<a class="anchor" id="aef5f63527150dee0569a02009259af51"></a><a class="el" href="../../dd/d3f/struct_s_l_net_1_1_rak_net_g_u_i_d.xhtml">RakNetGUID</a></td>
<td class="fieldname">
senderGuid</td>
<td class="fielddoc">
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[out]</td><td class="paramname">Who</td><td>sent this file. Not valid when using TCP, only <a class="el" href="../../d5/dbf/class_s_l_net_1_1_rak_peer.xhtml" title="Main interface for network communications.">RakPeer</a> (UDP) </td></tr>
</table>
</dd>
</dl>
</td></tr>
<tr><td class="fieldtype">
<a class="anchor" id="a5f4eae8053d1110f810e23bfc088a045"></a><a class="el" href="../../d8/dbe/struct_s_l_net_1_1_system_address.xhtml">SystemAddress</a></td>
<td class="fieldname">
senderSystemAddress</td>
<td class="fielddoc">
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[out]</td><td class="paramname">Who</td><td>sent this file </td></tr>
</table>
</dd>
</dl>
</td></tr>
</table>
</div>
</div>
<a name="dd/db9/struct_s_l_net_1_1_file_list_transfer_c_b_interface_1_1_download_complete_struct" id="dd/db9/struct_s_l_net_1_1_file_list_transfer_c_b_interface_1_1_download_complete_struct"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">struct SLNet::FileListTransferCBInterface::DownloadCompleteStruct</td>
</tr>
</table>
</div><div class="memdoc">
<div class="textblock">
<p>Definition at line <a class="el" href="../../df/dd9/_file_list_transfer_c_b_interface_8h_source.xhtml#l00102">102</a> of file <a class="el" href="../../df/dd9/_file_list_transfer_c_b_interface_8h_source.xhtml">FileListTransferCBInterface.h</a>.</p>
</div><table class="fieldtable">
<tr><th colspan="3">Class Members</th></tr>
<tr><td class="fieldtype">
<a class="anchor" id="acc44389583a0e82d88ae503a4f4ef51e"></a>unsigned</td>
<td class="fieldname">
byteLengthOfThisSet</td>
<td class="fielddoc">
The total length of the transmitted files for this set, after being uncompressed. </td></tr>
<tr><td class="fieldtype">
<a class="anchor" id="a535dfe10d0726104838c03b174e18c58"></a>unsigned</td>
<td class="fieldname">
numberOfFilesInThisSet</td>
<td class="fielddoc">
The number of files that are in this set. </td></tr>
<tr><td class="fieldtype">
<a class="anchor" id="aad185dfa6796a1aed4e5ab1d57f19233"></a><a class="el" href="../../dd/d3f/struct_s_l_net_1_1_rak_net_g_u_i_d.xhtml">RakNetGUID</a></td>
<td class="fieldname">
senderGuid</td>
<td class="fielddoc">
Who sent this file. Not valid when using TCP, only <a class="el" href="../../d5/dbf/class_s_l_net_1_1_rak_peer.xhtml" title="Main interface for network communications.">RakPeer</a> (UDP) </td></tr>
<tr><td class="fieldtype">
<a class="anchor" id="a78b3248f939907fa126ddbea2d3a187f"></a><a class="el" href="../../d8/dbe/struct_s_l_net_1_1_system_address.xhtml">SystemAddress</a></td>
<td class="fieldname">
senderSystemAddress</td>
<td class="fielddoc">
Who sent this file. </td></tr>
<tr><td class="fieldtype">
<a class="anchor" id="afae147fd3c6aaed5ebf3fb8d82a6f73d"></a>unsigned short</td>
<td class="fieldname">
setID</td>
<td class="fielddoc">
Files are transmitted in sets, where more than one set of files can be transmitted at the same time. This is the identifier for the set, which is returned by <a class="el" href="../../d0/dae/group___f_i_l_e___l_i_s_t___t_r_a_n_s_f_e_r___g_r_o_u_p.xhtml#afae76315465d8734ca83b576f92c1cd6" title="Allows one corresponding Send() call from another system to arrive.">FileListTransfer::SetupReceive</a> </td></tr>
</table>
</div>
</div>
</div><!-- contents -->
</div><!-- doc-content -->
<!-- start footer part -->
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
<ul>
<li class="navelem"><a class="el" href="../../dir_74389ed8173ad57b461b9d623a1f3867.xhtml">Source</a></li><li class="navelem"><a class="el" href="../../dir_bbb90e3ef9167a594ae33323139a2595.xhtml">include</a></li><li class="navelem"><a class="el" href="../../dir_88467e66686deb9d3756fe4fc298e321.xhtml">slikenet</a></li><li class="navelem"><a class="el" href="../../df/dd9/_file_list_transfer_c_b_interface_8h.xhtml">FileListTransferCBInterface.h</a></li>
<li class="footer">Generated on Wed Aug 14 2019 22:09:48 for SLikeNet by
<a href="http://www.doxygen.org/index.html">
<img class="footer" src="../../doxygen.png" alt="doxygen"/></a> 1.8.2 </li>
</ul>
</div>
</body>
</html>

224
Help/Doxygen/html/df/dd9/_file_list_transfer_c_b_interface_8h_source.xhtml Normal file
View File

@ -0,0 +1,224 @@
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<title>SLikeNet: Source/include/slikenet/FileListTransferCBInterface.h Source File</title>
<link href="../../tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="../../jquery.js"></script>
<script type="text/javascript" src="../../dynsections.js"></script>
<link href="../../navtree.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="../../resize.js"></script>
<script type="text/javascript" src="../../navtree.js"></script>
<script type="text/javascript">
$(document).ready(initResizable);
</script>
<link href="../../search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="../../search/search.js"></script>
<script type="text/javascript">
$(document).ready(function() { searchBox.OnSelectItem(0); });
</script>
<link href="../../doxygen.css" rel="stylesheet" type="text/css" />
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
<tbody>
<tr style="height: 56px;">
<td style="padding-left: 0.5em;">
<div id="projectname">SLikeNet
&#160;<span id="projectnumber">0.1.3</span>
</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.2 -->
<script type="text/javascript">
var searchBox = new SearchBox("searchBox", "../../search",false,'Search');
</script>
<div id="navrow1" class="tabs">
<ul class="tablist">
<li><a href="../../index.xhtml"><span>Main&#160;Page</span></a></li>
<li><a href="../../pages.xhtml"><span>Related&#160;Pages</span></a></li>
<li><a href="../../modules.xhtml"><span>Modules</span></a></li>
<li><a href="../../namespaces.xhtml"><span>Namespaces</span></a></li>
<li><a href="../../annotated.xhtml"><span>Classes</span></a></li>
<li class="current"><a href="../../files.xhtml"><span>Files</span></a></li>
<li>
<div id="MSearchBox" class="MSearchBoxInactive">
<span class="left">
<img id="MSearchSelect" src="../../search/mag_sel.png"
onmouseover="return searchBox.OnSearchSelectShow()"
onmouseout="return searchBox.OnSearchSelectHide()"
alt=""/>
<input type="text" id="MSearchField" value="Search" accesskey="S"
onfocus="searchBox.OnSearchFieldFocus(true)"
onblur="searchBox.OnSearchFieldFocus(false)"
onkeyup="searchBox.OnSearchFieldChange(event)"/>
</span><span class="right">
<a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="../../search/close.png" alt=""/></a>
</span>
</div>
</li>
</ul>
</div>
<div id="navrow2" class="tabs2">
<ul class="tablist">
<li><a href="../../files.xhtml"><span>File&#160;List</span></a></li>
<li><a href="../../globals.xhtml"><span>File&#160;Members</span></a></li>
</ul>
</div>
</div><!-- top -->
<div id="side-nav" class="ui-resizable side-nav-resizable">
<div id="nav-tree">
<div id="nav-tree-contents">
<div id="nav-sync" class="sync"></div>
</div>
</div>
<div id="splitbar" style="-moz-user-select:none;"
class="ui-resizable-handle">
</div>
</div>
<script type="text/javascript">
$(document).ready(function(){initNavTree('df/dd9/_file_list_transfer_c_b_interface_8h_source.xhtml','../../');});
</script>
<div id="doc-content">
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
onmouseover="return searchBox.OnSearchSelectShow()"
onmouseout="return searchBox.OnSearchSelectHide()"
onkeydown="return searchBox.OnSearchSelectKey(event)">
<a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(0)"><span class="SelectionMark">&#160;</span>All</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(1)"><span class="SelectionMark">&#160;</span>Classes</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(2)"><span class="SelectionMark">&#160;</span>Namespaces</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(3)"><span class="SelectionMark">&#160;</span>Files</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(4)"><span class="SelectionMark">&#160;</span>Functions</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(5)"><span class="SelectionMark">&#160;</span>Variables</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(6)"><span class="SelectionMark">&#160;</span>Typedefs</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(7)"><span class="SelectionMark">&#160;</span>Enumerations</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(8)"><span class="SelectionMark">&#160;</span>Enumerator</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(9)"><span class="SelectionMark">&#160;</span>Friends</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(10)"><span class="SelectionMark">&#160;</span>Macros</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(11)"><span class="SelectionMark">&#160;</span>Groups</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(12)"><span class="SelectionMark">&#160;</span>Pages</a></div>
<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<iframe src="javascript:void(0)" frameborder="0"
name="MSearchResults" id="MSearchResults">
</iframe>
</div>
<div class="header">
<div class="headertitle">
<div class="title">FileListTransferCBInterface.h</div> </div>
</div><!--header-->
<div class="contents">
<a href="../../df/dd9/_file_list_transfer_c_b_interface_8h.xhtml">Go to the documentation of this file.</a><div class="fragment"><div class="line"><a name="l00001"></a><span class="lineno"> 1</span>&#160;<span class="comment">/*</span></div>
<div class="line"><a name="l00002"></a><span class="lineno"> 2</span>&#160;<span class="comment"> * Original work: Copyright (c) 2014, Oculus VR, Inc.</span></div>
<div class="line"><a name="l00003"></a><span class="lineno"> 3</span>&#160;<span class="comment"> * All rights reserved.</span></div>
<div class="line"><a name="l00004"></a><span class="lineno"> 4</span>&#160;<span class="comment"> *</span></div>
<div class="line"><a name="l00005"></a><span class="lineno"> 5</span>&#160;<span class="comment"> * This source code is licensed under the BSD-style license found in the</span></div>
<div class="line"><a name="l00006"></a><span class="lineno"> 6</span>&#160;<span class="comment"> * RakNet License.txt file in the licenses directory of this source tree. An additional grant </span></div>
<div class="line"><a name="l00007"></a><span class="lineno"> 7</span>&#160;<span class="comment"> * of patent rights can be found in the RakNet Patents.txt file in the same directory.</span></div>
<div class="line"><a name="l00008"></a><span class="lineno"> 8</span>&#160;<span class="comment"> *</span></div>
<div class="line"><a name="l00009"></a><span class="lineno"> 9</span>&#160;<span class="comment"> *</span></div>
<div class="line"><a name="l00010"></a><span class="lineno"> 10</span>&#160;<span class="comment"> * Modified work: Copyright (c) 2016-2017, SLikeSoft UG (haftungsbeschränkt)</span></div>
<div class="line"><a name="l00011"></a><span class="lineno"> 11</span>&#160;<span class="comment"> *</span></div>
<div class="line"><a name="l00012"></a><span class="lineno"> 12</span>&#160;<span class="comment"> * This source code was modified by SLikeSoft. Modifications are licensed under the MIT-style</span></div>
<div class="line"><a name="l00013"></a><span class="lineno"> 13</span>&#160;<span class="comment"> * license found in the license.txt file in the root directory of this source tree.</span></div>
<div class="line"><a name="l00014"></a><span class="lineno"> 14</span>&#160;<span class="comment"> */</span></div>
<div class="line"><a name="l00015"></a><span class="lineno"> 15</span>&#160;</div>
<div class="line"><a name="l00018"></a><span class="lineno"> 18</span>&#160;</div>
<div class="line"><a name="l00019"></a><span class="lineno"> 19</span>&#160;</div>
<div class="line"><a name="l00020"></a><span class="lineno"> 20</span>&#160;<span class="preprocessor">#ifndef __FILE_LIST_TRANSFER_CALLBACK_INTERFACE_H</span></div>
<div class="line"><a name="l00021"></a><span class="lineno"> 21</span>&#160;<span class="preprocessor"></span><span class="preprocessor">#define __FILE_LIST_TRANSFER_CALLBACK_INTERFACE_H</span></div>
<div class="line"><a name="l00022"></a><span class="lineno"> 22</span>&#160;<span class="preprocessor"></span></div>
<div class="line"><a name="l00023"></a><span class="lineno"> 23</span>&#160;<span class="preprocessor">#include &quot;<a class="code" href="../../dd/dc5/memoryoverride_8h.xhtml" title="If _USE_RAK_MEMORY_OVERRIDE is defined, memory allocations go through rakMalloc, rakRealloc, and rakFree.">memoryoverride.h</a>&quot;</span></div>
<div class="line"><a name="l00024"></a><span class="lineno"> 24</span>&#160;<span class="preprocessor">#include &quot;<a class="code" href="../../dc/df9/_file_list_node_context_8h.xhtml">FileListNodeContext.h</a>&quot;</span></div>
<div class="line"><a name="l00025"></a><span class="lineno"> 25</span>&#160;</div>
<div class="line"><a name="l00026"></a><span class="lineno"> 26</span>&#160;<span class="keyword">namespace </span>SLNet</div>
<div class="line"><a name="l00027"></a><span class="lineno"> 27</span>&#160;{</div>
<div class="line"><a name="l00028"></a><span class="lineno"> 28</span>&#160;</div>
<div class="line"><a name="l00032"></a><span class="lineno"><a class="code" href="../../d9/d93/class_s_l_net_1_1_file_list_transfer_c_b_interface.xhtml"> 32</a></span>&#160;<span class="keyword">class </span><a class="code" href="../../d9/d93/class_s_l_net_1_1_file_list_transfer_c_b_interface.xhtml" title="Used by FileListTransfer plugin as a callback for when we get a file.">FileListTransferCBInterface</a></div>
<div class="line"><a name="l00033"></a><span class="lineno"> 33</span>&#160;{</div>
<div class="line"><a name="l00034"></a><span class="lineno"> 34</span>&#160;<span class="keyword">public</span>:</div>
<div class="line"><a name="l00035"></a><span class="lineno"> 35</span>&#160; <span class="comment">// Note: If this structure is changed the struct in the swig files need to be changed as well</span></div>
<div class="line"><a name="l00036"></a><span class="lineno"><a class="code" href="../../d9/d93/class_s_l_net_1_1_file_list_transfer_c_b_interface.xhtml"> 36</a></span>&#160; <span class="keyword">struct </span><a class="code" href="../../d9/d93/class_s_l_net_1_1_file_list_transfer_c_b_interface.xhtml#d1/d50/struct_s_l_net_1_1_file_list_transfer_c_b_interface_1_1_on_file_struct">OnFileStruct</a></div>
<div class="line"><a name="l00037"></a><span class="lineno"> 37</span>&#160; {</div>
<div class="line"><a name="l00039"></a><span class="lineno"><a class="code" href="../../d9/d93/class_s_l_net_1_1_file_list_transfer_c_b_interface.xhtml#a3928099fd6ca6a67a5a03052c346108e"> 39</a></span>&#160; <span class="keywordtype">unsigned</span> <a class="code" href="../../d9/d93/class_s_l_net_1_1_file_list_transfer_c_b_interface.xhtml#a3928099fd6ca6a67a5a03052c346108e" title="The index into the set of files, from 0 to numberOfFilesInThisSet.">fileIndex</a>;</div>
<div class="line"><a name="l00040"></a><span class="lineno"> 40</span>&#160;</div>
<div class="line"><a name="l00042"></a><span class="lineno"><a class="code" href="../../d9/d93/class_s_l_net_1_1_file_list_transfer_c_b_interface.xhtml#a9bcdd45b835eb946daf6d711dd8ef9b1"> 42</a></span>&#160; <span class="keywordtype">char</span> <a class="code" href="../../d9/d93/class_s_l_net_1_1_file_list_transfer_c_b_interface.xhtml#a9bcdd45b835eb946daf6d711dd8ef9b1" title="The name of the file.">fileName</a>[512];</div>
<div class="line"><a name="l00043"></a><span class="lineno"> 43</span>&#160;</div>
<div class="line"><a name="l00045"></a><span class="lineno"><a class="code" href="../../d9/d93/class_s_l_net_1_1_file_list_transfer_c_b_interface.xhtml#a7f33f08b1d0a0a0d1e7448e20ce9836d"> 45</a></span>&#160; <span class="keywordtype">char</span> *<a class="code" href="../../d9/d93/class_s_l_net_1_1_file_list_transfer_c_b_interface.xhtml#a7f33f08b1d0a0a0d1e7448e20ce9836d" title="The data pointed to by the file.">fileData</a>;</div>
<div class="line"><a name="l00046"></a><span class="lineno"> 46</span>&#160;</div>
<div class="line"><a name="l00048"></a><span class="lineno"><a class="code" href="../../d9/d93/class_s_l_net_1_1_file_list_transfer_c_b_interface.xhtml#a1150f5d4c01a00a7b6837f989e23ddc4"> 48</a></span>&#160; <a class="code" href="../../dd/d30/namespace_s_l_net.xhtml#a227d2a5f9683a34d9d1e70772fd556ec">BitSize_t</a> <a class="code" href="../../d9/d93/class_s_l_net_1_1_file_list_transfer_c_b_interface.xhtml#a1150f5d4c01a00a7b6837f989e23ddc4" title="The amount of data to be downloaded for this file.">byteLengthOfThisFile</a>;</div>
<div class="line"><a name="l00049"></a><span class="lineno"> 49</span>&#160;</div>
<div class="line"><a name="l00051"></a><span class="lineno"><a class="code" href="../../d9/d93/class_s_l_net_1_1_file_list_transfer_c_b_interface.xhtml#aeab7ef5abd159f9c3c095032b4b5fd02"> 51</a></span>&#160; <a class="code" href="../../dd/d30/namespace_s_l_net.xhtml#a227d2a5f9683a34d9d1e70772fd556ec">BitSize_t</a> <a class="code" href="../../d9/d93/class_s_l_net_1_1_file_list_transfer_c_b_interface.xhtml#aeab7ef5abd159f9c3c095032b4b5fd02" title="How many bytes of this file has been downloaded.">bytesDownloadedForThisFile</a>;</div>
<div class="line"><a name="l00052"></a><span class="lineno"> 52</span>&#160;</div>
<div class="line"><a name="l00055"></a><span class="lineno"><a class="code" href="../../d9/d93/class_s_l_net_1_1_file_list_transfer_c_b_interface.xhtml#a5822e23f90012acc26d1da1348630fcb"> 55</a></span>&#160; <span class="keywordtype">unsigned</span> <span class="keywordtype">short</span> <a class="code" href="../../d9/d93/class_s_l_net_1_1_file_list_transfer_c_b_interface.xhtml#a5822e23f90012acc26d1da1348630fcb" title="Files are transmitted in sets, where more than one set of files can be transmitted at the same time...">setID</a>;</div>
<div class="line"><a name="l00056"></a><span class="lineno"> 56</span>&#160;</div>
<div class="line"><a name="l00058"></a><span class="lineno"><a class="code" href="../../d9/d93/class_s_l_net_1_1_file_list_transfer_c_b_interface.xhtml#a125a510be0663479ca3a4661523580d4"> 58</a></span>&#160; <span class="keywordtype">unsigned</span> <a class="code" href="../../d9/d93/class_s_l_net_1_1_file_list_transfer_c_b_interface.xhtml#a125a510be0663479ca3a4661523580d4" title="The number of files that are in this set.">numberOfFilesInThisSet</a>;</div>
<div class="line"><a name="l00059"></a><span class="lineno"> 59</span>&#160;</div>
<div class="line"><a name="l00061"></a><span class="lineno"><a class="code" href="../../d9/d93/class_s_l_net_1_1_file_list_transfer_c_b_interface.xhtml#a036e574fd5ce390a05dd4c581334e2f3"> 61</a></span>&#160; <span class="keywordtype">unsigned</span> <a class="code" href="../../d9/d93/class_s_l_net_1_1_file_list_transfer_c_b_interface.xhtml#a036e574fd5ce390a05dd4c581334e2f3" title="The total length of the transmitted files for this set, after being uncompressed.">byteLengthOfThisSet</a>;</div>
<div class="line"><a name="l00062"></a><span class="lineno"> 62</span>&#160;</div>
<div class="line"><a name="l00064"></a><span class="lineno"><a class="code" href="../../d9/d93/class_s_l_net_1_1_file_list_transfer_c_b_interface.xhtml#a9a41afb708b1f76a506c900a430584d1"> 64</a></span>&#160; <span class="keywordtype">unsigned</span> <a class="code" href="../../d9/d93/class_s_l_net_1_1_file_list_transfer_c_b_interface.xhtml#a9a41afb708b1f76a506c900a430584d1" title="The total length, in bytes, downloaded for this set.">bytesDownloadedForThisSet</a>;</div>
<div class="line"><a name="l00065"></a><span class="lineno"> 65</span>&#160;</div>
<div class="line"><a name="l00068"></a><span class="lineno"><a class="code" href="../../d9/d93/class_s_l_net_1_1_file_list_transfer_c_b_interface.xhtml#af5f941dc32d509bb66c15c5a7fe44794"> 68</a></span>&#160; <a class="code" href="../../d6/dff/struct_file_list_node_context.xhtml">FileListNodeContext</a> <a class="code" href="../../d9/d93/class_s_l_net_1_1_file_list_transfer_c_b_interface.xhtml#af5f941dc32d509bb66c15c5a7fe44794" title="User data passed to one of the functions in the FileList class.">context</a>;</div>
<div class="line"><a name="l00069"></a><span class="lineno"> 69</span>&#160;</div>
<div class="line"><a name="l00071"></a><span class="lineno"><a class="code" href="../../d9/d93/class_s_l_net_1_1_file_list_transfer_c_b_interface.xhtml#a08b4cc5136d250aa796a30dbde103ad8"> 71</a></span>&#160; <a class="code" href="../../d8/dbe/struct_s_l_net_1_1_system_address.xhtml" title="Network address for a system.">SystemAddress</a> <a class="code" href="../../d9/d93/class_s_l_net_1_1_file_list_transfer_c_b_interface.xhtml#a08b4cc5136d250aa796a30dbde103ad8" title="Who sent this file.">senderSystemAddress</a>;</div>
<div class="line"><a name="l00072"></a><span class="lineno"> 72</span>&#160;</div>
<div class="line"><a name="l00074"></a><span class="lineno"><a class="code" href="../../d9/d93/class_s_l_net_1_1_file_list_transfer_c_b_interface.xhtml#a261ee334b67f04dce9587441a2e43ca8"> 74</a></span>&#160; <a class="code" href="../../dd/d3f/struct_s_l_net_1_1_rak_net_g_u_i_d.xhtml">RakNetGUID</a> <a class="code" href="../../d9/d93/class_s_l_net_1_1_file_list_transfer_c_b_interface.xhtml#a261ee334b67f04dce9587441a2e43ca8" title="Who sent this file. Not valid when using TCP, only RakPeer (UDP)">senderGuid</a>;</div>
<div class="line"><a name="l00075"></a><span class="lineno"> 75</span>&#160; };</div>
<div class="line"><a name="l00076"></a><span class="lineno"> 76</span>&#160;</div>
<div class="line"><a name="l00077"></a><span class="lineno"> 77</span>&#160; <span class="comment">// Note: If this structure is changed the struct in the swig files need to be changed as well</span></div>
<div class="line"><a name="l00078"></a><span class="lineno"><a class="code" href="../../d9/d93/class_s_l_net_1_1_file_list_transfer_c_b_interface.xhtml"> 78</a></span>&#160; <span class="keyword">struct </span><a class="code" href="../../d9/d93/class_s_l_net_1_1_file_list_transfer_c_b_interface.xhtml#d8/da1/struct_s_l_net_1_1_file_list_transfer_c_b_interface_1_1_file_progress_struct">FileProgressStruct</a></div>
<div class="line"><a name="l00079"></a><span class="lineno"> 79</span>&#160; {</div>
<div class="line"><a name="l00081"></a><span class="lineno"><a class="code" href="../../d9/d93/class_s_l_net_1_1_file_list_transfer_c_b_interface.xhtml#ae1ff21757fa0ba73f1466e3e321293c3"> 81</a></span>&#160; <a class="code" href="../../d9/d93/class_s_l_net_1_1_file_list_transfer_c_b_interface.xhtml#d1/d50/struct_s_l_net_1_1_file_list_transfer_c_b_interface_1_1_on_file_struct">OnFileStruct</a> *<a class="code" href="../../d9/d93/class_s_l_net_1_1_file_list_transfer_c_b_interface.xhtml#ae1ff21757fa0ba73f1466e3e321293c3">onFileStruct</a>;</div>
<div class="line"><a name="l00083"></a><span class="lineno"><a class="code" href="../../d9/d93/class_s_l_net_1_1_file_list_transfer_c_b_interface.xhtml#a75dd91b8c1b1f6d22fff32615ac06e00"> 83</a></span>&#160; <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> <a class="code" href="../../d9/d93/class_s_l_net_1_1_file_list_transfer_c_b_interface.xhtml#a75dd91b8c1b1f6d22fff32615ac06e00">partCount</a>;</div>
<div class="line"><a name="l00085"></a><span class="lineno"><a class="code" href="../../d9/d93/class_s_l_net_1_1_file_list_transfer_c_b_interface.xhtml#a81d4a6ae6bc72562b77f9d37626ba3cc"> 85</a></span>&#160; <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> <a class="code" href="../../d9/d93/class_s_l_net_1_1_file_list_transfer_c_b_interface.xhtml#a81d4a6ae6bc72562b77f9d37626ba3cc">partTotal</a>;</div>
<div class="line"><a name="l00087"></a><span class="lineno"><a class="code" href="../../d9/d93/class_s_l_net_1_1_file_list_transfer_c_b_interface.xhtml#ad2dd133df159031571410d08d4d0c086"> 87</a></span>&#160; <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> <a class="code" href="../../d9/d93/class_s_l_net_1_1_file_list_transfer_c_b_interface.xhtml#ad2dd133df159031571410d08d4d0c086">dataChunkLength</a>;</div>
<div class="line"><a name="l00089"></a><span class="lineno"><a class="code" href="../../d9/d93/class_s_l_net_1_1_file_list_transfer_c_b_interface.xhtml#a666ea1a0b1f49ba8e62b4b669dac0cbe"> 89</a></span>&#160; <span class="keywordtype">char</span> *<a class="code" href="../../d9/d93/class_s_l_net_1_1_file_list_transfer_c_b_interface.xhtml#a666ea1a0b1f49ba8e62b4b669dac0cbe">firstDataChunk</a>;</div>
<div class="line"><a name="l00091"></a><span class="lineno"><a class="code" href="../../d9/d93/class_s_l_net_1_1_file_list_transfer_c_b_interface.xhtml#a422219fd25a3821150f187888895ede5"> 91</a></span>&#160; <span class="keywordtype">char</span> *<a class="code" href="../../d9/d93/class_s_l_net_1_1_file_list_transfer_c_b_interface.xhtml#a422219fd25a3821150f187888895ede5">iriDataChunk</a>;</div>
<div class="line"><a name="l00093"></a><span class="lineno"><a class="code" href="../../d9/d93/class_s_l_net_1_1_file_list_transfer_c_b_interface.xhtml#aef3f9c7a702692cf7d4cdf25b006ec8e"> 93</a></span>&#160; <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> <a class="code" href="../../d9/d93/class_s_l_net_1_1_file_list_transfer_c_b_interface.xhtml#aef3f9c7a702692cf7d4cdf25b006ec8e">iriWriteOffset</a>;</div>
<div class="line"><a name="l00095"></a><span class="lineno"><a class="code" href="../../d9/d93/class_s_l_net_1_1_file_list_transfer_c_b_interface.xhtml#a5f4eae8053d1110f810e23bfc088a045"> 95</a></span>&#160; <a class="code" href="../../d8/dbe/struct_s_l_net_1_1_system_address.xhtml" title="Network address for a system.">SystemAddress</a> <a class="code" href="../../d9/d93/class_s_l_net_1_1_file_list_transfer_c_b_interface.xhtml#a5f4eae8053d1110f810e23bfc088a045">senderSystemAddress</a>;</div>
<div class="line"><a name="l00097"></a><span class="lineno"><a class="code" href="../../d9/d93/class_s_l_net_1_1_file_list_transfer_c_b_interface.xhtml#aef5f63527150dee0569a02009259af51"> 97</a></span>&#160; <a class="code" href="../../dd/d3f/struct_s_l_net_1_1_rak_net_g_u_i_d.xhtml">RakNetGUID</a> <a class="code" href="../../d9/d93/class_s_l_net_1_1_file_list_transfer_c_b_interface.xhtml#aef5f63527150dee0569a02009259af51">senderGuid</a>;</div>
<div class="line"><a name="l00099"></a><span class="lineno"><a class="code" href="../../d9/d93/class_s_l_net_1_1_file_list_transfer_c_b_interface.xhtml#adf41b25c775b2e6e38826d479c32ccce"> 99</a></span>&#160; <span class="keywordtype">bool</span> <a class="code" href="../../d9/d93/class_s_l_net_1_1_file_list_transfer_c_b_interface.xhtml#adf41b25c775b2e6e38826d479c32ccce">allocateIrIDataChunkAutomatically</a>;</div>
<div class="line"><a name="l00100"></a><span class="lineno"> 100</span>&#160; };</div>
<div class="line"><a name="l00101"></a><span class="lineno"> 101</span>&#160;</div>
<div class="line"><a name="l00102"></a><span class="lineno"><a class="code" href="../../d9/d93/class_s_l_net_1_1_file_list_transfer_c_b_interface.xhtml"> 102</a></span>&#160; <span class="keyword">struct </span><a class="code" href="../../d9/d93/class_s_l_net_1_1_file_list_transfer_c_b_interface.xhtml#dd/db9/struct_s_l_net_1_1_file_list_transfer_c_b_interface_1_1_download_complete_struct">DownloadCompleteStruct</a></div>
<div class="line"><a name="l00103"></a><span class="lineno"> 103</span>&#160; {</div>
<div class="line"><a name="l00106"></a><span class="lineno"><a class="code" href="../../d9/d93/class_s_l_net_1_1_file_list_transfer_c_b_interface.xhtml#afae147fd3c6aaed5ebf3fb8d82a6f73d"> 106</a></span>&#160; <span class="keywordtype">unsigned</span> <span class="keywordtype">short</span> <a class="code" href="../../d9/d93/class_s_l_net_1_1_file_list_transfer_c_b_interface.xhtml#afae147fd3c6aaed5ebf3fb8d82a6f73d" title="Files are transmitted in sets, where more than one set of files can be transmitted at the same time...">setID</a>;</div>
<div class="line"><a name="l00107"></a><span class="lineno"> 107</span>&#160;</div>
<div class="line"><a name="l00109"></a><span class="lineno"><a class="code" href="../../d9/d93/class_s_l_net_1_1_file_list_transfer_c_b_interface.xhtml#a535dfe10d0726104838c03b174e18c58"> 109</a></span>&#160; <span class="keywordtype">unsigned</span> <a class="code" href="../../d9/d93/class_s_l_net_1_1_file_list_transfer_c_b_interface.xhtml#a535dfe10d0726104838c03b174e18c58" title="The number of files that are in this set.">numberOfFilesInThisSet</a>;</div>
<div class="line"><a name="l00110"></a><span class="lineno"> 110</span>&#160;</div>
<div class="line"><a name="l00112"></a><span class="lineno"><a class="code" href="../../d9/d93/class_s_l_net_1_1_file_list_transfer_c_b_interface.xhtml#acc44389583a0e82d88ae503a4f4ef51e"> 112</a></span>&#160; <span class="keywordtype">unsigned</span> <a class="code" href="../../d9/d93/class_s_l_net_1_1_file_list_transfer_c_b_interface.xhtml#acc44389583a0e82d88ae503a4f4ef51e" title="The total length of the transmitted files for this set, after being uncompressed.">byteLengthOfThisSet</a>;</div>
<div class="line"><a name="l00113"></a><span class="lineno"> 113</span>&#160;</div>
<div class="line"><a name="l00115"></a><span class="lineno"><a class="code" href="../../d9/d93/class_s_l_net_1_1_file_list_transfer_c_b_interface.xhtml#a78b3248f939907fa126ddbea2d3a187f"> 115</a></span>&#160; <a class="code" href="../../d8/dbe/struct_s_l_net_1_1_system_address.xhtml" title="Network address for a system.">SystemAddress</a> <a class="code" href="../../d9/d93/class_s_l_net_1_1_file_list_transfer_c_b_interface.xhtml#a78b3248f939907fa126ddbea2d3a187f" title="Who sent this file.">senderSystemAddress</a>;</div>
<div class="line"><a name="l00116"></a><span class="lineno"> 116</span>&#160;</div>
<div class="line"><a name="l00118"></a><span class="lineno"><a class="code" href="../../d9/d93/class_s_l_net_1_1_file_list_transfer_c_b_interface.xhtml#aad185dfa6796a1aed4e5ab1d57f19233"> 118</a></span>&#160; <a class="code" href="../../dd/d3f/struct_s_l_net_1_1_rak_net_g_u_i_d.xhtml">RakNetGUID</a> <a class="code" href="../../d9/d93/class_s_l_net_1_1_file_list_transfer_c_b_interface.xhtml#aad185dfa6796a1aed4e5ab1d57f19233" title="Who sent this file. Not valid when using TCP, only RakPeer (UDP)">senderGuid</a>;</div>
<div class="line"><a name="l00119"></a><span class="lineno"> 119</span>&#160; };</div>
<div class="line"><a name="l00120"></a><span class="lineno"> 120</span>&#160;</div>
<div class="line"><a name="l00121"></a><span class="lineno"><a class="code" href="../../d9/d93/class_s_l_net_1_1_file_list_transfer_c_b_interface.xhtml#ae5c56d03dc6ff46ad31b4b34bed40ca2"> 121</a></span>&#160; <a class="code" href="../../d9/d93/class_s_l_net_1_1_file_list_transfer_c_b_interface.xhtml#ae5c56d03dc6ff46ad31b4b34bed40ca2">FileListTransferCBInterface</a>() {}</div>
<div class="line"><a name="l00122"></a><span class="lineno"><a class="code" href="../../d9/d93/class_s_l_net_1_1_file_list_transfer_c_b_interface.xhtml#ae6d6e039316244f607dd485e84480b8e"> 122</a></span>&#160; <span class="keyword">virtual</span> <a class="code" href="../../d9/d93/class_s_l_net_1_1_file_list_transfer_c_b_interface.xhtml#ae6d6e039316244f607dd485e84480b8e">~FileListTransferCBInterface</a>() {}</div>
<div class="line"><a name="l00123"></a><span class="lineno"> 123</span>&#160;</div>
<div class="line"><a name="l00127"></a><span class="lineno"> 127</span>&#160; <span class="keyword">virtual</span> <span class="keywordtype">bool</span> <a class="code" href="../../d9/d93/class_s_l_net_1_1_file_list_transfer_c_b_interface.xhtml#ac12fe740de93b14f21469bf62cceed44" title="Got a file.">OnFile</a>(OnFileStruct *onFileStruct)=0;</div>
<div class="line"><a name="l00128"></a><span class="lineno"> 128</span>&#160;</div>
<div class="line"><a name="l00136"></a><span class="lineno"> 136</span>&#160; <span class="keyword">virtual</span> <span class="keywordtype">void</span> <a class="code" href="../../d9/d93/class_s_l_net_1_1_file_list_transfer_c_b_interface.xhtml#a3d887728c405e65750c1c385fbd595fb" title="Got part of a big file internally in RakNet.">OnFileProgress</a>(FileProgressStruct *fps)=0;</div>
<div class="line"><a name="l00137"></a><span class="lineno"> 137</span>&#160;</div>
<div class="line"><a name="l00141"></a><span class="lineno"><a class="code" href="../../d9/d93/class_s_l_net_1_1_file_list_transfer_c_b_interface.xhtml#ad92626087d62f5545d85e3226eb347e8"> 141</a></span>&#160; <span class="keyword">virtual</span> <span class="keywordtype">bool</span> <a class="code" href="../../d9/d93/class_s_l_net_1_1_file_list_transfer_c_b_interface.xhtml#ad92626087d62f5545d85e3226eb347e8" title="Called while the handler is active by FileListTransfer.">Update</a>(<span class="keywordtype">void</span>) {<span class="keywordflow">return</span> <span class="keyword">true</span>;}</div>
<div class="line"><a name="l00142"></a><span class="lineno"> 142</span>&#160;</div>
<div class="line"><a name="l00147"></a><span class="lineno"><a class="code" href="../../d9/d93/class_s_l_net_1_1_file_list_transfer_c_b_interface.xhtml#a7c3c1cd4c69565f1ae2eebf465aecf3d"> 147</a></span>&#160; <span class="keyword">virtual</span> <span class="keywordtype">bool</span> <a class="code" href="../../d9/d93/class_s_l_net_1_1_file_list_transfer_c_b_interface.xhtml#a7c3c1cd4c69565f1ae2eebf465aecf3d" title="Called when the download is completed.">OnDownloadComplete</a>(<a class="code" href="../../d9/d93/class_s_l_net_1_1_file_list_transfer_c_b_interface.xhtml#dd/db9/struct_s_l_net_1_1_file_list_transfer_c_b_interface_1_1_download_complete_struct">DownloadCompleteStruct</a> *dcs) {(void) dcs; <span class="keywordflow">return</span> <span class="keyword">false</span>;}</div>
<div class="line"><a name="l00148"></a><span class="lineno"> 148</span>&#160;</div>
<div class="line"><a name="l00153"></a><span class="lineno"><a class="code" href="../../d9/d93/class_s_l_net_1_1_file_list_transfer_c_b_interface.xhtml#ac4425319ebcdd556269149fd96dbb269"> 153</a></span>&#160; <span class="keyword">virtual</span> <span class="keywordtype">void</span> <a class="code" href="../../d9/d93/class_s_l_net_1_1_file_list_transfer_c_b_interface.xhtml#ac4425319ebcdd556269149fd96dbb269" title="This function is called when this instance is about to be dereferenced by the FileListTransfer plugin...">OnDereference</a>(<span class="keywordtype">void</span>) {}</div>
<div class="line"><a name="l00154"></a><span class="lineno"> 154</span>&#160;};</div>
<div class="line"><a name="l00155"></a><span class="lineno"> 155</span>&#160;</div>
<div class="line"><a name="l00156"></a><span class="lineno"> 156</span>&#160;} <span class="comment">// namespace SLNet</span></div>
<div class="line"><a name="l00157"></a><span class="lineno"> 157</span>&#160;</div>
<div class="line"><a name="l00158"></a><span class="lineno"> 158</span>&#160;<span class="preprocessor">#endif</span></div>
<div class="line"><a name="l00159"></a><span class="lineno"> 159</span>&#160;<span class="preprocessor"></span></div>
</div><!-- fragment --></div><!-- contents -->
</div><!-- doc-content -->
<!-- start footer part -->
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
<ul>
<li class="navelem"><a class="el" href="../../dir_74389ed8173ad57b461b9d623a1f3867.xhtml">Source</a></li><li class="navelem"><a class="el" href="../../dir_bbb90e3ef9167a594ae33323139a2595.xhtml">include</a></li><li class="navelem"><a class="el" href="../../dir_88467e66686deb9d3756fe4fc298e321.xhtml">slikenet</a></li><li class="navelem"><a class="el" href="../../df/dd9/_file_list_transfer_c_b_interface_8h.xhtml">FileListTransferCBInterface.h</a></li>
<li class="footer">Generated on Wed Aug 14 2019 22:09:46 for SLikeNet by
<a href="http://www.doxygen.org/index.html">
<img class="footer" src="../../doxygen.png" alt="doxygen"/></a> 1.8.2 </li>
</ul>
</div>
</body>
</html>

3
Help/Doxygen/html/df/dd9/class_data_structures_1_1_range_list__inherit__graph.map Normal file
View File

@ -0,0 +1,3 @@
<map id="DataStructures::RangeList&lt; range_type &gt;" name="DataStructures::RangeList&lt; range_type &gt;">
<area shape="rect" id="node2" href="$d4/df2/class_data_structures_1_1_range_list.xhtml" title="{DataStructures::RangeList\l\&lt; DatagramSequenceNumberType \&gt;\n|+ ranges\l|+ RangeList()\l+ ~RangeList()\l+ Insert()\l+ Clear()\l+ IsWithinRange()\l+ Size()\l+ RangeSum()\l+ Serialize()\l+ Deserialize()\l}" alt="" coords="5,292,239,501"/>
</map>

1
Help/Doxygen/html/df/dd9/class_data_structures_1_1_range_list__inherit__graph.md5 Normal file
View File

@ -0,0 +1 @@
95ccc61ccdae86821fab49d578860a3d

58
Help/Doxygen/html/df/dd9/class_data_structures_1_1_range_list__inherit__graph.svg Normal file
View File

@ -0,0 +1,58 @@
<?xml version="1.0" encoding="UTF-8" standalone="no"?>
<!DOCTYPE svg PUBLIC "-//W3C//DTD SVG 1.1//EN"
"http://www.w3.org/Graphics/SVG/1.1/DTD/svg11.dtd">
<!-- Generated by graphviz version 2.38.0 (20140413.2041)
-->
<!-- Title: DataStructures::RangeList&lt; range_type &gt; Pages: 1 -->
<svg width="228pt" height="380pt"
viewBox="0.00 0.00 227.50 380.00" xmlns="http://www.w3.org/2000/svg" xmlns:xlink="http://www.w3.org/1999/xlink">
<g id="graph0" class="graph" transform="scale(1 1) rotate(0) translate(4 376)">
<title>DataStructures::RangeList&lt; range_type &gt;</title>
<!-- Node1 -->
<g id="node1" class="node"><title>Node1</title>
<polygon fill="#bfbfbf" stroke="black" points="22,-215.5 22,-371.5 153,-371.5 153,-215.5 22,-215.5"/>
<text text-anchor="start" x="30" y="-359.5" font-family="Helvetica,sans-Serif" font-size="10.00">DataStructures::RangeList</text>
<text text-anchor="middle" x="87.5" y="-348.5" font-family="Helvetica,sans-Serif" font-size="10.00">&lt; range_type &gt;</text>
<polyline fill="none" stroke="black" points="22,-341.5 153,-341.5 "/>
<text text-anchor="start" x="30" y="-329.5" font-family="Helvetica,sans-Serif" font-size="10.00">+ ranges</text>
<polyline fill="none" stroke="black" points="22,-322.5 153,-322.5 "/>
<text text-anchor="start" x="30" y="-310.5" font-family="Helvetica,sans-Serif" font-size="10.00">+ RangeList()</text>
<text text-anchor="start" x="30" y="-299.5" font-family="Helvetica,sans-Serif" font-size="10.00">+ ~RangeList()</text>
<text text-anchor="start" x="30" y="-288.5" font-family="Helvetica,sans-Serif" font-size="10.00">+ Insert()</text>
<text text-anchor="start" x="30" y="-277.5" font-family="Helvetica,sans-Serif" font-size="10.00">+ Clear()</text>
<text text-anchor="start" x="30" y="-266.5" font-family="Helvetica,sans-Serif" font-size="10.00">+ IsWithinRange()</text>
<text text-anchor="start" x="30" y="-255.5" font-family="Helvetica,sans-Serif" font-size="10.00">+ Size()</text>
<text text-anchor="start" x="30" y="-244.5" font-family="Helvetica,sans-Serif" font-size="10.00">+ RangeSum()</text>
<text text-anchor="start" x="30" y="-233.5" font-family="Helvetica,sans-Serif" font-size="10.00">+ Serialize()</text>
<text text-anchor="start" x="30" y="-222.5" font-family="Helvetica,sans-Serif" font-size="10.00">+ Deserialize()</text>
</g>
<!-- Node2 -->
<g id="node2" class="node"><title>Node2</title>
<g id="a_node2"><a xlink:href="../../d4/df2/class_data_structures_1_1_range_list.xhtml" target="_top" xlink:title="{DataStructures::RangeList\l\&lt; DatagramSequenceNumberType \&gt;\n|+ ranges\l|+ RangeList()\l+ ~RangeList()\l+ Insert()\l+ Clear()\l+ IsWithinRange()\l+ Size()\l+ RangeSum()\l+ Serialize()\l+ Deserialize()\l}">
<polygon fill="none" stroke="black" points="0,-0.5 0,-156.5 175,-156.5 175,-0.5 0,-0.5"/>
<text text-anchor="start" x="8" y="-144.5" font-family="Helvetica,sans-Serif" font-size="10.00">DataStructures::RangeList</text>
<text text-anchor="middle" x="87.5" y="-133.5" font-family="Helvetica,sans-Serif" font-size="10.00">&lt; DatagramSequenceNumberType &gt;</text>
<polyline fill="none" stroke="black" points="0,-126.5 175,-126.5 "/>
<text text-anchor="start" x="8" y="-114.5" font-family="Helvetica,sans-Serif" font-size="10.00">+ ranges</text>
<polyline fill="none" stroke="black" points="0,-107.5 175,-107.5 "/>
<text text-anchor="start" x="8" y="-95.5" font-family="Helvetica,sans-Serif" font-size="10.00">+ RangeList()</text>
<text text-anchor="start" x="8" y="-84.5" font-family="Helvetica,sans-Serif" font-size="10.00">+ ~RangeList()</text>
<text text-anchor="start" x="8" y="-73.5" font-family="Helvetica,sans-Serif" font-size="10.00">+ Insert()</text>
<text text-anchor="start" x="8" y="-62.5" font-family="Helvetica,sans-Serif" font-size="10.00">+ Clear()</text>
<text text-anchor="start" x="8" y="-51.5" font-family="Helvetica,sans-Serif" font-size="10.00">+ IsWithinRange()</text>
<text text-anchor="start" x="8" y="-40.5" font-family="Helvetica,sans-Serif" font-size="10.00">+ Size()</text>
<text text-anchor="start" x="8" y="-29.5" font-family="Helvetica,sans-Serif" font-size="10.00">+ RangeSum()</text>
<text text-anchor="start" x="8" y="-18.5" font-family="Helvetica,sans-Serif" font-size="10.00">+ Serialize()</text>
<text text-anchor="start" x="8" y="-7.5" font-family="Helvetica,sans-Serif" font-size="10.00">+ Deserialize()</text>
</a>
</g>
</g>
<!-- Node1&#45;&gt;Node2 -->
<g id="edge1" class="edge"><title>Node1&#45;&gt;Node2</title>
<path fill="none" stroke="orange" d="M87.5,-204.917C87.5,-188.962 87.5,-172.423 87.5,-156.793"/>
<polygon fill="orange" stroke="orange" points="84.0001,-205.301 87.5,-215.301 91.0001,-205.301 84.0001,-205.301"/>
<text text-anchor="start" x="87.5" y="-189" font-family="Helvetica,sans-Serif" font-size="10.00"> &lt; DatagramSequenceNumber</text>
<text text-anchor="middle" x="153.5" y="-178" font-family="Helvetica,sans-Serif" font-size="10.00">Type &gt;</text>
</g>
</g>
</svg>
Side by Side

After

Width:  |  Height:  |  Size: 4.8 KiB