Init
This commit is contained in:
@ -0,0 +1,43 @@
|
||||
var class_s_l_net_1_1_file_list_transfer_c_b_interface =
|
||||
[
|
||||
[ "DownloadCompleteStruct", "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", [
|
||||
[ "byteLengthOfThisSet", "d9/d93/class_s_l_net_1_1_file_list_transfer_c_b_interface.xhtml#acc44389583a0e82d88ae503a4f4ef51e", null ],
|
||||
[ "numberOfFilesInThisSet", "d9/d93/class_s_l_net_1_1_file_list_transfer_c_b_interface.xhtml#a535dfe10d0726104838c03b174e18c58", null ],
|
||||
[ "senderGuid", "d9/d93/class_s_l_net_1_1_file_list_transfer_c_b_interface.xhtml#aad185dfa6796a1aed4e5ab1d57f19233", null ],
|
||||
[ "senderSystemAddress", "d9/d93/class_s_l_net_1_1_file_list_transfer_c_b_interface.xhtml#a78b3248f939907fa126ddbea2d3a187f", null ],
|
||||
[ "setID", "d9/d93/class_s_l_net_1_1_file_list_transfer_c_b_interface.xhtml#afae147fd3c6aaed5ebf3fb8d82a6f73d", null ]
|
||||
] ],
|
||||
[ "FileProgressStruct", "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", [
|
||||
[ "allocateIrIDataChunkAutomatically", "d9/d93/class_s_l_net_1_1_file_list_transfer_c_b_interface.xhtml#adf41b25c775b2e6e38826d479c32ccce", null ],
|
||||
[ "dataChunkLength", "d9/d93/class_s_l_net_1_1_file_list_transfer_c_b_interface.xhtml#ad2dd133df159031571410d08d4d0c086", null ],
|
||||
[ "firstDataChunk", "d9/d93/class_s_l_net_1_1_file_list_transfer_c_b_interface.xhtml#a666ea1a0b1f49ba8e62b4b669dac0cbe", null ],
|
||||
[ "iriDataChunk", "d9/d93/class_s_l_net_1_1_file_list_transfer_c_b_interface.xhtml#a422219fd25a3821150f187888895ede5", null ],
|
||||
[ "iriWriteOffset", "d9/d93/class_s_l_net_1_1_file_list_transfer_c_b_interface.xhtml#aef3f9c7a702692cf7d4cdf25b006ec8e", null ],
|
||||
[ "onFileStruct", "d9/d93/class_s_l_net_1_1_file_list_transfer_c_b_interface.xhtml#ae1ff21757fa0ba73f1466e3e321293c3", null ],
|
||||
[ "partCount", "d9/d93/class_s_l_net_1_1_file_list_transfer_c_b_interface.xhtml#a75dd91b8c1b1f6d22fff32615ac06e00", null ],
|
||||
[ "partTotal", "d9/d93/class_s_l_net_1_1_file_list_transfer_c_b_interface.xhtml#a81d4a6ae6bc72562b77f9d37626ba3cc", null ],
|
||||
[ "senderGuid", "d9/d93/class_s_l_net_1_1_file_list_transfer_c_b_interface.xhtml#aef5f63527150dee0569a02009259af51", null ],
|
||||
[ "senderSystemAddress", "d9/d93/class_s_l_net_1_1_file_list_transfer_c_b_interface.xhtml#a5f4eae8053d1110f810e23bfc088a045", null ]
|
||||
] ],
|
||||
[ "OnFileStruct", "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", [
|
||||
[ "byteLengthOfThisFile", "d9/d93/class_s_l_net_1_1_file_list_transfer_c_b_interface.xhtml#a1150f5d4c01a00a7b6837f989e23ddc4", null ],
|
||||
[ "byteLengthOfThisSet", "d9/d93/class_s_l_net_1_1_file_list_transfer_c_b_interface.xhtml#a036e574fd5ce390a05dd4c581334e2f3", null ],
|
||||
[ "bytesDownloadedForThisFile", "d9/d93/class_s_l_net_1_1_file_list_transfer_c_b_interface.xhtml#aeab7ef5abd159f9c3c095032b4b5fd02", null ],
|
||||
[ "bytesDownloadedForThisSet", "d9/d93/class_s_l_net_1_1_file_list_transfer_c_b_interface.xhtml#a9a41afb708b1f76a506c900a430584d1", null ],
|
||||
[ "context", "d9/d93/class_s_l_net_1_1_file_list_transfer_c_b_interface.xhtml#af5f941dc32d509bb66c15c5a7fe44794", null ],
|
||||
[ "fileData", "d9/d93/class_s_l_net_1_1_file_list_transfer_c_b_interface.xhtml#a7f33f08b1d0a0a0d1e7448e20ce9836d", null ],
|
||||
[ "fileIndex", "d9/d93/class_s_l_net_1_1_file_list_transfer_c_b_interface.xhtml#a3928099fd6ca6a67a5a03052c346108e", null ],
|
||||
[ "fileName", "d9/d93/class_s_l_net_1_1_file_list_transfer_c_b_interface.xhtml#a9bcdd45b835eb946daf6d711dd8ef9b1", null ],
|
||||
[ "numberOfFilesInThisSet", "d9/d93/class_s_l_net_1_1_file_list_transfer_c_b_interface.xhtml#a125a510be0663479ca3a4661523580d4", null ],
|
||||
[ "senderGuid", "d9/d93/class_s_l_net_1_1_file_list_transfer_c_b_interface.xhtml#a261ee334b67f04dce9587441a2e43ca8", null ],
|
||||
[ "senderSystemAddress", "d9/d93/class_s_l_net_1_1_file_list_transfer_c_b_interface.xhtml#a08b4cc5136d250aa796a30dbde103ad8", null ],
|
||||
[ "setID", "d9/d93/class_s_l_net_1_1_file_list_transfer_c_b_interface.xhtml#a5822e23f90012acc26d1da1348630fcb", null ]
|
||||
] ],
|
||||
[ "FileListTransferCBInterface", "d9/d93/class_s_l_net_1_1_file_list_transfer_c_b_interface.xhtml#ae5c56d03dc6ff46ad31b4b34bed40ca2", null ],
|
||||
[ "~FileListTransferCBInterface", "d9/d93/class_s_l_net_1_1_file_list_transfer_c_b_interface.xhtml#ae6d6e039316244f607dd485e84480b8e", null ],
|
||||
[ "OnDereference", "d9/d93/class_s_l_net_1_1_file_list_transfer_c_b_interface.xhtml#ac4425319ebcdd556269149fd96dbb269", null ],
|
||||
[ "OnDownloadComplete", "d9/d93/class_s_l_net_1_1_file_list_transfer_c_b_interface.xhtml#a7c3c1cd4c69565f1ae2eebf465aecf3d", null ],
|
||||
[ "OnFile", "d9/d93/class_s_l_net_1_1_file_list_transfer_c_b_interface.xhtml#ac12fe740de93b14f21469bf62cceed44", null ],
|
||||
[ "OnFileProgress", "d9/d93/class_s_l_net_1_1_file_list_transfer_c_b_interface.xhtml#a3d887728c405e65750c1c385fbd595fb", null ],
|
||||
[ "Update", "d9/d93/class_s_l_net_1_1_file_list_transfer_c_b_interface.xhtml#ad92626087d62f5545d85e3226eb347e8", null ]
|
||||
];
|
||||
@ -0,0 +1,641 @@
|
||||
<!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: SLNet::FileListTransferCBInterface Class 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
|
||||
 <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 Page</span></a></li>
