LogDoctor/docs/html/classCraplogParserAsync.html

264 lines
12 KiB
HTML
Raw Normal View History

2023-06-03 17:23:33 +02:00
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" lang="en-US">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=11"/>
2023-10-22 17:46:43 +02:00
<meta name="generator" content="Doxygen 1.9.8"/>
2023-06-03 17:23:33 +02:00
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>LogDoctor: CraplogParserAsync 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="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/searchdata.js"></script>
<script type="text/javascript" src="search/search.js"></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 id="projectrow">
<td id="projectlogo"><img alt="Logo" src="dox_logo.png"/></td>
<td id="projectalign">
2023-10-22 17:46:43 +02:00
<div id="projectname">LogDoctor<span id="projectnumber">&#160;3.00</span>
2023-06-03 17:23:33 +02:00
</div>
<div id="projectbrief">Parse Apache2/Nginx/IIS logs and view dinamically generated statistics</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
2023-10-22 17:46:43 +02:00
<!-- Generated by Doxygen 1.9.8 -->
2023-06-03 17:23:33 +02:00
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
var searchBox = new SearchBox("searchBox", "search/",'.html');
/* @license-end */
</script>
<script type="text/javascript" src="menudata.js"></script>
<script type="text/javascript" src="menu.js"></script>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
$(function() {
initMenu('',true,false,'search.php','Search');
$(document).ready(function() { init_search(); });
});
/* @license-end */
</script>
<div id="main-nav"></div>
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
onmouseover="return searchBox.OnSearchSelectShow()"
onmouseout="return searchBox.OnSearchSelectHide()"
onkeydown="return searchBox.OnSearchSelectKey(event)">
</div>
<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<div id="MSearchResults">
<div class="SRPage">
<div id="SRIndex">
<div id="SRResults"></div>
<div class="SRStatus" id="Loading">Loading...</div>
<div class="SRStatus" id="Searching">Searching...</div>
<div class="SRStatus" id="NoMatches">No Matches</div>
</div>
</div>
</div>
</div>
</div><!-- top -->
<div class="header">
<div class="summary">
<a href="#pri-methods">Private Member Functions</a> &#124;
<a href="classCraplogParserAsync-members.html">List of all members</a> </div>
<div class="headertitle"><div class="title">CraplogParserAsync Class Reference</div></div>
</div><!--header-->
<div class="contents">
<div class="dynheader">
Inheritance diagram for CraplogParserAsync:</div>
<div class="dyncontent">
<div class="center">
2023-09-10 19:01:31 +02:00
<img src="classCraplogParserAsync.png" usemap="#CraplogParserAsync_map" alt=""/>
<map id="CraplogParserAsync_map" name="CraplogParserAsync_map">
<area href="classCraplogParserInterface.html" alt="CraplogParserInterface" shape="rect" coords="0,56,145,80"/>
</map>
</div></div>
2023-06-03 17:23:33 +02:00
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="pri-methods" name="pri-methods"></a>
Private Member Functions</h2></td></tr>
2023-10-22 17:46:43 +02:00
<tr class="memitem:acd02045ed712c28cd006ace69b1e998e" id="r_acd02045ed712c28cd006ace69b1e998e"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classCraplogParserAsync.html#acd02045ed712c28cd006ace69b1e998e">joinLogLines</a> (std::promise&lt; logs_lines_t &gt; &amp;log_lines, const logs_file_t &amp;logs_file)</td></tr>
2023-06-03 17:23:33 +02:00
<tr class="memdesc:acd02045ed712c28cd006ace69b1e998e"><td class="mdescLeft">&#160;</td><td class="mdescRight">Reads the selected files and append the resulting lines to the list. <br /></td></tr>
<tr class="separator:acd02045ed712c28cd006ace69b1e998e"><td class="memSeparator" colspan="2">&#160;</td></tr>
2023-10-22 17:46:43 +02:00
<tr class="memitem:af5796e6a2496181cba67553b85eea75b" id="r_af5796e6a2496181cba67553b85eea75b"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classCraplogParserAsync.html#af5796e6a2496181cba67553b85eea75b">parseLogLines</a> (std::future&lt; logs_lines_t &gt; &amp;log_lines)</td></tr>
2023-06-03 17:23:33 +02:00
<tr class="memdesc:af5796e6a2496181cba67553b85eea75b"><td class="mdescLeft">&#160;</td><td class="mdescRight">Parses the lines in the list and stores their data in the data collection. <br /></td></tr>
<tr class="separator:af5796e6a2496181cba67553b85eea75b"><td class="memSeparator" colspan="2">&#160;</td></tr>
2023-10-22 17:46:43 +02:00
<tr class="memitem:a7bc816fb52cff3cf34d339b97fb67d11" id="r_a7bc816fb52cff3cf34d339b97fb67d11"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classCraplogParserAsync.html#a7bc816fb52cff3cf34d339b97fb67d11">storeLogLines</a> ()</td></tr>
2023-06-03 17:23:33 +02:00
<tr class="memdesc:a7bc816fb52cff3cf34d339b97fb67d11"><td class="mdescLeft">&#160;</td><td class="mdescRight">Handles the process of storing data in the database. <br /></td></tr>
<tr class="separator:a7bc816fb52cff3cf34d339b97fb67d11"><td class="memSeparator" colspan="2">&#160;</td></tr>
2023-10-22 17:46:43 +02:00
<tr class="memitem:a9b1a0530c706114b776e886d6c17d911" id="r_a9b1a0530c706114b776e886d6c17d911"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classCraplogParserAsync.html#a9b1a0530c706114b776e886d6c17d911">storeData</a> (QSqlDatabase &amp;db)</td></tr>
<tr class="memdesc:a9b1a0530c706114b776e886d6c17d911"><td class="mdescLeft">&#160;</td><td class="mdescRight">Stores the data collection in the logs Collection database. <br /></td></tr>
<tr class="separator:a9b1a0530c706114b776e886d6c17d911"><td class="memSeparator" colspan="2">&#160;</td></tr>
2023-06-03 17:23:33 +02:00
</table>
<h2 class="groupheader">Member Function Documentation</h2>
<a id="acd02045ed712c28cd006ace69b1e998e" name="acd02045ed712c28cd006ace69b1e998e"></a>
<h2 class="memtitle"><span class="permalink"><a href="#acd02045ed712c28cd006ace69b1e998e">&#9670;&#160;</a></span>joinLogLines()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">void CraplogParserAsync::joinLogLines </td>
<td>(</td>
<td class="paramtype">std::promise&lt; logs_lines_t &gt; &amp;&#160;</td>
<td class="paramname"><em>log_lines</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const logs_file_t &amp;&#160;</td>
<td class="paramname"><em>logs_file</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">private</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Reads the selected files and append the resulting lines to the list. </p>
<dl class="exception"><dt>Exceptions</dt><dd>
<table class="exception">
<tr><td class="paramname"><a class="el" href="classGenericException.html" title="GenericException.">GenericException</a></td><td></td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a id="af5796e6a2496181cba67553b85eea75b" name="af5796e6a2496181cba67553b85eea75b"></a>
<h2 class="memtitle"><span class="permalink"><a href="#af5796e6a2496181cba67553b85eea75b">&#9670;&#160;</a></span>parseLogLines()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">void CraplogParserAsync::parseLogLines </td>
<td>(</td>
<td class="paramtype">std::future&lt; logs_lines_t &gt; &amp;&#160;</td>
<td class="paramname"><em>log_lines</em></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">private</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Parses the lines in the list and stores their data in the data collection. </p>
<dl class="exception"><dt>Exceptions</dt><dd>
<table class="exception">
<tr><td class="paramname"><a class="el" href="classLogParserException.html" title="LogParserException.">LogParserException</a></td><td></td></tr>
</table>
</dd>
</dl>
</div>
</div>
2023-10-22 17:46:43 +02:00
<a id="a9b1a0530c706114b776e886d6c17d911" name="a9b1a0530c706114b776e886d6c17d911"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a9b1a0530c706114b776e886d6c17d911">&#9670;&#160;</a></span>storeData()</h2>
2023-06-03 17:23:33 +02:00
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
2023-10-22 17:46:43 +02:00
<td class="memname">bool CraplogParserAsync::storeData </td>
2023-06-03 17:23:33 +02:00
<td>(</td>
<td class="paramtype">QSqlDatabase &amp;&#160;</td>
<td class="paramname"><em>db</em></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">private</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Stores the data collection in the logs Collection database. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">db</td><td>A database instance, already initizlized </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>Whether the operation has been successful or not </dd></dl>
<dl class="exception"><dt>Exceptions</dt><dd>
<table class="exception">
<tr><td class="paramname"><a class="el" href="classWebServerException.html" title="WebServerException.">WebServerException</a></td><td></td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a id="a7bc816fb52cff3cf34d339b97fb67d11" name="a7bc816fb52cff3cf34d339b97fb67d11"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a7bc816fb52cff3cf34d339b97fb67d11">&#9670;&#160;</a></span>storeLogLines()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">void CraplogParserAsync::storeLogLines </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">private</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Handles the process of storing data in the database. </p>
2023-10-22 17:46:43 +02:00
<dl class="section see"><dt>See also</dt><dd><a class="el" href="classCraplogParserAsync.html#a9b1a0530c706114b776e886d6c17d911" title="Stores the data collection in the logs Collection database.">storeData()</a> </dd></dl>
2023-06-03 17:23:33 +02:00
</div>
</div>
<hr/>The documentation for this class was generated from the following files:<ul>
2023-10-22 17:46:43 +02:00
<li>logdoctor/modules/craplog/modules/workers/<b>parser_async.h</b></li>
<li>logdoctor/modules/craplog/modules/workers/<b>parser_async.cpp</b></li>
2023-06-03 17:23:33 +02:00
</ul>
</div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
2023-10-22 17:46:43 +02:00
Generated by&#160;<a href="https://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.9.8
2023-06-03 17:23:33 +02:00
</small></address>
</body>
</html>