<!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"/> <meta name="generator" content="Doxygen 1.8.6"/> <title>Open SCAP Library: err_queue Struct 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="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">Open SCAP Library </div> </td> </tr> </tbody> </table> </div> <!-- end header part --> <!-- Generated by Doxygen 1.8.6 --> <div id="navrow1" class="tabs"> <ul class="tablist"> <li><a href="index.html"><span>Main Page</span></a></li> <li><a href="pages.html"><span>Related Pages</span></a></li> <li><a href="modules.html"><span>Modules</span></a></li> <li class="current"><a href="annotated.html"><span>Data Structures</span></a></li> <li><a href="files.html"><span>Files</span></a></li> </ul> </div> <div id="navrow2" class="tabs2"> <ul class="tablist"> <li><a href="annotated.html"><span>Data Structures</span></a></li> <li><a href="classes.html"><span>Data Structure Index</span></a></li> <li><a href="functions.html"><span>Data Fields</span></a></li> </ul> </div> </div><!-- top --> <div class="header"> <div class="summary"> <a href="#pub-methods">Public Member Functions</a> | <a href="#pub-attribs">Data Fields</a> </div> <div class="headertitle"> <div class="title">err_queue Struct Reference</div> </div> </div><!--header--> <div class="contents"> <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:a675168fb2117982a847d20cf38b08cd6"><td class="memItemLeft" align="right" valign="top">struct <a class="el" href="structerr__queue.html">err_queue</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="structerr__queue.html#a675168fb2117982a847d20cf38b08cd6">err_queue_new</a> (void)</td></tr> <tr class="memdesc:a675168fb2117982a847d20cf38b08cd6"><td class="mdescLeft"> </td><td class="mdescRight">Initialize new error_queue. <a href="#a675168fb2117982a847d20cf38b08cd6">More...</a><br/></td></tr> <tr class="separator:a675168fb2117982a847d20cf38b08cd6"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:a6e1aa2008aa2b7b1122eb97794c312eb"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="structerr__queue.html#a6e1aa2008aa2b7b1122eb97794c312eb">err_queue_push</a> (struct <a class="el" href="structerr__queue.html">err_queue</a> *q, struct <a class="el" href="structoscap__err__t.html">oscap_err_t</a> *error)</td></tr> <tr class="memdesc:a6e1aa2008aa2b7b1122eb97794c312eb"><td class="mdescLeft"> </td><td class="mdescRight">Push the new error at the end of the error queue. <a href="#a6e1aa2008aa2b7b1122eb97794c312eb">More...</a><br/></td></tr> <tr class="separator:a6e1aa2008aa2b7b1122eb97794c312eb"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:aff305581a98fbd94e732c65841a2fbc4"><td class="memItemLeft" align="right" valign="top">struct <a class="el" href="structoscap__err__t.html">oscap_err_t</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="structerr__queue.html#aff305581a98fbd94e732c65841a2fbc4">err_queue_pop_first</a> (struct <a class="el" href="structerr__queue.html">err_queue</a> *q)</td></tr> <tr class="memdesc:aff305581a98fbd94e732c65841a2fbc4"><td class="mdescLeft"> </td><td class="mdescRight">Pop the first object from the FIFO queue. <a href="#aff305581a98fbd94e732c65841a2fbc4">More...</a><br/></td></tr> <tr class="separator:aff305581a98fbd94e732c65841a2fbc4"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:aa0916701150b8db6f701d72d5becb944"><td class="memItemLeft" align="right" valign="top">const struct <a class="el" href="structoscap__err__t.html">oscap_err_t</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="structerr__queue.html#aa0916701150b8db6f701d72d5becb944">err_queue_get_last</a> (struct <a class="el" href="structerr__queue.html">err_queue</a> *q)</td></tr> <tr class="memdesc:aa0916701150b8db6f701d72d5becb944"><td class="mdescLeft"> </td><td class="mdescRight">Return the last object from the FIFO queuqe. <a href="#aa0916701150b8db6f701d72d5becb944">More...</a><br/></td></tr> <tr class="separator:aa0916701150b8db6f701d72d5becb944"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:a3b6fef0ad054aae1a42d3951e87cbc3f"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="structerr__queue.html#a3b6fef0ad054aae1a42d3951e87cbc3f">err_queue_free</a> (struct <a class="el" href="structerr__queue.html">err_queue</a> *q, oscap_destruct_func destructor)</td></tr> <tr class="memdesc:a3b6fef0ad054aae1a42d3951e87cbc3f"><td class="mdescLeft"> </td><td class="mdescRight">Dispose given <a class="el" href="structerr__queue.html">err_queue</a>. <a href="#a3b6fef0ad054aae1a42d3951e87cbc3f">More...</a><br/></td></tr> <tr class="separator:a3b6fef0ad054aae1a42d3951e87cbc3f"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:ad299fa44dd0e38864c954550e6957cd1"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="structerr__queue.html#ad299fa44dd0e38864c954550e6957cd1">err_queue_to_string</a> (struct <a class="el" href="structerr__queue.html">err_queue</a> *q, char **result)</td></tr> <tr class="memdesc:ad299fa44dd0e38864c954550e6957cd1"><td class="mdescLeft"> </td><td class="mdescRight">Get all the errors in the queue as a single string. <a href="#ad299fa44dd0e38864c954550e6957cd1">More...</a><br/></td></tr> <tr class="separator:ad299fa44dd0e38864c954550e6957cd1"><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> Data Fields</h2></td></tr> <tr class="memitem:ac91d6eea26bea7dbb4e98ee16775a8ce"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ac91d6eea26bea7dbb4e98ee16775a8ce"></a> struct <a class="el" href="structoscap__err__t.html">oscap_err_t</a> * </td><td class="memItemRight" valign="bottom"><b>first</b></td></tr> <tr class="separator:ac91d6eea26bea7dbb4e98ee16775a8ce"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:ae1836e4ebc6660a4088b0794f722c889"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ae1836e4ebc6660a4088b0794f722c889"></a> struct <a class="el" href="structoscap__err__t.html">oscap_err_t</a> * </td><td class="memItemRight" valign="bottom"><b>last</b></td></tr> <tr class="separator:ae1836e4ebc6660a4088b0794f722c889"><td class="memSeparator" colspan="2"> </td></tr> </table> <h2 class="groupheader">Member Function Documentation</h2> <a class="anchor" id="a3b6fef0ad054aae1a42d3951e87cbc3f"></a> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">void err_queue_free </td> <td>(</td> <td class="paramtype">struct <a class="el" href="structerr__queue.html">err_queue</a> * </td> <td class="paramname"><em>q</em>, </td> </tr> <tr> <td class="paramkey"></td> <td></td> <td class="paramtype">oscap_destruct_func </td> <td class="paramname"><em>destructor</em> </td> </tr> <tr> <td></td> <td>)</td> <td></td><td></td> </tr> </table> </div><div class="memdoc"> <p>Dispose given <a class="el" href="structerr__queue.html">err_queue</a>. </p> <p>Dispose also stored messages if destructor is supplied.</p> <dl class="params"><dt>Parameters</dt><dd> <table class="params"> <tr><td class="paramname">q</td><td>Internal Error Queue </td></tr> <tr><td class="paramname">destructor</td><td>a function to dipose messages in the queue </td></tr> </table> </dd> </dl> </div> </div> <a class="anchor" id="aa0916701150b8db6f701d72d5becb944"></a> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">const struct <a class="el" href="structoscap__err__t.html">oscap_err_t</a> * err_queue_get_last </td> <td>(</td> <td class="paramtype">struct <a class="el" href="structerr__queue.html">err_queue</a> * </td> <td class="paramname"><em>q</em></td><td>)</td> <td></td> </tr> </table> </div><div class="memdoc"> <p>Return the last object from the FIFO queuqe. </p> <p>This object continues to be a property of <a class="el" href="structerr__queue.html">err_queue</a> and shall not be modified nor disposed.</p> <dl class="params"><dt>Parameters</dt><dd> <table class="params"> <tr><td class="paramname">q</td><td>Internal Error Queue </td></tr> </table> </dd> </dl> <dl class="section return"><dt>Returns</dt><dd>the last item in the queue or NULL </dd></dl> </div> </div> <a class="anchor" id="a675168fb2117982a847d20cf38b08cd6"></a> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">struct <a class="el" href="structerr__queue.html">err_queue</a> * err_queue_new </td> <td>(</td> <td class="paramtype">void </td> <td class="paramname"></td><td>)</td> <td></td> </tr> </table> </div><div class="memdoc"> <p>Initialize new error_queue. </p> <dl class="section return"><dt>Returns</dt><dd>newly initialized error queue </dd></dl> </div> </div> <a class="anchor" id="aff305581a98fbd94e732c65841a2fbc4"></a> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">struct <a class="el" href="structoscap__err__t.html">oscap_err_t</a> * err_queue_pop_first </td> <td>(</td> <td class="paramtype">struct <a class="el" href="structerr__queue.html">err_queue</a> * </td> <td class="paramname"><em>q</em></td><td>)</td> <td></td> </tr> </table> </div><div class="memdoc"> <p>Pop the first object from the FIFO queue. </p> <p>This new object is no longer tracked by <a class="el" href="structerr__queue.html">err_queue</a> and shall be disposed by caller.</p> <dl class="params"><dt>Parameters</dt><dd> <table class="params"> <tr><td class="paramname">q</td><td>Internal Error Queue </td></tr> </table> </dd> </dl> <dl class="section return"><dt>Returns</dt><dd>The first item in the queue or NULL. </dd></dl> </div> </div> <a class="anchor" id="a6e1aa2008aa2b7b1122eb97794c312eb"></a> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">bool err_queue_push </td> <td>(</td> <td class="paramtype">struct <a class="el" href="structerr__queue.html">err_queue</a> * </td> <td class="paramname"><em>q</em>, </td> </tr> <tr> <td class="paramkey"></td> <td></td> <td class="paramtype">struct <a class="el" href="structoscap__err__t.html">oscap_err_t</a> * </td> <td class="paramname"><em>error</em> </td> </tr> <tr> <td></td> <td>)</td> <td></td><td></td> </tr> </table> </div><div class="memdoc"> <p>Push the new error at the end of the error queue. </p> <dl class="params"><dt>Parameters</dt><dd> <table class="params"> <tr><td class="paramname">q</td><td>Internal Error Queue </td></tr> <tr><td class="paramname">error</td><td>new error to save in the queuei </td></tr> </table> </dd> </dl> <dl class="section return"><dt>Returns</dt><dd>true on success </dd></dl> </div> </div> <a class="anchor" id="ad299fa44dd0e38864c954550e6957cd1"></a> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">int err_queue_to_string </td> <td>(</td> <td class="paramtype">struct <a class="el" href="structerr__queue.html">err_queue</a> * </td> <td class="paramname"><em>q</em>, </td> </tr> <tr> <td class="paramkey"></td> <td></td> <td class="paramtype">char ** </td> <td class="paramname"><em>result</em> </td> </tr> <tr> <td></td> <td>)</td> <td></td><td></td> </tr> </table> </div><div class="memdoc"> <p>Get all the errors in the queue as a single string. </p> <dl class="params"><dt>Parameters</dt><dd> <table class="params"> <tr><td class="paramname">q</td><td>Internal Error Queue </td></tr> <tr><td class="paramname">result</td><td>pointer, where to store the resulting string. Newly allocated mmory will be assigned with this. And shall be disposed by caller. </td></tr> </table> </dd> </dl> <dl class="section return"><dt>Returns</dt><dd>zero on success </dd></dl> </div> </div> <hr/>The documentation for this struct was generated from the following files:<ul> <li>err_queue.c</li> <li><a class="el" href="err__queue_8h_source.html">err_queue.h</a></li> </ul> </div><!-- contents --> <!-- start footer part --> <hr class="footer"/><address class="footer"><small> Generated by  <a href="http://www.doxygen.org/index.html"> <img class="footer" src="doxygen.png" alt="doxygen"/> </a> 1.8.6 </small></address> </body> </html>