|
||||
<li><a href="../../pages.xhtml"><span>Related 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 class="current"><a href="../../annotated.xhtml"><span>Classes</span></a></li>
|
||||
<li><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="../../annotated.xhtml"><span>Class List</span></a></li>
|
||||
<li><a href="../../classes.xhtml"><span>Class Index</span></a></li>
|
||||
<li><a href="../../inherits.xhtml"><span>Class Hierarchy</span></a></li>
|
||||
<li><a href="../../functions.xhtml"><span>Class 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('d9/d93/class_s_l_net_1_1_file_list_transfer_c_b_interface.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"> </span>All</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(1)"><span class="SelectionMark"> </span>Classes</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(2)"><span class="SelectionMark"> </span>Namespaces</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(3)"><span class="SelectionMark"> </span>Files</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(4)"><span class="SelectionMark"> </span>Functions</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(5)"><span class="SelectionMark"> </span>Variables</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(6)"><span class="SelectionMark"> </span>Typedefs</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(7)"><span class="SelectionMark"> </span>Enumerations</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(8)"><span class="SelectionMark"> </span>Enumerator</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(9)"><span class="SelectionMark"> </span>Friends</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(10)"><span class="SelectionMark"> </span>Macros</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(11)"><span class="SelectionMark"> </span>Groups</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(12)"><span class="SelectionMark"> </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> |
|
||||
<a href="#pub-methods">Public Member Functions</a> |
|
||||
<a href="../../d9/d5e/class_s_l_net_1_1_file_list_transfer_c_b_interface-members.xhtml">List of all members</a> </div>
|
||||
<div class="headertitle">
|
||||
<div class="title">SLNet::FileListTransferCBInterface Class Reference<span class="mlabels"><span class="mlabel">abstract</span></span></div> </div>
|
||||
</div><!--header-->
|
||||
<div class="contents">
|
||||
|
||||
<p>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></p>
|
||||
|
||||
<p><code>#include <<a class="el" href="../../df/dd9/_file_list_transfer_c_b_interface_8h_source.xhtml">slikenet/FileListTransferCBInterface.h</a>></code></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: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  </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">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"> </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  </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">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"> </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  </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">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"> </td></tr>
|
||||
</table><table class="memberdecls">
|
||||
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a>
|
||||
Public Member Functions</h2></td></tr>
|
||||
<tr class="memitem:ae5c56d03dc6ff46ad31b4b34bed40ca2"><td class="memItemLeft" align="right" valign="top"> </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#ae5c56d03dc6ff46ad31b4b34bed40ca2">FileListTransferCBInterface</a> ()</td></tr>
|
||||
<tr class="separator:ae5c56d03dc6ff46ad31b4b34bed40ca2"><td class="memSeparator" colspan="2"> </td></tr>
|
||||
<tr class="memitem:ae6d6e039316244f607dd485e84480b8e"><td class="memItemLeft" align="right" valign="top">virtual </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#ae6d6e039316244f607dd485e84480b8e">~FileListTransferCBInterface</a> ()</td></tr>
|
||||
<tr class="separator:ae6d6e039316244f607dd485e84480b8e"><td class="memSeparator" colspan="2"> </td></tr>
|
||||
<tr class="memitem:ac12fe740de93b14f21469bf62cceed44"><td class="memItemLeft" align="right" valign="top">virtual bool </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#ac12fe740de93b14f21469bf62cceed44">OnFile</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> *onFileStruct)=0</td></tr>
|
||||
<tr class="memdesc:ac12fe740de93b14f21469bf62cceed44"><td class="mdescLeft"> </td><td class="mdescRight">Got a file. <a href="#ac12fe740de93b14f21469bf62cceed44"></a><br/></td></tr>
|
||||
<tr class="separator:ac12fe740de93b14f21469bf62cceed44"><td class="memSeparator" colspan="2"> </td></tr>
|
||||
<tr class="memitem:a3d887728c405e65750c1c385fbd595fb"><td class="memItemLeft" align="right" valign="top">virtual void </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#a3d887728c405e65750c1c385fbd595fb">OnFileProgress</a> (<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">FileProgressStruct</a> *fps)=0</td></tr>
|
||||
<tr class="memdesc:a3d887728c405e65750c1c385fbd595fb"><td class="mdescLeft"> </td><td class="mdescRight">Got part of a big file internally in RakNet. <a href="#a3d887728c405e65750c1c385fbd595fb"></a><br/></td></tr>
|
||||
<tr class="separator:a3d887728c405e65750c1c385fbd595fb"><td class="memSeparator" colspan="2"> </td></tr>
|
||||
<tr class="memitem:ad92626087d62f5545d85e3226eb347e8"><td class="memItemLeft" align="right" valign="top">virtual bool </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#ad92626087d62f5545d85e3226eb347e8">Update</a> (void)</td></tr>
|
||||
<tr class="memdesc:ad92626087d62f5545d85e3226eb347e8"><td class="mdescLeft"> </td><td class="mdescRight">Called while the handler is active 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>. <a href="#ad92626087d62f5545d85e3226eb347e8"></a><br/></td></tr>
|
||||
<tr class="separator:ad92626087d62f5545d85e3226eb347e8"><td class="memSeparator" colspan="2"> </td></tr>
|
||||
<tr class="memitem:a7c3c1cd4c69565f1ae2eebf465aecf3d"><td class="memItemLeft" align="right" valign="top">virtual bool </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#a7c3c1cd4c69565f1ae2eebf465aecf3d">OnDownloadComplete</a> (<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">DownloadCompleteStruct</a> *dcs)</td></tr>
|
||||
<tr class="memdesc:a7c3c1cd4c69565f1ae2eebf465aecf3d"><td class="mdescLeft"> </td><td class="mdescRight">Called when the download is completed. <a href="#a7c3c1cd4c69565f1ae2eebf465aecf3d"></a><br/></td></tr>
|
||||
<tr class="separator:a7c3c1cd4c69565f1ae2eebf465aecf3d"><td class="memSeparator" colspan="2"> </td></tr>
|
||||
<tr class="memitem:ac4425319ebcdd556269149fd96dbb269"><td class="memItemLeft" align="right" valign="top">virtual void </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#ac4425319ebcdd556269149fd96dbb269">OnDereference</a> (void)</td></tr>
|
||||
<tr class="memdesc:ac4425319ebcdd556269149fd96dbb269"><td class="mdescLeft"> </td><td class="mdescRight">This function is called when this instance is about to be dereferenced by the <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. <a href="#ac4425319ebcdd556269149fd96dbb269"></a><br/></td></tr>
|
||||
<tr class="separator:ac4425319ebcdd556269149fd96dbb269"><td class="memSeparator" colspan="2"> </td></tr>
|
||||
</table>
|
||||
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
|
||||
<div class="textblock"><p>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. </p>
|
||||
<p>You get the last file when fileIndex==numberOfFilesInThisSet </p>
|
||||
<dl class="section see"><dt>See Also</dt><dd><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> </dd></dl>
|
||||
|
||||
<p>Definition at line <a class="el" href="../../df/dd9/_file_list_transfer_c_b_interface_8h_source.xhtml#l00032">32</a> of file <a class="el" href="../../df/dd9/_file_list_transfer_c_b_interface_8h_source.xhtml">FileListTransferCBInterface.h</a>.</p>
|
||||
</div><hr/><h2 class="groupheader">Class Documentation</h2>
|
||||
<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>
|
||||
<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="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>
|
||||
<h2 class="groupheader">Constructor & Destructor Documentation</h2>
|
||||
<a class="anchor" id="ae5c56d03dc6ff46ad31b4b34bed40ca2"></a>
|
||||
<div class="memitem">
|
||||
<div class="memproto">
|
||||
<table class="mlabels">
|
||||
<tr>
|
||||
<td class="mlabels-left">
|
||||
<table class="memname">
|
||||
<tr>
|
||||
<td class="memname">SLNet::FileListTransferCBInterface::FileListTransferCBInterface </td>
|
||||
<td>(</td>
|
||||
<td class="paramname"></td><td>)</td>
|
||||
<td></td>
|
||||
</tr>
|
||||
</table>
|
||||
</td>
|
||||
<td class="mlabels-right">
|
||||
<span class="mlabels"><span class="mlabel">inline</span></span> </td>
|
||||
</tr>
|
||||
</table>
|
||||
</div><div class="memdoc">
|
||||
|
||||
<p>Definition at line <a class="el" href="../../df/dd9/_file_list_transfer_c_b_interface_8h_source.xhtml#l00121">121</a> of file <a class="el" href="../../df/dd9/_file_list_transfer_c_b_interface_8h_source.xhtml">FileListTransferCBInterface.h</a>.</p>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
<a class="anchor" id="ae6d6e039316244f607dd485e84480b8e"></a>
|
||||
<div class="memitem">
|
||||
<div class="memproto">
|
||||
<table class="mlabels">
|
||||
<tr>
|
||||
<td class="mlabels-left">
|
||||
<table class="memname">
|
||||
<tr>
|
||||
<td class="memname">virtual SLNet::FileListTransferCBInterface::~FileListTransferCBInterface </td>
|
||||
<td>(</td>
|
||||
<td class="paramname"></td><td>)</td>
|
||||
<td></td>
|
||||
</tr>
|
||||
</table>
|
||||
</td>
|
||||
<td class="mlabels-right">
|
||||
<span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">virtual</span></span> </td>
|
||||
</tr>
|
||||
</table>
|
||||
</div><div class="memdoc">
|
||||
|
||||
<p>Definition at line <a class="el" href="../../df/dd9/_file_list_transfer_c_b_interface_8h_source.xhtml#l00122">122</a> of file <a class="el" href="../../df/dd9/_file_list_transfer_c_b_interface_8h_source.xhtml">FileListTransferCBInterface.h</a>.</p>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
<h2 class="groupheader">Member Function Documentation</h2>
|
||||
<a class="anchor" id="ac4425319ebcdd556269149fd96dbb269"></a>
|
||||
<div class="memitem">
|
||||
<div class="memproto">
|
||||
<table class="mlabels">
|
||||
<tr>
|
||||
<td class="mlabels-left">
|
||||
<table class="memname">
|
||||
<tr>
|
||||
<td class="memname">virtual void SLNet::FileListTransferCBInterface::OnDereference </td>
|
||||
<td>(</td>
|
||||
<td class="paramtype">void </td>
|
||||
<td class="paramname"></td><td>)</td>
|
||||
<td></td>
|
||||
</tr>
|
||||
</table>
|
||||
</td>
|
||||
<td class="mlabels-right">
|
||||
<span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">virtual</span></span> </td>
|
||||
</tr>
|
||||
</table>
|
||||
</div><div class="memdoc">
|
||||
|
||||
<p>This function is called when this instance is about to be dereferenced by the <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. </p>
|
||||
<p>Update will no longer be called. It will will be deleted automatically if true was passed to FileListTransfer::SetupReceive::deleteHandler Otherwise it is up to you to delete it yourself. </p>
|
||||
|
||||
<p>Definition at line <a class="el" href="../../df/dd9/_file_list_transfer_c_b_interface_8h_source.xhtml#l00153">153</a> of file <a class="el" href="../../df/dd9/_file_list_transfer_c_b_interface_8h_source.xhtml">FileListTransferCBInterface.h</a>.</p>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
<a class="anchor" id="a7c3c1cd4c69565f1ae2eebf465aecf3d"></a>
|
||||
<div class="memitem">
|
||||
<div class="memproto">
|
||||
<table class="mlabels">
|
||||
<tr>
|
||||
<td class="mlabels-left">
|
||||
<table class="memname">
|
||||
<tr>
|
||||
<td class="memname">virtual bool SLNet::FileListTransferCBInterface::OnDownloadComplete </td>
|
||||
<td>(</td>
|
||||
<td class="paramtype"><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">DownloadCompleteStruct</a> * </td>
|
||||
<td class="paramname"><em>dcs</em></td><td>)</td>
|
||||
<td></td>
|
||||
</tr>
|
||||
</table>
|
||||
</td>
|
||||
<td class="mlabels-right">
|
||||
<span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">virtual</span></span> </td>
|
||||
</tr>
|
||||
</table>
|
||||
</div><div class="memdoc">
|
||||
|
||||
<p>Called when the download is completed. </p>
|
||||
<p>If you are finished with this class, return false. At that point OnDereference will be called and the class will no longer be maintained by the <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. Otherwise return true, and Update will continue to be called. </p>
|
||||
|
||||
<p>Definition at line <a class="el" href="../../df/dd9/_file_list_transfer_c_b_interface_8h_source.xhtml#l00147">147</a> of file <a class="el" href="../../df/dd9/_file_list_transfer_c_b_interface_8h_source.xhtml">FileListTransferCBInterface.h</a>.</p>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
<a class="anchor" id="ac12fe740de93b14f21469bf62cceed44"></a>
|
||||
<div class="memitem">
|
||||
<div class="memproto">
|
||||
<table class="mlabels">
|
||||
<tr>
|
||||
<td class="mlabels-left">
|
||||
<table class="memname">
|
||||
<tr>
|
||||
<td class="memname">virtual bool SLNet::FileListTransferCBInterface::OnFile </td>
|
||||
<td>(</td>
|
||||
<td class="paramtype"><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="paramname"><em>onFileStruct</em></td><td>)</td>
|
||||
<td></td>
|
||||
</tr>
|
||||
</table>
|
||||
</td>
|
||||
<td class="mlabels-right">
|
||||
<span class="mlabels"><span class="mlabel">pure virtual</span></span> </td>
|
||||
</tr>
|
||||
</table>
|
||||
</div><div class="memdoc">
|
||||
|
||||
<p>Got a file. </p>
|
||||
<p>This structure is only valid for the duration of this function call. </p>
|
||||
<dl class="section return"><dt>Returns</dt><dd>Return true to have RakNet delete the memory allocated to hold this file for this function call. </dd></dl>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
<a class="anchor" id="a3d887728c405e65750c1c385fbd595fb"></a>
|
||||
<div class="memitem">
|
||||
<div class="memproto">
|
||||
<table class="mlabels">
|
||||
<tr>
|
||||
<td class="mlabels-left">
|
||||
<table class="memname">
|
||||
<tr>
|
||||
<td class="memname">virtual void SLNet::FileListTransferCBInterface::OnFileProgress </td>
|
||||
<td>(</td>
|
||||
<td class="paramtype"><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">FileProgressStruct</a> * </td>
|
||||
<td class="paramname"><em>fps</em></td><td>)</td>
|
||||
<td></td>
|
||||
</tr>
|
||||
</table>
|
||||
</td>
|
||||
<td class="mlabels-right">
|
||||
<span class="mlabels"><span class="mlabel">pure virtual</span></span> </td>
|
||||
</tr>
|
||||
</table>
|
||||
</div><div class="memdoc">
|
||||
|
||||
<p>Got part of a big file internally in RakNet. </p>
|
||||
<p>This is called in one of two circumstances: Either the transport layer is returning ID_PROGRESS_NOTIFICATION, or you got a block via <a class="el" href="../../df/d02/class_s_l_net_1_1_incremental_read_interface.xhtml">IncrementalReadInterface</a> If the transport layer is returning ID_PROGRESS_NOTIFICATION (see <a class="el" href="../../d5/dbf/class_s_l_net_1_1_rak_peer.xhtml#ac1cb3f6aeaa842c721bbe4a3d74c3d5d" title="Controls how often to return ID_DOWNLOAD_PROGRESS for large message downloads.">RakPeer::SetSplitMessageProgressInterval()</a>) then <a class="el" href="../../d9/d93/class_s_l_net_1_1_file_list_transfer_c_b_interface.xhtml#a422219fd25a3821150f187888895ede5">FileProgressStruct::iriDataChunk</a> will be 0. If this is a block via <a class="el" href="../../df/d02/class_s_l_net_1_1_incremental_read_interface.xhtml">IncrementalReadInterface</a>, then iriDataChunk will point to the block just downloaded. If not using <a class="el" href="../../df/d02/class_s_l_net_1_1_incremental_read_interface.xhtml">IncrementalReadInterface</a>, then you only care about partCount and partTotal to tell how far the download has progressed. YOu can use firstDataChunk to read the first part of the file if desired. The file is usable when you get the OnFile callback. If using <a class="el" href="../../df/d02/class_s_l_net_1_1_incremental_read_interface.xhtml">IncrementalReadInterface</a> and you let RakNet buffer the files in memory (default), then it is the same as above. The file is usable when you get the OnFile callback. If using <a class="el" href="../../df/d02/class_s_l_net_1_1_incremental_read_interface.xhtml">IncrementalReadInterface</a> and you do not let RakNet buffer the files in memory, then set allocateIrIDataChunkAutomatically to false. Write the file to disk whenever you get OnFileProgress and iriDataChunk is not 0, and ignore OnFile. </p>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
<a class="anchor" id="ad92626087d62f5545d85e3226eb347e8"></a>
|
||||
<div class="memitem">
|
||||
<div class="memproto">
|
||||
<table class="mlabels">
|
||||
<tr>
|
||||
<td class="mlabels-left">
|
||||
<table class="memname">
|
||||
<tr>
|
||||
<td class="memname">virtual bool SLNet::FileListTransferCBInterface::Update </td>
|
||||
<td>(</td>
|
||||
<td class="paramtype">void </td>
|
||||
<td class="paramname"></td><td>)</td>
|
||||
<td></td>
|
||||
</tr>
|
||||
</table>
|
||||
</td>
|
||||
<td class="mlabels-right">
|
||||
<span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">virtual</span></span> </td>
|
||||
</tr>
|
||||
</table>
|
||||
</div><div class="memdoc">
|
||||
|
||||
<p>Called while the handler is active 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>. </p>
|
||||
<p>Return false when you are done with the class. At that point OnDereference will be called and the class will no longer be maintained by the <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. </p>
|
||||
|
||||
<p>Definition at line <a class="el" href="../../df/dd9/_file_list_transfer_c_b_interface_8h_source.xhtml#l00141">141</a> of file <a class="el" href="../../df/dd9/_file_list_transfer_c_b_interface_8h_source.xhtml">FileListTransferCBInterface.h</a>.</p>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
<hr/>The documentation for this class was generated from the following file:<ul>
|
||||
<li>Source/include/slikenet/<a class="el" href="../../df/dd9/_file_list_transfer_c_b_interface_8h_source.xhtml">FileListTransferCBInterface.h</a></li>
|
||||
</ul>
|
||||
</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="../../dd/d30/namespace_s_l_net.xhtml">SLNet</a></li><li class="navelem"><a class="el" href="../../d9/d93/class_s_l_net_1_1_file_list_transfer_c_b_interface.xhtml">FileListTransferCBInterface</a></li>
|
||||
<li class="footer">Generated on Wed Aug 14 2019 22:09:49 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>
|
||||
Reference in New Issue
Block a user