Skip to content

Commit 5373db9

Browse files
pschatzmannpschatzmann
committed
doxygen
1 parent f25071f commit 5373db9

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

41 files changed

+519
-490
lines changed

‎docs/html/_f_t_p_basic_a_p_i_8h_source.html‎

Lines changed: 167 additions & 186 deletions
Large diffs are not rendered by default.

‎docs/html/_f_t_p_client_8h_source.html‎

Lines changed: 23 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -172,25 +172,29 @@
172172
<div class="line"><a name="l00119"></a><span class="lineno"> 119</span>&#160; this-&gt;port = port;</div>
173173
<div class="line"><a name="l00120"></a><span class="lineno"> 120</span>&#160; }</div>
174174
<div class="line"><a name="l00121"></a><span class="lineno"> 121</span>&#160; </div>
175-
<div class="line"><a name="l00122"></a><span class="lineno"> 122</span>&#160; <span class="keywordtype">bool</span> abort(CurrentOperation op) {</div>
176-
<div class="line"><a name="l00123"></a><span class="lineno"> 123</span>&#160; <span class="keywordflow">return</span> mgr.abort(op);</div>
177-
<div class="line"><a name="l00124"></a><span class="lineno"> 124</span>&#160; } </div>
178-
<div class="line"><a name="l00125"></a><span class="lineno"> 125</span>&#160; </div>
179-
<div class="line"><a name="l00126"></a><span class="lineno"> 126</span>&#160; <span class="keyword">protected</span>:</div>
180-
<div class="line"><a name="l00127"></a><span class="lineno"> 127</span>&#160; FTPSessionMgr&lt;ClientType&gt; mgr;</div>
181-
<div class="line"><a name="l00128"></a><span class="lineno"> 128</span>&#160; IPAddress remote_addr;</div>
182-
<div class="line"><a name="l00129"></a><span class="lineno"> 129</span>&#160; <span class="keyword">const</span> <span class="keywordtype">char</span> *userid = <span class="keyword">nullptr</span>;</div>
183-
<div class="line"><a name="l00130"></a><span class="lineno"> 130</span>&#160; <span class="keyword">const</span> <span class="keywordtype">char</span> *password = <span class="keyword">nullptr</span>;</div>
184-
<div class="line"><a name="l00131"></a><span class="lineno"> 131</span>&#160; <span class="keywordtype">int</span> port;</div>
185-
<div class="line"><a name="l00132"></a><span class="lineno"> 132</span>&#160; <span class="keywordtype">bool</span> cleanup_clients;</div>
186-
<div class="line"><a name="l00133"></a><span class="lineno"> 133</span>&#160; <span class="keywordtype">bool</span> auto_close = <span class="keyword">true</span>;</div>
187-
<div class="line"><a name="l00134"></a><span class="lineno"> 134</span>&#160; </div>
188-
<div class="line"><a name="l00135"></a><span class="lineno"> 135</span>&#160;};</div>
189-
<div class="line"><a name="l00136"></a><span class="lineno"> 136</span>&#160; </div>
190-
<div class="line"><a name="l00137"></a><span class="lineno"> 137</span>&#160;} <span class="comment">// namespace ftp_client</span></div>
175+
<div class="line"><a name="l00123"></a><span class="lineno"><a class="line" href="classftp__client_1_1_f_t_p_client.html#a09afdf7442d932f34ce355c16ffba0ae"> 123</a></span>&#160; <span class="keywordtype">bool</span> <a class="code" href="classftp__client_1_1_f_t_p_client.html#a09afdf7442d932f34ce355c16ffba0ae">abort</a>(CurrentOperation op) {</div>
176+
<div class="line"><a name="l00124"></a><span class="lineno"> 124</span>&#160; <span class="keywordflow">return</span> mgr.abort(op);</div>
177+
<div class="line"><a name="l00125"></a><span class="lineno"> 125</span>&#160; } </div>
178+
<div class="line"><a name="l00126"></a><span class="lineno"> 126</span>&#160; </div>
179+
<div class="line"><a name="l00128"></a><span class="lineno"><a class="line" href="classftp__client_1_1_f_t_p_client.html#afc644649f3d5634c033e7e2162ce677a"> 128</a></span>&#160; <a class="code" href="classftp__client_1_1_f_t_p_session_mgr.html">FTPSessionMgr&lt;ClientType&gt;</a> &amp;<a class="code" href="classftp__client_1_1_f_t_p_client.html#afc644649f3d5634c033e7e2162ce677a">sessionMgr</a>() {</div>
180+
<div class="line"><a name="l00129"></a><span class="lineno"> 129</span>&#160; <span class="keywordflow">return</span> mgr;</div>
181+
<div class="line"><a name="l00130"></a><span class="lineno"> 130</span>&#160; }</div>
182+
<div class="line"><a name="l00131"></a><span class="lineno"> 131</span>&#160; <span class="keyword">protected</span>:</div>
183+
<div class="line"><a name="l00132"></a><span class="lineno"> 132</span>&#160; <a class="code" href="classftp__client_1_1_f_t_p_session_mgr.html">FTPSessionMgr&lt;ClientType&gt;</a> mgr;</div>
184+
<div class="line"><a name="l00133"></a><span class="lineno"> 133</span>&#160; IPAddress remote_addr;</div>
185+
<div class="line"><a name="l00134"></a><span class="lineno"> 134</span>&#160; <span class="keyword">const</span> <span class="keywordtype">char</span> *userid = <span class="keyword">nullptr</span>;</div>
186+
<div class="line"><a name="l00135"></a><span class="lineno"> 135</span>&#160; <span class="keyword">const</span> <span class="keywordtype">char</span> *password = <span class="keyword">nullptr</span>;</div>
187+
<div class="line"><a name="l00136"></a><span class="lineno"> 136</span>&#160; <span class="keywordtype">int</span> port;</div>
188+
<div class="line"><a name="l00137"></a><span class="lineno"> 137</span>&#160; <span class="keywordtype">bool</span> cleanup_clients;</div>
189+
<div class="line"><a name="l00138"></a><span class="lineno"> 138</span>&#160; <span class="keywordtype">bool</span> auto_close = <span class="keyword">true</span>;</div>
190+
<div class="line"><a name="l00139"></a><span class="lineno"> 139</span>&#160; </div>
191+
<div class="line"><a name="l00140"></a><span class="lineno"> 140</span>&#160;};</div>
192+
<div class="line"><a name="l00141"></a><span class="lineno"> 141</span>&#160; </div>
193+
<div class="line"><a name="l00142"></a><span class="lineno"> 142</span>&#160;} <span class="comment">// namespace ftp_client</span></div>
191194
<div class="ttc" id="aclassftp__client_1_1_f_t_p_basic_a_p_i_html"><div class="ttname"><a href="classftp__client_1_1_f_t_p_basic_a_p_i.html">ftp_client::FTPBasicAPI</a></div><div class="ttdoc">FTPBasicAPI Implementation of Low Level FTP protocol. In order to simplify the logic we always use Pa...</div><div class="ttdef"><b>Definition:</b> FTPBasicAPI.h:17</div></div>
192195
<div class="ttc" id="aclassftp__client_1_1_f_t_p_client_html"><div class="ttname"><a href="classftp__client_1_1_f_t_p_client.html">ftp_client::FTPClient</a></div><div class="ttdoc">FTPClient Basic FTP access class which supports directory operations and the opening of files.</div><div class="ttdef"><b>Definition:</b> FTPClient.h:21</div></div>
193196
<div class="ttc" id="aclassftp__client_1_1_f_t_p_client_html_a04e0014bb39632b25c95296f32d3ad8e"><div class="ttname"><a href="classftp__client_1_1_f_t_p_client.html#a04e0014bb39632b25c95296f32d3ad8e">ftp_client::FTPClient::remove</a></div><div class="ttdeci">bool remove(const char *filepath)</div><div class="ttdoc">Delete the file.</div><div class="ttdef"><b>Definition:</b> FTPClient.h:70</div></div>
197+
<div class="ttc" id="aclassftp__client_1_1_f_t_p_client_html_a09afdf7442d932f34ce355c16ffba0ae"><div class="ttname"><a href="classftp__client_1_1_f_t_p_client.html#a09afdf7442d932f34ce355c16ffba0ae">ftp_client::FTPClient::abort</a></div><div class="ttdeci">bool abort(CurrentOperation op)</div><div class="ttdoc">Abort the indicated operation (e.g., READ_OP, WRITE_OP, LS_OP.)</div><div class="ttdef"><b>Definition:</b> FTPClient.h:123</div></div>
194198
<div class="ttc" id="aclassftp__client_1_1_f_t_p_client_html_a2bac8d0b56270e832b6a0b19453fc7a8"><div class="ttname"><a href="classftp__client_1_1_f_t_p_client.html#a2bac8d0b56270e832b6a0b19453fc7a8">ftp_client::FTPClient::ls</a></div><div class="ttdeci">FTPFileIterator ls(const char *path, FileMode mode=WRITE_MODE)</div><div class="ttdoc">Lists all file names in the specified directory.</div><div class="ttdef"><b>Definition:</b> FTPClient.h:86</div></div>
195199
<div class="ttc" id="aclassftp__client_1_1_f_t_p_client_html_a587f98bf75e7324361289cc43de90baa"><div class="ttname"><a href="classftp__client_1_1_f_t_p_client.html#a587f98bf75e7324361289cc43de90baa">ftp_client::FTPClient::ascii</a></div><div class="ttdeci">bool ascii()</div><div class="ttdoc">Switch to ascii mode.</div><div class="ttdef"><b>Definition:</b> FTPClient.h:105</div></div>
196200
<div class="ttc" id="aclassftp__client_1_1_f_t_p_client_html_a78bf1e833b04c2c8858a063ee9e71932"><div class="ttname"><a href="classftp__client_1_1_f_t_p_client.html#a78bf1e833b04c2c8858a063ee9e71932">ftp_client::FTPClient::open</a></div><div class="ttdeci">FTPFile open(const char *filename, FileMode mode=READ_MODE, bool autoClose=false)</div><div class="ttdoc">Open a file.</div><div class="ttdef"><b>Definition:</b> FTPClient.h:46</div></div>
@@ -201,8 +205,10 @@
201205
<div class="ttc" id="aclassftp__client_1_1_f_t_p_client_html_aec4e6bea22d1974389500b122a3475ec"><div class="ttname"><a href="classftp__client_1_1_f_t_p_client.html#aec4e6bea22d1974389500b122a3475ec">ftp_client::FTPClient::mkdir</a></div><div class="ttdeci">bool mkdir(const char *filepath)</div><div class="ttdef"><b>Definition:</b> FTPClient.h:62</div></div>
202206
<div class="ttc" id="aclassftp__client_1_1_f_t_p_client_html_af28b09eaf0aef5c342da743e1e2291e6"><div class="ttname"><a href="classftp__client_1_1_f_t_p_client.html#af28b09eaf0aef5c342da743e1e2291e6">ftp_client::FTPClient::begin</a></div><div class="ttdeci">bool begin(IPAddress remote_addr, const char *user=&quot;anonymous&quot;, const char *password=nullptr)</div><div class="ttdoc">Opens the FTP connection.</div><div class="ttdef"><b>Definition:</b> FTPClient.h:30</div></div>
203207
<div class="ttc" id="aclassftp__client_1_1_f_t_p_client_html_af6b03cacfc23b889709204a3fbeafb0c"><div class="ttname"><a href="classftp__client_1_1_f_t_p_client.html#af6b03cacfc23b889709204a3fbeafb0c">ftp_client::FTPClient::rmdir</a></div><div class="ttdeci">bool rmdir(const char *filepath)</div><div class="ttdoc">Removes a directory.</div><div class="ttdef"><b>Definition:</b> FTPClient.h:78</div></div>
204-
<div class="ttc" id="aclassftp__client_1_1_f_t_p_file_html"><div class="ttname"><a href="classftp__client_1_1_f_t_p_file.html">ftp_client::FTPFile</a></div><div class="ttdoc">FTPFile A single file which supports read and write operations. This class is implemented as an Ardui...</div><div class="ttdef"><b>Definition:</b> FTPFile.h:15</div></div>
208+
<div class="ttc" id="aclassftp__client_1_1_f_t_p_client_html_afc644649f3d5634c033e7e2162ce677a"><div class="ttname"><a href="classftp__client_1_1_f_t_p_client.html#afc644649f3d5634c033e7e2162ce677a">ftp_client::FTPClient::sessionMgr</a></div><div class="ttdeci">FTPSessionMgr&lt; ClientType &gt; &amp; sessionMgr()</div><div class="ttdoc">Provides access to the session manager.</div><div class="ttdef"><b>Definition:</b> FTPClient.h:128</div></div>
209+
<div class="ttc" id="aclassftp__client_1_1_f_t_p_file_html"><div class="ttname"><a href="classftp__client_1_1_f_t_p_file.html">ftp_client::FTPFile</a></div><div class="ttdoc">FTPFile A single file which supports read and write operations. This class is implemented as an Ardui...</div><div class="ttdef"><b>Definition:</b> FTPFile.h:16</div></div>
205210
<div class="ttc" id="aclassftp__client_1_1_f_t_p_file_iterator_html"><div class="ttname"><a href="classftp__client_1_1_f_t_p_file_iterator.html">ftp_client::FTPFileIterator</a></div><div class="ttdoc">FTPFileIterator The file name iterator can be used to list all available files and directories....</div><div class="ttdef"><b>Definition:</b> FTPFileIterator.h:18</div></div>
211+
<div class="ttc" id="aclassftp__client_1_1_f_t_p_session_mgr_html"><div class="ttname"><a href="classftp__client_1_1_f_t_p_session_mgr.html">ftp_client::FTPSessionMgr</a></div><div class="ttdoc">FTPSessionMgr This class manages multiple FTP sessions, allowing for concurrent operations and sessio...</div><div class="ttdef"><b>Definition:</b> FTPSessionMgr.h:17</div></div>
206212
</div><!-- fragment --></div><!-- contents -->
207213
<!-- start footer part -->
208214
<hr class="footer"/><address class="footer"><small>

0 commit comments

Comments
 (0)