Init
This commit is contained in:
25
Help/Doxygen/html/d7/d87/class_s_l_net_1_1_file_list.js
Normal file
25
Help/Doxygen/html/d7/d87/class_s_l_net_1_1_file_list.js
Normal file
@ -0,0 +1,25 @@
|
||||
var class_s_l_net_1_1_file_list =
|
||||
[
|
||||
[ "FileList", "d7/d87/class_s_l_net_1_1_file_list.xhtml#a19ab0e14e22582685586ef566f211198", null ],
|
||||
[ "~FileList", "d7/d87/class_s_l_net_1_1_file_list.xhtml#ac634bf7d1ae56e8aaa5da11449dffee1", null ],
|
||||
[ "AddCallback", "d7/d87/class_s_l_net_1_1_file_list.xhtml#abdbf501cbb0ff9da8b7b1f8ba82d871a", null ],
|
||||
[ "AddFile", "d7/d87/class_s_l_net_1_1_file_list.xhtml#a9917e711caf02c3ce7ebbfd09cef6868", null ],
|
||||
[ "AddFile", "d7/d87/class_s_l_net_1_1_file_list.xhtml#a298966e2e5182a4fa3c217639d86aeaf", null ],
|
||||
[ "AddFilesFromDirectory", "d7/d87/class_s_l_net_1_1_file_list.xhtml#a9491361dcaa7cfefc751ae73ff3a49a4", null ],
|
||||
[ "Clear", "d7/d87/class_s_l_net_1_1_file_list.xhtml#a923bc78eedcd71f5279399eb2fc07f3c", null ],
|
||||
[ "ClearCallbacks", "d7/d87/class_s_l_net_1_1_file_list.xhtml#a2455084df77821aa4e5f2b01f2ea2b73", null ],
|
||||
[ "DeleteFiles", "d7/d87/class_s_l_net_1_1_file_list.xhtml#a6fd1833f922daaa1b079dbea6ed7ead8", null ],
|
||||
[ "Deserialize", "d7/d87/class_s_l_net_1_1_file_list.xhtml#a51a1f369424577edcfd6d476272ace14", null ],
|
||||
[ "FixEndingSlash", "d7/d87/class_s_l_net_1_1_file_list.xhtml#a65dc316d9f3e4ad6a6a22a0b0649b1f9", null ],
|
||||
[ "FixEndingSlash", "d7/d87/class_s_l_net_1_1_file_list.xhtml#a658f7465415cbd4444b849fea0b9d2c4", null ],
|
||||
[ "FlagFilesAsReferences", "d7/d87/class_s_l_net_1_1_file_list.xhtml#a9ac96052c10248bd8fce56a78f9fdcca", null ],
|
||||
[ "GetCallbacks", "d7/d87/class_s_l_net_1_1_file_list.xhtml#af59721be7f19d6bbb3baa14061d926b9", null ],
|
||||
[ "GetDeltaToCurrent", "d7/d87/class_s_l_net_1_1_file_list.xhtml#aad3afd0c0f5accb17476ab3aed4fb7b5", null ],
|
||||
[ "ListMissingOrChangedFiles", "d7/d87/class_s_l_net_1_1_file_list.xhtml#a846fb0d2eb9eff53f5103f2d9e962242", null ],
|
||||
[ "PopulateDataFromDisk", "d7/d87/class_s_l_net_1_1_file_list.xhtml#ac2e392c9949c56e41cd7036cf14f5419", null ],
|
||||
[ "RemoveCallback", "d7/d87/class_s_l_net_1_1_file_list.xhtml#aca0443f0d4771dba26fdba7eed4be7d0", null ],
|
||||
[ "Serialize", "d7/d87/class_s_l_net_1_1_file_list.xhtml#a9481041b75367785c2e95af276820c8d", null ],
|
||||
[ "WriteDataToDisk", "d7/d87/class_s_l_net_1_1_file_list.xhtml#a1fa59189fddf396376b25f38d09dc943", null ],
|
||||
[ "fileList", "d7/d87/class_s_l_net_1_1_file_list.xhtml#aba78be96dad9e9014e2392cae3d731eb", null ],
|
||||
[ "fileListProgressCallbacks", "d7/d87/class_s_l_net_1_1_file_list.xhtml#aee849214ab2bea4516ebc91f3af56dbb", null ]
|
||||
];
|
||||
876
Help/Doxygen/html/d7/d87/class_s_l_net_1_1_file_list.xhtml
Normal file
876
Help/Doxygen/html/d7/d87/class_s_l_net_1_1_file_list.xhtml
Normal file
@ -0,0 +1,876 @@
|
||||
<!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::FileList 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('d7/d87/class_s_l_net_1_1_file_list.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="#pub-methods">Public Member Functions</a> |
|
||||
<a href="#pub-static-methods">Static Public Member Functions</a> |
|
||||
<a href="#pub-attribs">Public Attributes</a> |
|
||||
<a href="#pro-attribs">Protected Attributes</a> |
|
||||
<a href="../../dc/da3/class_s_l_net_1_1_file_list-members.xhtml">List of all members</a> </div>
|
||||
<div class="headertitle">
|
||||
<div class="title">SLNet::FileList Class Reference</div> </div>
|
||||
</div><!--header-->
|
||||
<div class="contents">
|
||||
|
||||
<p><code>#include <<a class="el" href="../../d0/dc4/_file_list_8h_source.xhtml">slikenet/FileList.h</a>></code></p>
|
||||
<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:a19ab0e14e22582685586ef566f211198"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="../../d7/d87/class_s_l_net_1_1_file_list.xhtml#a19ab0e14e22582685586ef566f211198">FileList</a> ()</td></tr>
|
||||
<tr class="separator:a19ab0e14e22582685586ef566f211198"><td class="memSeparator" colspan="2"> </td></tr>
|
||||
<tr class="memitem:ac634bf7d1ae56e8aaa5da11449dffee1"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="../../d7/d87/class_s_l_net_1_1_file_list.xhtml#ac634bf7d1ae56e8aaa5da11449dffee1">~FileList</a> ()</td></tr>
|
||||
<tr class="separator:ac634bf7d1ae56e8aaa5da11449dffee1"><td class="memSeparator" colspan="2"> </td></tr>
|
||||
<tr class="memitem:a9491361dcaa7cfefc751ae73ff3a49a4"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="../../d7/d87/class_s_l_net_1_1_file_list.xhtml#a9491361dcaa7cfefc751ae73ff3a49a4">AddFilesFromDirectory</a> (const char *applicationDirectory, const char *subDirectory, bool writeHash, bool writeData, bool recursive, <a class="el" href="../../d6/dff/struct_file_list_node_context.xhtml">FileListNodeContext</a> context)</td></tr>
|
||||
<tr class="memdesc:a9491361dcaa7cfefc751ae73ff3a49a4"><td class="mdescLeft"> </td><td class="mdescRight">Add all the files at a given directory. <a href="#a9491361dcaa7cfefc751ae73ff3a49a4"></a><br/></td></tr>
|
||||
<tr class="separator:a9491361dcaa7cfefc751ae73ff3a49a4"><td class="memSeparator" colspan="2"> </td></tr>
|
||||
<tr class="memitem:a923bc78eedcd71f5279399eb2fc07f3c"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="../../d7/d87/class_s_l_net_1_1_file_list.xhtml#a923bc78eedcd71f5279399eb2fc07f3c">Clear</a> (void)</td></tr>
|
||||
<tr class="memdesc:a923bc78eedcd71f5279399eb2fc07f3c"><td class="mdescLeft"> </td><td class="mdescRight">Deallocate all memory. <a href="#a923bc78eedcd71f5279399eb2fc07f3c"></a><br/></td></tr>
|
||||
<tr class="separator:a923bc78eedcd71f5279399eb2fc07f3c"><td class="memSeparator" colspan="2"> </td></tr>
|
||||
<tr class="memitem:a9481041b75367785c2e95af276820c8d"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="../../d7/d87/class_s_l_net_1_1_file_list.xhtml#a9481041b75367785c2e95af276820c8d">Serialize</a> (<a class="el" href="../../df/d75/class_s_l_net_1_1_bit_stream.xhtml">SLNet::BitStream</a> *outBitStream)</td></tr>
|
||||
<tr class="memdesc:a9481041b75367785c2e95af276820c8d"><td class="mdescLeft"> </td><td class="mdescRight">Write all encoded data into a bitstream. <a href="#a9481041b75367785c2e95af276820c8d"></a><br/></td></tr>
|
||||
<tr class="separator:a9481041b75367785c2e95af276820c8d"><td class="memSeparator" colspan="2"> </td></tr>
|
||||
<tr class="memitem:a51a1f369424577edcfd6d476272ace14"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="../../d7/d87/class_s_l_net_1_1_file_list.xhtml#a51a1f369424577edcfd6d476272ace14">Deserialize</a> (<a class="el" href="../../df/d75/class_s_l_net_1_1_bit_stream.xhtml">SLNet::BitStream</a> *inBitStream)</td></tr>
|
||||
<tr class="memdesc:a51a1f369424577edcfd6d476272ace14"><td class="mdescLeft"> </td><td class="mdescRight">Read all encoded data from a bitstream. <a class="el" href="../../d7/d87/class_s_l_net_1_1_file_list.xhtml#a923bc78eedcd71f5279399eb2fc07f3c" title="Deallocate all memory.">Clear()</a> is called before deserializing. <a href="#a51a1f369424577edcfd6d476272ace14"></a><br/></td></tr>
|
||||
<tr class="separator:a51a1f369424577edcfd6d476272ace14"><td class="memSeparator" colspan="2"> </td></tr>
|
||||
<tr class="memitem:a846fb0d2eb9eff53f5103f2d9e962242"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="../../d7/d87/class_s_l_net_1_1_file_list.xhtml#a846fb0d2eb9eff53f5103f2d9e962242">ListMissingOrChangedFiles</a> (const char *applicationDirectory, <a class="el" href="../../d7/d87/class_s_l_net_1_1_file_list.xhtml">FileList</a> *missingOrChangedFiles, bool alwaysWriteHash, bool neverWriteHash)</td></tr>
|
||||
<tr class="memdesc:a846fb0d2eb9eff53f5103f2d9e962242"><td class="mdescLeft"> </td><td class="mdescRight">Given the existing set of files, search applicationDirectory for the same files. <a href="#a846fb0d2eb9eff53f5103f2d9e962242"></a><br/></td></tr>
|
||||
<tr class="separator:a846fb0d2eb9eff53f5103f2d9e962242"><td class="memSeparator" colspan="2"> </td></tr>
|
||||
<tr class="memitem:aad3afd0c0f5accb17476ab3aed4fb7b5"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="../../d7/d87/class_s_l_net_1_1_file_list.xhtml#aad3afd0c0f5accb17476ab3aed4fb7b5">GetDeltaToCurrent</a> (<a class="el" href="../../d7/d87/class_s_l_net_1_1_file_list.xhtml">FileList</a> *input, <a class="el" href="../../d7/d87/class_s_l_net_1_1_file_list.xhtml">FileList</a> *output, const char *dirSubset, const char *remoteSubdir)</td></tr>
|
||||
<tr class="memdesc:aad3afd0c0f5accb17476ab3aed4fb7b5"><td class="mdescLeft"> </td><td class="mdescRight">Return the files that need to be written to make <em>input</em> match this current <a class="el" href="../../d7/d87/class_s_l_net_1_1_file_list.xhtml">FileList</a>. <a href="#aad3afd0c0f5accb17476ab3aed4fb7b5"></a><br/></td></tr>
|
||||
<tr class="separator:aad3afd0c0f5accb17476ab3aed4fb7b5"><td class="memSeparator" colspan="2"> </td></tr>
|
||||
<tr class="memitem:ac2e392c9949c56e41cd7036cf14f5419"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="../../d7/d87/class_s_l_net_1_1_file_list.xhtml#ac2e392c9949c56e41cd7036cf14f5419">PopulateDataFromDisk</a> (const char *applicationDirectory, bool writeFileData, bool writeFileHash, bool removeUnknownFiles)</td></tr>
|
||||
<tr class="memdesc:ac2e392c9949c56e41cd7036cf14f5419"><td class="mdescLeft"> </td><td class="mdescRight">Assuming <a class="el" href="../../d7/d87/class_s_l_net_1_1_file_list.xhtml">FileList</a> contains a list of filenames presumably without data, read the data for these filenames. <a href="#ac2e392c9949c56e41cd7036cf14f5419"></a><br/></td></tr>
|
||||
<tr class="separator:ac2e392c9949c56e41cd7036cf14f5419"><td class="memSeparator" colspan="2"> </td></tr>
|
||||
<tr class="memitem:a9ac96052c10248bd8fce56a78f9fdcca"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="../../d7/d87/class_s_l_net_1_1_file_list.xhtml#a9ac96052c10248bd8fce56a78f9fdcca">FlagFilesAsReferences</a> (void)</td></tr>
|
||||
<tr class="separator:a9ac96052c10248bd8fce56a78f9fdcca"><td class="memSeparator" colspan="2"> </td></tr>
|
||||
<tr class="memitem:a1fa59189fddf396376b25f38d09dc943"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="../../d7/d87/class_s_l_net_1_1_file_list.xhtml#a1fa59189fddf396376b25f38d09dc943">WriteDataToDisk</a> (const char *applicationDirectory)</td></tr>
|
||||
<tr class="memdesc:a1fa59189fddf396376b25f38d09dc943"><td class="mdescLeft"> </td><td class="mdescRight">Write all files to disk, prefixing the paths with applicationDirectory. <a href="#a1fa59189fddf396376b25f38d09dc943"></a><br/></td></tr>
|
||||
<tr class="separator:a1fa59189fddf396376b25f38d09dc943"><td class="memSeparator" colspan="2"> </td></tr>
|
||||
<tr class="memitem:a9917e711caf02c3ce7ebbfd09cef6868"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="../../d7/d87/class_s_l_net_1_1_file_list.xhtml#a9917e711caf02c3ce7ebbfd09cef6868">AddFile</a> (const char *filename, const char *fullPathToFile, const char *data, const unsigned dataLength, const unsigned fileLength, <a class="el" href="../../d6/dff/struct_file_list_node_context.xhtml">FileListNodeContext</a> context, bool isAReference=false, bool takeDataPointer=false)</td></tr>
|
||||
<tr class="memdesc:a9917e711caf02c3ce7ebbfd09cef6868"><td class="mdescLeft"> </td><td class="mdescRight">Add a file, given data already in memory. <a href="#a9917e711caf02c3ce7ebbfd09cef6868"></a><br/></td></tr>
|
||||
<tr class="separator:a9917e711caf02c3ce7ebbfd09cef6868"><td class="memSeparator" colspan="2"> </td></tr>
|
||||
<tr class="memitem:a298966e2e5182a4fa3c217639d86aeaf"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="../../d7/d87/class_s_l_net_1_1_file_list.xhtml#a298966e2e5182a4fa3c217639d86aeaf">AddFile</a> (const char *filepath, const char *filename, <a class="el" href="../../d6/dff/struct_file_list_node_context.xhtml">FileListNodeContext</a> context)</td></tr>
|
||||
<tr class="memdesc:a298966e2e5182a4fa3c217639d86aeaf"><td class="mdescLeft"> </td><td class="mdescRight">Add a file, reading it from disk. <a href="#a298966e2e5182a4fa3c217639d86aeaf"></a><br/></td></tr>
|
||||
<tr class="separator:a298966e2e5182a4fa3c217639d86aeaf"><td class="memSeparator" colspan="2"> </td></tr>
|
||||
<tr class="memitem:a6fd1833f922daaa1b079dbea6ed7ead8"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="../../d7/d87/class_s_l_net_1_1_file_list.xhtml#a6fd1833f922daaa1b079dbea6ed7ead8">DeleteFiles</a> (const char *applicationDirectory)</td></tr>
|
||||
<tr class="memdesc:a6fd1833f922daaa1b079dbea6ed7ead8"><td class="mdescLeft"> </td><td class="mdescRight">Delete all files stored in the file list. <a href="#a6fd1833f922daaa1b079dbea6ed7ead8"></a><br/></td></tr>
|
||||
<tr class="separator:a6fd1833f922daaa1b079dbea6ed7ead8"><td class="memSeparator" colspan="2"> </td></tr>
|
||||
<tr class="memitem:abdbf501cbb0ff9da8b7b1f8ba82d871a"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="../../d7/d87/class_s_l_net_1_1_file_list.xhtml#abdbf501cbb0ff9da8b7b1f8ba82d871a">AddCallback</a> (<a class="el" href="../../d5/d7b/class_s_l_net_1_1_file_list_progress.xhtml">FileListProgress</a> *cb)</td></tr>
|
||||
<tr class="memdesc:abdbf501cbb0ff9da8b7b1f8ba82d871a"><td class="mdescLeft"> </td><td class="mdescRight">Adds a callback to get progress reports about what the file list instances do. <a href="#abdbf501cbb0ff9da8b7b1f8ba82d871a"></a><br/></td></tr>
|
||||
<tr class="separator:abdbf501cbb0ff9da8b7b1f8ba82d871a"><td class="memSeparator" colspan="2"> </td></tr>
|
||||
<tr class="memitem:aca0443f0d4771dba26fdba7eed4be7d0"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="../../d7/d87/class_s_l_net_1_1_file_list.xhtml#aca0443f0d4771dba26fdba7eed4be7d0">RemoveCallback</a> (<a class="el" href="../../d5/d7b/class_s_l_net_1_1_file_list_progress.xhtml">FileListProgress</a> *cb)</td></tr>
|
||||
<tr class="memdesc:aca0443f0d4771dba26fdba7eed4be7d0"><td class="mdescLeft"> </td><td class="mdescRight">Removes a callback. <a href="#aca0443f0d4771dba26fdba7eed4be7d0"></a><br/></td></tr>
|
||||
<tr class="separator:aca0443f0d4771dba26fdba7eed4be7d0"><td class="memSeparator" colspan="2"> </td></tr>
|
||||
<tr class="memitem:a2455084df77821aa4e5f2b01f2ea2b73"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="../../d7/d87/class_s_l_net_1_1_file_list.xhtml#a2455084df77821aa4e5f2b01f2ea2b73">ClearCallbacks</a> (void)</td></tr>
|
||||
<tr class="memdesc:a2455084df77821aa4e5f2b01f2ea2b73"><td class="mdescLeft"> </td><td class="mdescRight">Removes all callbacks. <a href="#a2455084df77821aa4e5f2b01f2ea2b73"></a><br/></td></tr>
|
||||
<tr class="separator:a2455084df77821aa4e5f2b01f2ea2b73"><td class="memSeparator" colspan="2"> </td></tr>
|
||||
<tr class="memitem:af59721be7f19d6bbb3baa14061d926b9"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="../../d7/d87/class_s_l_net_1_1_file_list.xhtml#af59721be7f19d6bbb3baa14061d926b9">GetCallbacks</a> (<a class="el" href="../../d4/d78/class_data_structures_1_1_list.xhtml">DataStructures::List</a>< <a class="el" href="../../d5/d7b/class_s_l_net_1_1_file_list_progress.xhtml">FileListProgress</a> * > &callbacks)</td></tr>
|
||||
<tr class="separator:af59721be7f19d6bbb3baa14061d926b9"><td class="memSeparator" colspan="2"> </td></tr>
|
||||
</table><table class="memberdecls">
|
||||
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-static-methods"></a>
|
||||
Static Public Member Functions</h2></td></tr>
|
||||
<tr class="memitem:a65dc316d9f3e4ad6a6a22a0b0649b1f9"><td class="memItemLeft" align="right" valign="top">static bool </td><td class="memItemRight" valign="bottom"><a class="el" href="../../d7/d87/class_s_l_net_1_1_file_list.xhtml#a65dc316d9f3e4ad6a6a22a0b0649b1f9">FixEndingSlash</a> (char *str)</td></tr>
|
||||
<tr class="separator:a65dc316d9f3e4ad6a6a22a0b0649b1f9"><td class="memSeparator" colspan="2"> </td></tr>
|
||||
<tr class="memitem:a658f7465415cbd4444b849fea0b9d2c4"><td class="memItemLeft" align="right" valign="top">static bool </td><td class="memItemRight" valign="bottom"><a class="el" href="../../d7/d87/class_s_l_net_1_1_file_list.xhtml#a658f7465415cbd4444b849fea0b9d2c4">FixEndingSlash</a> (char *str, size_t strLength)</td></tr>
|
||||
<tr class="separator:a658f7465415cbd4444b849fea0b9d2c4"><td class="memSeparator" colspan="2"> </td></tr>
|
||||
</table><table class="memberdecls">
|
||||
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-attribs"></a>
|
||||
Public Attributes</h2></td></tr>
|
||||
<tr class="memitem:aba78be96dad9e9014e2392cae3d731eb"><td class="memItemLeft" align="right" valign="top"><a class="el" href="../../d4/d78/class_data_structures_1_1_list.xhtml">DataStructures::List</a><br class="typebreak"/>
|
||||
< <a class="el" href="../../dd/d30/namespace_s_l_net.xhtml#d6/dd8/struct_s_l_net_1_1_file_list_node">FileListNode</a> > </td><td class="memItemRight" valign="bottom"><a class="el" href="../../d7/d87/class_s_l_net_1_1_file_list.xhtml#aba78be96dad9e9014e2392cae3d731eb">fileList</a></td></tr>
|
||||
<tr class="separator:aba78be96dad9e9014e2392cae3d731eb"><td class="memSeparator" colspan="2"> </td></tr>
|
||||
</table><table class="memberdecls">
|
||||
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pro-attribs"></a>
|
||||
Protected Attributes</h2></td></tr>
|
||||
<tr class="memitem:aee849214ab2bea4516ebc91f3af56dbb"><td class="memItemLeft" align="right" valign="top"><a class="el" href="../../d4/d78/class_data_structures_1_1_list.xhtml">DataStructures::List</a><br class="typebreak"/>
|
||||
< <a class="el" href="../../d5/d7b/class_s_l_net_1_1_file_list_progress.xhtml">FileListProgress</a> * > </td><td class="memItemRight" valign="bottom"><a class="el" href="../../d7/d87/class_s_l_net_1_1_file_list.xhtml#aee849214ab2bea4516ebc91f3af56dbb">fileListProgressCallbacks</a></td></tr>
|
||||
<tr class="separator:aee849214ab2bea4516ebc91f3af56dbb"><td class="memSeparator" colspan="2"> </td></tr>
|
||||
</table>
|
||||
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
|
||||
<div class="textblock">
|
||||
<p>Definition at line <a class="el" href="../../d0/dc4/_file_list_8h_source.xhtml#l00156">156</a> of file <a class="el" href="../../d0/dc4/_file_list_8h_source.xhtml">FileList.h</a>.</p>
|
||||
</div><h2 class="groupheader">Constructor & Destructor Documentation</h2>
|
||||
<a class="anchor" id="a19ab0e14e22582685586ef566f211198"></a>
|
||||
<div class="memitem">
|
||||
<div class="memproto">
|
||||
<table class="memname">
|
||||
<tr>
|
||||
<td class="memname">SLNet::FileList::FileList </td>
|
||||
<td>(</td>
|
||||
<td class="paramname"></td><td>)</td>
|
||||
<td></td>
|
||||
</tr>
|
||||
</table>
|
||||
</div><div class="memdoc">
|
||||
|
||||
</div>
|
||||
</div>
|
||||
<a class="anchor" id="ac634bf7d1ae56e8aaa5da11449dffee1"></a>
|
||||
<div class="memitem">
|
||||
<div class="memproto">
|
||||
<table class="memname">
|
||||
<tr>
|
||||
<td class="memname">SLNet::FileList::~FileList </td>
|
||||
<td>(</td>
|
||||
<td class="paramname"></td><td>)</td>
|
||||
<td></td>
|
||||
</tr>
|
||||
</table>
|
||||
</div><div class="memdoc">
|
||||
|
||||
</div>
|
||||
</div>
|
||||
<h2 class="groupheader">Member Function Documentation</h2>
|
||||
<a class="anchor" id="abdbf501cbb0ff9da8b7b1f8ba82d871a"></a>
|
||||
<div class="memitem">
|
||||
<div class="memproto">
|
||||
<table class="memname">
|
||||
<tr>
|
||||
<td class="memname">void SLNet::FileList::AddCallback </td>
|
||||
<td>(</td>
|
||||
<td class="paramtype"><a class="el" href="../../d5/d7b/class_s_l_net_1_1_file_list_progress.xhtml">FileListProgress</a> * </td>
|
||||
<td class="paramname"><em>cb</em></td><td>)</td>
|
||||
<td></td>
|
||||
</tr>
|
||||
</table>
|
||||
</div><div class="memdoc">
|
||||
|
||||
<p>Adds a callback to get progress reports about what the file list instances do. </p>
|
||||
<dl class="params"><dt>Parameters</dt><dd>
|
||||
<table class="params">
|
||||
<tr><td class="paramdir">[in]</td><td class="paramname">cb</td><td>A pointer to an externally defined instance of <a class="el" href="../../d5/d7b/class_s_l_net_1_1_file_list_progress.xhtml" title="Callback interface set with FileList::SetCallback() in case you want progress notifications when File...">FileListProgress</a>. This pointer is held internally, so should remain valid as long as this class is valid. </td></tr>
|
||||
</table>
|
||||
</dd>
|
||||
</dl>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
<a class="anchor" id="a9917e711caf02c3ce7ebbfd09cef6868"></a>
|
||||
<div class="memitem">
|
||||
<div class="memproto">
|
||||
<table class="memname">
|
||||
<tr>
|
||||
<td class="memname">void SLNet::FileList::AddFile </td>
|
||||
<td>(</td>
|
||||
<td class="paramtype">const char * </td>
|
||||
<td class="paramname"><em>filename</em>, </td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="paramkey"></td>
|
||||
<td></td>
|
||||
<td class="paramtype">const char * </td>
|
||||
<td class="paramname"><em>fullPathToFile</em>, </td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="paramkey"></td>
|
||||
<td></td>
|
||||
<td class="paramtype">const char * </td>
|
||||
<td class="paramname"><em>data</em>, </td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="paramkey"></td>
|
||||
<td></td>
|
||||
<td class="paramtype">const unsigned </td>
|
||||
<td class="paramname"><em>dataLength</em>, </td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="paramkey"></td>
|
||||
<td></td>
|
||||
<td class="paramtype">const unsigned </td>
|
||||
<td class="paramname"><em>fileLength</em>, </td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="paramkey"></td>
|
||||
<td></td>
|
||||
<td class="paramtype"><a class="el" href="../../d6/dff/struct_file_list_node_context.xhtml">FileListNodeContext</a> </td>
|
||||
<td class="paramname"><em>context</em>, </td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="paramkey"></td>
|
||||
<td></td>
|
||||
<td class="paramtype">bool </td>
|
||||
<td class="paramname"><em>isAReference</em> = <code>false</code>, </td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="paramkey"></td>
|
||||
<td></td>
|
||||
<td class="paramtype">bool </td>
|
||||
<td class="paramname"><em>takeDataPointer</em> = <code>false</code> </td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td></td>
|
||||
<td>)</td>
|
||||
<td></td><td></td>
|
||||
</tr>
|
||||
</table>
|
||||
</div><div class="memdoc">
|
||||
|
||||
<p>Add a file, given data already in memory. </p>
|
||||
<dl class="params"><dt>Parameters</dt><dd>
|
||||
<table class="params">
|
||||
<tr><td class="paramdir">[in]</td><td class="paramname">filename</td><td>Name of a file, optionally prefixed with a partial or complete path. Use \ as the path delineator. </td></tr>
|
||||
<tr><td class="paramdir">[in]</td><td class="paramname">fullPathToFile</td><td>Full path to the file on disk </td></tr>
|
||||
<tr><td class="paramdir">[in]</td><td class="paramname">data</td><td>Contents to write </td></tr>
|
||||
<tr><td class="paramdir">[in]</td><td class="paramname">dataLength</td><td>length of the data, which may be greater than fileLength should you prefix extra data, such as the hash </td></tr>
|
||||
<tr><td class="paramdir">[in]</td><td class="paramname">fileLength</td><td>Length of the file </td></tr>
|
||||
<tr><td class="paramdir">[in]</td><td class="paramname">context</td><td>User defined byte to store with each file. Use for whatever you want. </td></tr>
|
||||
<tr><td class="paramdir">[in]</td><td class="paramname">isAReference</td><td>Means that this is just a reference to a file elsewhere - does not actually have any data </td></tr>
|
||||
<tr><td class="paramdir">[in]</td><td class="paramname">takeDataPointer</td><td>If true, do not allocate dataLength. Just take the pointer passed to the <em>data</em> parameter </td></tr>
|
||||
</table>
|
||||
</dd>
|
||||
</dl>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
<a class="anchor" id="a298966e2e5182a4fa3c217639d86aeaf"></a>
|
||||
<div class="memitem">
|
||||
<div class="memproto">
|
||||
<table class="memname">
|
||||
<tr>
|
||||
<td class="memname">void SLNet::FileList::AddFile </td>
|
||||
<td>(</td>
|
||||
<td class="paramtype">const char * </td>
|
||||
<td class="paramname"><em>filepath</em>, </td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="paramkey"></td>
|
||||
<td></td>
|
||||
<td class="paramtype">const char * </td>
|
||||
<td class="paramname"><em>filename</em>, </td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="paramkey"></td>
|
||||
<td></td>
|
||||
<td class="paramtype"><a class="el" href="../../d6/dff/struct_file_list_node_context.xhtml">FileListNodeContext</a> </td>
|
||||
<td class="paramname"><em>context</em> </td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td></td>
|
||||
<td>)</td>
|
||||
<td></td><td></td>
|
||||
</tr>
|
||||
</table>
|
||||
</div><div class="memdoc">
|
||||
|
||||
<p>Add a file, reading it from disk. </p>
|
||||
<dl class="params"><dt>Parameters</dt><dd>
|
||||
<table class="params">
|
||||
<tr><td class="paramdir">[in]</td><td class="paramname">filepath</td><td>Complete path to the file, including the filename itself </td></tr>
|
||||
<tr><td class="paramdir">[in]</td><td class="paramname">filename</td><td>filename to store internally, anything you want, but usually either the complete path or a subset of the complete path. </td></tr>
|
||||
<tr><td class="paramdir">[in]</td><td class="paramname">context</td><td>User defined byte to store with each file. Use for whatever you want. </td></tr>
|
||||
</table>
|
||||
</dd>
|
||||
</dl>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
<a class="anchor" id="a9491361dcaa7cfefc751ae73ff3a49a4"></a>
|
||||
<div class="memitem">
|
||||
<div class="memproto">
|
||||
<table class="memname">
|
||||
<tr>
|
||||
<td class="memname">void SLNet::FileList::AddFilesFromDirectory </td>
|
||||
<td>(</td>
|
||||
<td class="paramtype">const char * </td>
|
||||
<td class="paramname"><em>applicationDirectory</em>, </td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="paramkey"></td>
|
||||
<td></td>
|
||||
<td class="paramtype">const char * </td>
|
||||
<td class="paramname"><em>subDirectory</em>, </td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="paramkey"></td>
|
||||
<td></td>
|
||||
<td class="paramtype">bool </td>
|
||||
<td class="paramname"><em>writeHash</em>, </td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="paramkey"></td>
|
||||
<td></td>
|
||||
<td class="paramtype">bool </td>
|
||||
<td class="paramname"><em>writeData</em>, </td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="paramkey"></td>
|
||||
<td></td>
|
||||
<td class="paramtype">bool </td>
|
||||
<td class="paramname"><em>recursive</em>, </td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="paramkey"></td>
|
||||
<td></td>
|
||||
<td class="paramtype"><a class="el" href="../../d6/dff/struct_file_list_node_context.xhtml">FileListNodeContext</a> </td>
|
||||
<td class="paramname"><em>context</em> </td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td></td>
|
||||
<td>)</td>
|
||||
<td></td><td></td>
|
||||
</tr>
|
||||
</table>
|
||||
</div><div class="memdoc">
|
||||
|
||||
<p>Add all the files at a given directory. </p>
|
||||
<dl class="params"><dt>Parameters</dt><dd>
|
||||
<table class="params">
|
||||
<tr><td class="paramdir">[in]</td><td class="paramname">applicationDirectory</td><td>The first part of the path. This is not stored as part of the filename. Use \ as the path delineator. </td></tr>
|
||||
<tr><td class="paramdir">[in]</td><td class="paramname">subDirectory</td><td>The rest of the path to the file. This is stored as a prefix to the filename </td></tr>
|
||||
<tr><td class="paramdir">[in]</td><td class="paramname">writeHash</td><td>The first 4 bytes is a hash of the file, with the remainder the actual file data (should <em>writeData</em> be true) </td></tr>
|
||||
<tr><td class="paramdir">[in]</td><td class="paramname">writeData</td><td>Write the contents of each file </td></tr>
|
||||
<tr><td class="paramdir">[in]</td><td class="paramname">recursive</td><td>Whether or not to visit subdirectories </td></tr>
|
||||
<tr><td class="paramdir">[in]</td><td class="paramname">context</td><td>User defined byte to store with each file. Use for whatever you want. </td></tr>
|
||||
</table>
|
||||
</dd>
|
||||
</dl>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
<a class="anchor" id="a923bc78eedcd71f5279399eb2fc07f3c"></a>
|
||||
<div class="memitem">
|
||||
<div class="memproto">
|
||||
<table class="memname">
|
||||
<tr>
|
||||
<td class="memname">void SLNet::FileList::Clear </td>
|
||||
<td>(</td>
|
||||
<td class="paramtype">void </td>
|
||||
<td class="paramname"></td><td>)</td>
|
||||
<td></td>
|
||||
</tr>
|
||||
</table>
|
||||
</div><div class="memdoc">
|
||||
|
||||
<p>Deallocate all memory. </p>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
<a class="anchor" id="a2455084df77821aa4e5f2b01f2ea2b73"></a>
|
||||
<div class="memitem">
|
||||
<div class="memproto">
|
||||
<table class="memname">
|
||||
<tr>
|
||||
<td class="memname">void SLNet::FileList::ClearCallbacks </td>
|
||||
<td>(</td>
|
||||
<td class="paramtype">void </td>
|
||||
<td class="paramname"></td><td>)</td>
|
||||
<td></td>
|
||||
</tr>
|
||||
</table>
|
||||
</div><div class="memdoc">
|
||||
|
||||
<p>Removes all callbacks. </p>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
<a class="anchor" id="a6fd1833f922daaa1b079dbea6ed7ead8"></a>
|
||||
<div class="memitem">
|
||||
<div class="memproto">
|
||||
<table class="memname">
|
||||
<tr>
|
||||
<td class="memname">void SLNet::FileList::DeleteFiles </td>
|
||||
<td>(</td>
|
||||
<td class="paramtype">const char * </td>
|
||||
<td class="paramname"><em>applicationDirectory</em></td><td>)</td>
|
||||
<td></td>
|
||||
</tr>
|
||||
</table>
|
||||
</div><div class="memdoc">
|
||||
|
||||
<p>Delete all files stored in the file list. </p>
|
||||
<dl class="params"><dt>Parameters</dt><dd>
|
||||
<table class="params">
|
||||
<tr><td class="paramdir">[in]</td><td class="paramname">applicationDirectory</td><td>Prefixed to the path to each filename. Use \ as the path delineator. </td></tr>
|
||||
</table>
|
||||
</dd>
|
||||
</dl>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
<a class="anchor" id="a51a1f369424577edcfd6d476272ace14"></a>
|
||||
<div class="memitem">
|
||||
<div class="memproto">
|
||||
<table class="memname">
|
||||
<tr>
|
||||
<td class="memname">bool SLNet::FileList::Deserialize </td>
|
||||
<td>(</td>
|
||||
<td class="paramtype"><a class="el" href="../../df/d75/class_s_l_net_1_1_bit_stream.xhtml">SLNet::BitStream</a> * </td>
|
||||
<td class="paramname"><em>inBitStream</em></td><td>)</td>
|
||||
<td></td>
|
||||
</tr>
|
||||
</table>
|
||||
</div><div class="memdoc">
|
||||
|
||||
<p>Read all encoded data from a bitstream. <a class="el" href="../../d7/d87/class_s_l_net_1_1_file_list.xhtml#a923bc78eedcd71f5279399eb2fc07f3c" title="Deallocate all memory.">Clear()</a> is called before deserializing. </p>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
<a class="anchor" id="a65dc316d9f3e4ad6a6a22a0b0649b1f9"></a>
|
||||
<div class="memitem">
|
||||
<div class="memproto">
|
||||
<table class="mlabels">
|
||||
<tr>
|
||||
<td class="mlabels-left">
|
||||
<table class="memname">
|
||||
<tr>
|
||||
<td class="memname">static bool SLNet::FileList::FixEndingSlash </td>
|
||||
<td>(</td>
|
||||
<td class="paramtype">char * </td>
|
||||
<td class="paramname"><em>str</em></td><td>)</td>
|
||||
<td></td>
|
||||
</tr>
|
||||
</table>
|
||||
</td>
|
||||
<td class="mlabels-right">
|
||||
<span class="mlabels"><span class="mlabel">static</span></span> </td>
|
||||
</tr>
|
||||
</table>
|
||||
</div><div class="memdoc">
|
||||
|
||||
</div>
|
||||
</div>
|
||||
<a class="anchor" id="a658f7465415cbd4444b849fea0b9d2c4"></a>
|
||||
<div class="memitem">
|
||||
<div class="memproto">
|
||||
<table class="mlabels">
|
||||
<tr>
|
||||
<td class="mlabels-left">
|
||||
<table class="memname">
|
||||
<tr>
|
||||
<td class="memname">static bool SLNet::FileList::FixEndingSlash </td>
|
||||
<td>(</td>
|
||||
<td class="paramtype">char * </td>
|
||||
<td class="paramname"><em>str</em>, </td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="paramkey"></td>
|
||||
<td></td>
|
||||
<td class="paramtype">size_t </td>
|
||||
<td class="paramname"><em>strLength</em> </td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td></td>
|
||||
<td>)</td>
|
||||
<td></td><td></td>
|
||||
</tr>
|
||||
</table>
|
||||
</td>
|
||||
<td class="mlabels-right">
|
||||
<span class="mlabels"><span class="mlabel">static</span></span> </td>
|
||||
</tr>
|
||||
</table>
|
||||
</div><div class="memdoc">
|
||||
|
||||
</div>
|
||||
</div>
|
||||
<a class="anchor" id="a9ac96052c10248bd8fce56a78f9fdcca"></a>
|
||||
<div class="memitem">
|
||||
<div class="memproto">
|
||||
<table class="memname">
|
||||
<tr>
|
||||
<td class="memname">void SLNet::FileList::FlagFilesAsReferences </td>
|
||||
<td>(</td>
|
||||
<td class="paramtype">void </td>
|
||||
<td class="paramname"></td><td>)</td>
|
||||
<td></td>
|
||||
</tr>
|
||||
</table>
|
||||
</div><div class="memdoc">
|
||||
<p>By default, GetDeltaToCurrent tags files as non-references, meaning they are assumed to be populated later This tags all files as references, required for <a class="el" href="../../df/d02/class_s_l_net_1_1_incremental_read_interface.xhtml">IncrementalReadInterface</a> to process them incrementally </p>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
<a class="anchor" id="af59721be7f19d6bbb3baa14061d926b9"></a>
|
||||
<div class="memitem">
|
||||
<div class="memproto">
|
||||
<table class="memname">
|
||||
<tr>
|
||||
<td class="memname">void SLNet::FileList::GetCallbacks </td>
|
||||
<td>(</td>
|
||||
<td class="paramtype"><a class="el" href="../../d4/d78/class_data_structures_1_1_list.xhtml">DataStructures::List</a>< <a class="el" href="../../d5/d7b/class_s_l_net_1_1_file_list_progress.xhtml">FileListProgress</a> * > & </td>
|
||||
<td class="paramname"><em>callbacks</em></td><td>)</td>
|
||||
<td></td>
|
||||
</tr>
|
||||
</table>
|
||||
</div><div class="memdoc">
|
||||
<p>Returns all callbacks added with <a class="el" href="../../d7/d87/class_s_l_net_1_1_file_list.xhtml#abdbf501cbb0ff9da8b7b1f8ba82d871a" title="Adds a callback to get progress reports about what the file list instances do.">AddCallback()</a> </p>
|
||||
<dl class="params"><dt>Parameters</dt><dd>
|
||||
<table class="params">
|
||||
<tr><td class="paramdir">[out]</td><td class="paramname">callbacks</td><td>The list is set to the list of callbacks </td></tr>
|
||||
</table>
|
||||
</dd>
|
||||
</dl>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
<a class="anchor" id="aad3afd0c0f5accb17476ab3aed4fb7b5"></a>
|
||||
<div class="memitem">
|
||||
<div class="memproto">
|
||||
<table class="memname">
|
||||
<tr>
|
||||
<td class="memname">void SLNet::FileList::GetDeltaToCurrent </td>
|
||||
<td>(</td>
|
||||
<td class="paramtype"><a class="el" href="../../d7/d87/class_s_l_net_1_1_file_list.xhtml">FileList</a> * </td>
|
||||
<td class="paramname"><em>input</em>, </td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="paramkey"></td>
|
||||
<td></td>
|
||||
<td class="paramtype"><a class="el" href="../../d7/d87/class_s_l_net_1_1_file_list.xhtml">FileList</a> * </td>
|
||||
<td class="paramname"><em>output</em>, </td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="paramkey"></td>
|
||||
<td></td>
|
||||
<td class="paramtype">const char * </td>
|
||||
<td class="paramname"><em>dirSubset</em>, </td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="paramkey"></td>
|
||||
<td></td>
|
||||
<td class="paramtype">const char * </td>
|
||||
<td class="paramname"><em>remoteSubdir</em> </td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td></td>
|
||||
<td>)</td>
|
||||
<td></td><td></td>
|
||||
</tr>
|
||||
</table>
|
||||
</div><div class="memdoc">
|
||||
|
||||
<p>Return the files that need to be written to make <em>input</em> match this current <a class="el" href="../../d7/d87/class_s_l_net_1_1_file_list.xhtml">FileList</a>. </p>
|
||||
<p>Specify dirSubset to only consider files that start with this path specify remoteSubdir to assume that all filenames in input start with this path, so strip it off when comparing filenames. </p>
|
||||
<dl class="params"><dt>Parameters</dt><dd>
|
||||
<table class="params">
|
||||
<tr><td class="paramdir">[in]</td><td class="paramname">input</td><td>Full list of files </td></tr>
|
||||
<tr><td class="paramdir">[out]</td><td class="paramname">output</td><td>Files that we need to match input </td></tr>
|
||||
<tr><td class="paramdir">[in]</td><td class="paramname">dirSubset</td><td>If the filename does not start with this path, just skip this file. </td></tr>
|
||||
<tr><td class="paramdir">[in]</td><td class="paramname">remoteSubdir</td><td>Remove this from the filenames of <em>input</em> when comparing to existing filenames. </td></tr>
|
||||
</table>
|
||||
</dd>
|
||||
</dl>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
<a class="anchor" id="a846fb0d2eb9eff53f5103f2d9e962242"></a>
|
||||
<div class="memitem">
|
||||
<div class="memproto">
|
||||
<table class="memname">
|
||||
<tr>
|
||||
<td class="memname">void SLNet::FileList::ListMissingOrChangedFiles </td>
|
||||
<td>(</td>
|
||||
<td class="paramtype">const char * </td>
|
||||
<td class="paramname"><em>applicationDirectory</em>, </td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="paramkey"></td>
|
||||
<td></td>
|
||||
<td class="paramtype"><a class="el" href="../../d7/d87/class_s_l_net_1_1_file_list.xhtml">FileList</a> * </td>
|
||||
<td class="paramname"><em>missingOrChangedFiles</em>, </td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="paramkey"></td>
|
||||
<td></td>
|
||||
<td class="paramtype">bool </td>
|
||||
<td class="paramname"><em>alwaysWriteHash</em>, </td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="paramkey"></td>
|
||||
<td></td>
|
||||
<td class="paramtype">bool </td>
|
||||
<td class="paramname"><em>neverWriteHash</em> </td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td></td>
|
||||
<td>)</td>
|
||||
<td></td><td></td>
|
||||
</tr>
|
||||
</table>
|
||||
</div><div class="memdoc">
|
||||
|
||||
<p>Given the existing set of files, search applicationDirectory for the same files. </p>
|
||||
<p>For each file that is missing or different, add that file to <em>missingOrChangedFiles</em>. Note: the file contents are not written, and only the hash if written if <em>alwaysWriteHash</em> is true alwaysWriteHash and neverWriteHash are optimizations to avoid reading the file contents to generate the hash if not necessary because the file is missing or has different lengths anyway. </p>
|
||||
<dl class="params"><dt>Parameters</dt><dd>
|
||||
<table class="params">
|
||||
<tr><td class="paramdir">[in]</td><td class="paramname">applicationDirectory</td><td>The first part of the path. This is not stored as part of the filename. Use \ as the path delineator. </td></tr>
|
||||
<tr><td class="paramdir">[out]</td><td class="paramname">missingOrChangedFiles</td><td>Output list written to </td></tr>
|
||||
<tr><td class="paramdir">[in]</td><td class="paramname">alwaysWriteHash</td><td>If true, and neverWriteHash is false, will hash the file content of the file on disk, and write that as the file data with a length of SHA1_LENGTH bytes. If false, if the file length is different, will only write the filename. </td></tr>
|
||||
<tr><td class="paramdir">[in]</td><td class="paramname">neverWriteHash</td><td>If true, will never write the hash, even if available. If false, will write the hash if the file lengths are the same and it was forced to do a comparison. </td></tr>
|
||||
</table>
|
||||
</dd>
|
||||
</dl>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
<a class="anchor" id="ac2e392c9949c56e41cd7036cf14f5419"></a>
|
||||
<div class="memitem">
|
||||
<div class="memproto">
|
||||
<table class="memname">
|
||||
<tr>
|
||||
<td class="memname">void SLNet::FileList::PopulateDataFromDisk </td>
|
||||
<td>(</td>
|
||||
<td class="paramtype">const char * </td>
|
||||
<td class="paramname"><em>applicationDirectory</em>, </td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="paramkey"></td>
|
||||
<td></td>
|
||||
<td class="paramtype">bool </td>
|
||||
<td class="paramname"><em>writeFileData</em>, </td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="paramkey"></td>
|
||||
<td></td>
|
||||
<td class="paramtype">bool </td>
|
||||
<td class="paramname"><em>writeFileHash</em>, </td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="paramkey"></td>
|
||||
<td></td>
|
||||
<td class="paramtype">bool </td>
|
||||
<td class="paramname"><em>removeUnknownFiles</em> </td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td></td>
|
||||
<td>)</td>
|
||||
<td></td><td></td>
|
||||
</tr>
|
||||
</table>
|
||||
</div><div class="memdoc">
|
||||
|
||||
<p>Assuming <a class="el" href="../../d7/d87/class_s_l_net_1_1_file_list.xhtml">FileList</a> contains a list of filenames presumably without data, read the data for these filenames. </p>
|
||||
<dl class="params"><dt>Parameters</dt><dd>
|
||||
<table class="params">
|
||||
<tr><td class="paramdir">[in]</td><td class="paramname">applicationDirectory</td><td>Prepend this path to each filename. Trailing slash will be added if necessary. Use \ as the path delineator. </td></tr>
|
||||
<tr><td class="paramdir">[in]</td><td class="paramname">writeFileData</td><td>True to read and store the file data. The first SHA1_LENGTH bytes will contain the hash if <em>writeFileHash</em> is true </td></tr>
|
||||
<tr><td class="paramdir">[in]</td><td class="paramname">writeFileHash</td><td>True to read and store the hash of the file data. The first SHA1_LENGTH bytes will contain the hash if <em>writeFileHash</em> is true </td></tr>
|
||||
<tr><td class="paramdir">[in]</td><td class="paramname">removeUnknownFiles</td><td>If a file does not exist on disk but is in the file list, remove it from the file list? </td></tr>
|
||||
</table>
|
||||
</dd>
|
||||
</dl>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
<a class="anchor" id="aca0443f0d4771dba26fdba7eed4be7d0"></a>
|
||||
<div class="memitem">
|
||||
<div class="memproto">
|
||||
<table class="memname">
|
||||
<tr>
|
||||
<td class="memname">void SLNet::FileList::RemoveCallback </td>
|
||||
<td>(</td>
|
||||
<td class="paramtype"><a class="el" href="../../d5/d7b/class_s_l_net_1_1_file_list_progress.xhtml">FileListProgress</a> * </td>
|
||||
<td class="paramname"><em>cb</em></td><td>)</td>
|
||||
<td></td>
|
||||
</tr>
|
||||
</table>
|
||||
</div><div class="memdoc">
|
||||
|
||||
<p>Removes a callback. </p>
|
||||
<dl class="params"><dt>Parameters</dt><dd>
|
||||
<table class="params">
|
||||
<tr><td class="paramdir">[in]</td><td class="paramname">cb</td><td>A pointer to an externally defined instance of <a class="el" href="../../d5/d7b/class_s_l_net_1_1_file_list_progress.xhtml" title="Callback interface set with FileList::SetCallback() in case you want progress notifications when File...">FileListProgress</a> that was previously added with <a class="el" href="../../d7/d87/class_s_l_net_1_1_file_list.xhtml#abdbf501cbb0ff9da8b7b1f8ba82d871a" title="Adds a callback to get progress reports about what the file list instances do.">AddCallback()</a> </td></tr>
|
||||
</table>
|
||||
</dd>
|
||||
</dl>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
<a class="anchor" id="a9481041b75367785c2e95af276820c8d"></a>
|
||||
<div class="memitem">
|
||||
<div class="memproto">
|
||||
<table class="memname">
|
||||
<tr>
|
||||
<td class="memname">void SLNet::FileList::Serialize </td>
|
||||
<td>(</td>
|
||||
<td class="paramtype"><a class="el" href="../../df/d75/class_s_l_net_1_1_bit_stream.xhtml">SLNet::BitStream</a> * </td>
|
||||
<td class="paramname"><em>outBitStream</em></td><td>)</td>
|
||||
<td></td>
|
||||
</tr>
|
||||
</table>
|
||||
</div><div class="memdoc">
|
||||
|
||||
<p>Write all encoded data into a bitstream. </p>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
<a class="anchor" id="a1fa59189fddf396376b25f38d09dc943"></a>
|
||||
<div class="memitem">
|
||||
<div class="memproto">
|
||||
<table class="memname">
|
||||
<tr>
|
||||
<td class="memname">void SLNet::FileList::WriteDataToDisk </td>
|
||||
<td>(</td>
|
||||
<td class="paramtype">const char * </td>
|
||||
<td class="paramname"><em>applicationDirectory</em></td><td>)</td>
|
||||
<td></td>
|
||||
</tr>
|
||||
</table>
|
||||
</div><div class="memdoc">
|
||||
|
||||
<p>Write all files to disk, prefixing the paths with applicationDirectory. </p>
|
||||
<dl class="params"><dt>Parameters</dt><dd>
|
||||
<table class="params">
|
||||
<tr><td class="paramdir">[in]</td><td class="paramname">applicationDirectory</td><td>path prefix </td></tr>
|
||||
</table>
|
||||
</dd>
|
||||
</dl>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
<h2 class="groupheader">Member Data Documentation</h2>
|
||||
<a class="anchor" id="aba78be96dad9e9014e2392cae3d731eb"></a>
|
||||
<div class="memitem">
|
||||
<div class="memproto">
|
||||
<table class="memname">
|
||||
<tr>
|
||||
<td class="memname"><a class="el" href="../../d4/d78/class_data_structures_1_1_list.xhtml">DataStructures::List</a><<a class="el" href="../../dd/d30/namespace_s_l_net.xhtml#d6/dd8/struct_s_l_net_1_1_file_list_node">FileListNode</a>> SLNet::FileList::fileList</td>
|
||||
</tr>
|
||||
</table>
|
||||
</div><div class="memdoc">
|
||||
|
||||
<p>Definition at line <a class="el" href="../../d0/dc4/_file_list_8h_source.xhtml#l00252">252</a> of file <a class="el" href="../../d0/dc4/_file_list_8h_source.xhtml">FileList.h</a>.</p>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
<a class="anchor" id="aee849214ab2bea4516ebc91f3af56dbb"></a>
|
||||
<div class="memitem">
|
||||
<div class="memproto">
|
||||
<table class="mlabels">
|
||||
<tr>
|
||||
<td class="mlabels-left">
|
||||
<table class="memname">
|
||||
<tr>
|
||||
<td class="memname"><a class="el" href="../../d4/d78/class_data_structures_1_1_list.xhtml">DataStructures::List</a><<a class="el" href="../../d5/d7b/class_s_l_net_1_1_file_list_progress.xhtml">FileListProgress</a>*> SLNet::FileList::fileListProgressCallbacks</td>
|
||||
</tr>
|
||||
</table>
|
||||
</td>
|
||||
<td class="mlabels-right">
|
||||
<span class="mlabels"><span class="mlabel">protected</span></span> </td>
|
||||
</tr>
|
||||
</table>
|
||||
</div><div class="memdoc">
|
||||
|
||||
<p>Definition at line <a class="el" href="../../d0/dc4/_file_list_8h_source.xhtml#l00257">257</a> of file <a class="el" href="../../d0/dc4/_file_list_8h_source.xhtml">FileList.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="../../d0/dc4/_file_list_8h_source.xhtml">FileList.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="../../d7/d87/class_s_l_net_1_1_file_list.xhtml">FileList</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