LogDoctor/docs/html/classCraplogParser.html

256 lines
11 KiB
HTML
Raw Normal View History

2023-01-27 15:37:29 +01: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"/>
2024-02-16 21:59:07 +01:00
<meta name="generator" content="Doxygen 1.10.0"/>
2023-01-27 15:37:29 +01:00
<meta name="viewport" content="width=device-width, initial-scale=1"/>
2023-05-14 16:03:41 +02:00
<title>LogDoctor: CraplogParser Class Reference</title>
2023-01-27 15:37:29 +01:00
<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>
2024-02-16 21:59:07 +01:00
<script type="text/javascript" src="clipboard.js"></script>
<script type="text/javascript" src="cookie.js"></script>
2023-01-27 15:37:29 +01:00
<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">
2024-02-16 22:18:16 +01:00
<div id="projectname">LogDoctor<span id="projectnumber">&#160;4.00</span>
2023-01-27 15:37:29 +01:00
</div>
2023-02-12 23:33:34 +01:00
<div id="projectbrief">Parse Apache2/Nginx/IIS logs and view dinamically generated statistics</div>
2023-01-27 15:37:29 +01:00
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
2024-02-16 21:59:07 +01:00
<!-- Generated by Doxygen 1.10.0 -->
2023-01-27 15:37:29 +01: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');
2024-02-16 21:59:07 +01:00
$(function() { init_search(); });
2023-01-27 15:37:29 +01:00
});
/* @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;
2023-05-14 16:03:41 +02:00
<a href="classCraplogParser-members.html">List of all members</a> </div>
2024-02-16 21:59:07 +01:00
<div class="headertitle"><div class="title">CraplogParser Class Reference<span class="mlabels"><span class="mlabel">final</span></span></div></div>
2023-01-27 15:37:29 +01:00
</div><!--header-->
<div class="contents">
<div class="dynheader">
2023-05-14 16:03:41 +02:00
Inheritance diagram for CraplogParser:</div>
2023-01-27 15:37:29 +01:00
<div class="dyncontent">
<div class="center">
2024-02-16 21:59:07 +01:00
<img src="classCraplogParser.png" alt=""/>
</div></div>
2023-01-27 15:37:29 +01: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>
2024-02-16 21:59:07 +01:00
<tr class="memitem:a0cab0465f65175011235f09fa0ff281d" id="r_a0cab0465f65175011235f09fa0ff281d"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a0cab0465f65175011235f09fa0ff281d">joinLogLines</a> ()</td></tr>
2023-05-14 16:03:41 +02:00
<tr class="memdesc:a0cab0465f65175011235f09fa0ff281d"><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:a0cab0465f65175011235f09fa0ff281d"><td class="memSeparator" colspan="2">&#160;</td></tr>
2024-02-16 21:59:07 +01:00
<tr class="memitem:a4e19f3c1f8478b545da627339d5bd9c0" id="r_a4e19f3c1f8478b545da627339d5bd9c0"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a4e19f3c1f8478b545da627339d5bd9c0">parseLogLines</a> ()</td></tr>
2023-05-14 16:03:41 +02:00
<tr class="memdesc:a4e19f3c1f8478b545da627339d5bd9c0"><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:a4e19f3c1f8478b545da627339d5bd9c0"><td class="memSeparator" colspan="2">&#160;</td></tr>
2024-02-16 21:59:07 +01:00
<tr class="memitem:a286be6fa72be8bbfe43066cc0d00c89b" id="r_a286be6fa72be8bbfe43066cc0d00c89b"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a286be6fa72be8bbfe43066cc0d00c89b">storeLogLines</a> (QSqlDatabase &amp;db)</td></tr>
<tr class="memdesc:a286be6fa72be8bbfe43066cc0d00c89b"><td class="mdescLeft">&#160;</td><td class="mdescRight">Handles the process of storing data in the database. <br /></td></tr>
<tr class="separator:a286be6fa72be8bbfe43066cc0d00c89b"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a42c778719ee39b19095fb1b074451c14" id="r_a42c778719ee39b19095fb1b074451c14"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a42c778719ee39b19095fb1b074451c14">storeData</a> (QSqlDatabase &amp;db)</td></tr>
2023-10-22 17:46:43 +02:00
<tr class="memdesc:a42c778719ee39b19095fb1b074451c14"><td class="mdescLeft">&#160;</td><td class="mdescRight">Stores the data collection in the logs Collection database. <br /></td></tr>
<tr class="separator:a42c778719ee39b19095fb1b074451c14"><td class="memSeparator" colspan="2">&#160;</td></tr>
2023-01-27 15:37:29 +01:00
</table>
<h2 class="groupheader">Member Function Documentation</h2>
2023-05-14 16:03:41 +02:00
<a id="a0cab0465f65175011235f09fa0ff281d" name="a0cab0465f65175011235f09fa0ff281d"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a0cab0465f65175011235f09fa0ff281d">&#9670;&#160;</a></span>joinLogLines()</h2>
2023-01-27 15:37:29 +01:00
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
2023-05-14 16:03:41 +02:00
<td class="memname">void CraplogParser::joinLogLines </td>
2023-01-27 15:37:29 +01:00
<td>(</td>
2024-02-16 21:59:07 +01:00
<td class="paramname"><span class="paramname"></span></td><td>)</td>
2023-01-27 15:37:29 +01:00
<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>
2023-05-14 16:03:41 +02:00
<a id="a4e19f3c1f8478b545da627339d5bd9c0" name="a4e19f3c1f8478b545da627339d5bd9c0"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a4e19f3c1f8478b545da627339d5bd9c0">&#9670;&#160;</a></span>parseLogLines()</h2>
2023-01-27 15:37:29 +01:00
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
2023-05-14 16:03:41 +02:00
<td class="memname">void CraplogParser::parseLogLines </td>
2023-01-27 15:37:29 +01:00
<td>(</td>
2024-02-16 21:59:07 +01:00
<td class="paramname"><span class="paramname"></span></td><td>)</td>
2023-01-27 15:37:29 +01:00
<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="a42c778719ee39b19095fb1b074451c14" name="a42c778719ee39b19095fb1b074451c14"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a42c778719ee39b19095fb1b074451c14">&#9670;&#160;</a></span>storeData()</h2>
2023-01-27 15:37:29 +01: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 CraplogParser::storeData </td>
2023-01-27 15:37:29 +01:00
<td>(</td>
2024-02-16 21:59:07 +01:00
<td class="paramtype">QSqlDatabase &amp;</td> <td class="paramname"><span class="paramname"><em>db</em></span></td><td>)</td>
2023-01-27 15:37:29 +01:00
<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">
2024-02-16 21:59:07 +01:00
<tr><td class="paramname">db</td><td>The database instance, already initialized </td></tr>
2023-01-27 15:37:29 +01:00
</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">
2024-02-16 21:59:07 +01:00
<tr><td class="paramname">WebServerException</td><td></td></tr>
2023-01-27 15:37:29 +01:00
</table>
</dd>
</dl>
</div>
</div>
2024-02-16 21:59:07 +01:00
<a id="a286be6fa72be8bbfe43066cc0d00c89b" name="a286be6fa72be8bbfe43066cc0d00c89b"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a286be6fa72be8bbfe43066cc0d00c89b">&#9670;&#160;</a></span>storeLogLines()</h2>
2023-01-27 15:37:29 +01:00
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
2023-05-14 16:03:41 +02:00
<td class="memname">void CraplogParser::storeLogLines </td>
2023-01-27 15:37:29 +01:00
<td>(</td>
2024-02-16 21:59:07 +01:00
<td class="paramtype">QSqlDatabase &amp;</td> <td class="paramname"><span class="paramname"><em>db</em></span></td><td>)</td>
2023-01-27 15:37:29 +01:00
<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>
2024-02-16 21:59:07 +01:00
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">db</td><td>The database instance, not initialized already </td></tr>
</table>
</dd>
</dl>
<dl class="section see"><dt>See also</dt><dd><a class="el" href="#a42c778719ee39b19095fb1b074451c14" title="Stores the data collection in the logs Collection database.">storeData()</a> </dd></dl>
2023-01-27 15:37:29 +01: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.h</b></li>
<li>logdoctor/modules/craplog/modules/workers/<b>parser.cpp</b></li>
2023-01-27 15:37:29 +01:00
</ul>
</div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
2024-02-16 21:59:07 +01: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.10.0
2023-01-27 15:37:29 +01:00
</small></address>
</body>
</html>