<!-- This comment will put IE 6, 7 and 8 in quirks mode -->
<!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"/>
<title>libcollection: QUEUE interface</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javaScript" src="search/search.js"></script>
<link href="doxygen.css" rel="stylesheet" type="text/css"/>
</head>
<body onload='searchBox.OnSelectItem(0);'>
<!-- Generated by Doxygen 1.6.1 -->
<script type="text/javascript"><!--
var searchBox = new SearchBox("searchBox", "search",false,'Search');
--></script>
<div class="navigation" id="top">
<div class="tabs">
<ul>
<li><a href="index.html"><span>Main Page</span></a></li>
<li><a href="modules.html"><span>Modules</span></a></li>
<li><a href="annotated.html"><span>Data Structures</span></a></li>
<li><a href="files.html"><span>Files</span></a></li>
<li>
<div id="MSearchBox" class="MSearchBoxInactive">
<img id="MSearchSelect" src="search/search.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)"/>
<a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.png" alt=""/></a>
</div>
</li>
</ul>
</div>
</div>
<div class="contents">
<h1>QUEUE interface</h1><table border="0" cellpadding="0" cellspacing="0">
<tr><td colspan="2"><h2>Defines</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ga363cef14aa70f202ec4e3e948776d29e"></a><!-- doxytag: member="queue::COL_CLASS_QUEUE" ref="ga363cef14aa70f202ec4e3e948776d29e" args="" -->
#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__queue.html#ga363cef14aa70f202ec4e3e948776d29e">COL_CLASS_QUEUE</a> 40000</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Class for the queue object. <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ga69c776f22e60d0f7deb93280ae5b6b2d"></a><!-- doxytag: member="queue::COL_NAME_QUEUE" ref="ga69c776f22e60d0f7deb93280ae5b6b2d" args="" -->
#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__queue.html#ga69c776f22e60d0f7deb93280ae5b6b2d">COL_NAME_QUEUE</a> "queue"</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">All queues use this name as the name of the collection. <br/></td></tr>
<tr><td colspan="2"><h2>Functions</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="group__queue.html#gadbb3f1e060341de271ac37ba19de0c49">col_create_queue</a> (struct <a class="el" href="structcollection__item.html">collection_item</a> **queue)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Create queue. <a href="#gadbb3f1e060341de271ac37ba19de0c49"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__queue.html#ga386ee04ceaf97f0468182ad81d251788">col_destroy_queue</a> (struct <a class="el" href="structcollection__item.html">collection_item</a> *queue)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Destroy queue. <a href="#ga386ee04ceaf97f0468182ad81d251788"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="group__queue.html#ga6155490c452060d1489d0e6c594b41aa">col_enqueue_str_property</a> (struct <a class="el" href="structcollection__item.html">collection_item</a> *queue, const char *property, const char *string, int length)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Add string to the queue. <a href="#ga6155490c452060d1489d0e6c594b41aa"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="group__queue.html#ga616c30e83e3e161417e6e7b2a8c9814b">col_enqueue_binary_property</a> (struct <a class="el" href="structcollection__item.html">collection_item</a> *queue, const char *property, void *binary_data, int length)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Add binary value to the queue. <a href="#ga616c30e83e3e161417e6e7b2a8c9814b"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="group__queue.html#gafe5b4d9e85cfc728f18e8f4b6bbc92f1">col_enqueue_int_property</a> (struct <a class="el" href="structcollection__item.html">collection_item</a> *queue, const char *property, int32_t number)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Add integer value to the queue. <a href="#gafe5b4d9e85cfc728f18e8f4b6bbc92f1"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="group__queue.html#ga443f5626091e46b77c0a031309ec3f94">col_enqueue_unsigned_property</a> (struct <a class="el" href="structcollection__item.html">collection_item</a> *queue, const char *property, uint32_t number)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Add unsigned value to the queue. <a href="#ga443f5626091e46b77c0a031309ec3f94"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="group__queue.html#gab8687f8dda5931d3d699808dbd1c3d60">col_enqueue_long_property</a> (struct <a class="el" href="structcollection__item.html">collection_item</a> *queue, const char *property, int64_t number)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Add long integer value to the queue. <a href="#gab8687f8dda5931d3d699808dbd1c3d60"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="group__queue.html#ga016d34622f7fd18f18da1f11a43fb9cf">col_enqueue_ulong_property</a> (struct <a class="el" href="structcollection__item.html">collection_item</a> *queue, const char *property, uint64_t number)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Add unsigned long value to the queue. <a href="#ga016d34622f7fd18f18da1f11a43fb9cf"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="group__queue.html#ga1481bf588e96e20da2fa955e39c13449">col_enqueue_double_property</a> (struct <a class="el" href="structcollection__item.html">collection_item</a> *queue, const char *property, double number)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Add floating point value to the queue. <a href="#ga1481bf588e96e20da2fa955e39c13449"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="group__queue.html#ga47f60c511ab963c7efe185240f3c6dba">col_enqueue_bool_property</a> (struct <a class="el" href="structcollection__item.html">collection_item</a> *queue, const char *property, unsigned char logical)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Add Boolean value to the queue. <a href="#ga47f60c511ab963c7efe185240f3c6dba"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="group__queue.html#gada982b3a2492a3255e636714d5d83800">col_enqueue_any_property</a> (struct <a class="el" href="structcollection__item.html">collection_item</a> *queue, const char *property, int type, void *data, int length)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Add value of any type to the queue. <a href="#gada982b3a2492a3255e636714d5d83800"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="group__queue.html#gab4bbd6438dc2b04c48fa3f2017fc222e">col_enqueue_item</a> (struct <a class="el" href="structcollection__item.html">collection_item</a> *queue, struct <a class="el" href="structcollection__item.html">collection_item</a> *item)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Push item into the queue. <a href="#gab4bbd6438dc2b04c48fa3f2017fc222e"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="group__queue.html#ga5cdfd4a8a5a53a656b3d1433d21f5820">col_dequeue_item</a> (struct <a class="el" href="structcollection__item.html">collection_item</a> *queue, struct <a class="el" href="structcollection__item.html">collection_item</a> **item)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Get item from the queue. <a href="#ga5cdfd4a8a5a53a656b3d1433d21f5820"></a><br/></td></tr>
</table>
<hr/><a name="_details"></a><h2>Detailed Description</h2>
<p>Queue interface is a wrapper on top of the <a class="el" href="group__collection.html">COLLECTION interface</a> interface. It implements a queue using a collection object. </p>
<hr/><h2>Function Documentation</h2>
<a class="anchor" id="gadbb3f1e060341de271ac37ba19de0c49"></a><!-- doxytag: member="collection_queue.h::col_create_queue" ref="gadbb3f1e060341de271ac37ba19de0c49" args="(struct collection_item **queue)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int col_create_queue </td>
<td>(</td>
<td class="paramtype">struct <a class="el" href="structcollection__item.html">collection_item</a> ** </td>
<td class="paramname"> <em>queue</em></td>
<td> ) </td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Create queue. </p>
<p>Function that creates a queue object.</p>
<dl><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"><tt>[out]</tt> </td><td valign="top"><em>queue</em> </td><td>Newly created queue object.</td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>0 - Queue was created successfully. </dd>
<dd>
ENOMEM - No memory. </dd></dl>
</div>
</div>
<a class="anchor" id="ga5cdfd4a8a5a53a656b3d1433d21f5820"></a><!-- doxytag: member="collection_queue.h::col_dequeue_item" ref="ga5cdfd4a8a5a53a656b3d1433d21f5820" args="(struct collection_item *queue, struct collection_item **item)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int col_dequeue_item </td>
<td>(</td>
<td class="paramtype">struct <a class="el" href="structcollection__item.html">collection_item</a> * </td>
<td class="paramname"> <em>queue</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">struct <a class="el" href="structcollection__item.html">collection_item</a> ** </td>
<td class="paramname"> <em>item</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Get item from the queue. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"><tt>[in]</tt> </td><td valign="top"><em>queue</em> </td><td>Queue object. </td></tr>
<tr><td valign="top"><tt>[out]</tt> </td><td valign="top"><em>item</em> </td><td>Variable receives the value of the retrieved item. Will be set to NULL if there are no more items in the queue.</td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>0 - No internal issues detected. </dd>
<dd>
ENOMEM - No memory. </dd>
<dd>
EINVAL - Invalid argument. </dd></dl>
</div>
</div>
<a class="anchor" id="ga386ee04ceaf97f0468182ad81d251788"></a><!-- doxytag: member="collection_queue.h::col_destroy_queue" ref="ga386ee04ceaf97f0468182ad81d251788" args="(struct collection_item *queue)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void col_destroy_queue </td>
<td>(</td>
<td class="paramtype">struct <a class="el" href="structcollection__item.html">collection_item</a> * </td>
<td class="paramname"> <em>queue</em></td>
<td> ) </td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Destroy queue. </p>
<p>Function that destroys a queue object.</p>
<dl><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"><tt>[in]</tt> </td><td valign="top"><em>queue</em> </td><td>Queue object to destroy. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a class="anchor" id="gada982b3a2492a3255e636714d5d83800"></a><!-- doxytag: member="collection_queue.h::col_enqueue_any_property" ref="gada982b3a2492a3255e636714d5d83800" args="(struct collection_item *queue, const char *property, int type, void *data, int length)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int col_enqueue_any_property </td>
<td>(</td>
<td class="paramtype">struct <a class="el" href="structcollection__item.html">collection_item</a> * </td>
<td class="paramname"> <em>queue</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const char * </td>
<td class="paramname"> <em>property</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int </td>
<td class="paramname"> <em>type</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">void * </td>
<td class="paramname"> <em>data</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int </td>
<td class="paramname"> <em>length</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Add value of any type to the queue. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"><tt>[in]</tt> </td><td valign="top"><em>queue</em> </td><td>Queue object. </td></tr>
<tr><td valign="top"><tt>[in]</tt> </td><td valign="top"><em>property</em> </td><td>Name of the property.<br/>
Name should consist of the ASCII characters with codes non less than space. Exclamation mark character is a special character and can't be used in name of collection or property.<br/>
Maximum allowed length is defined at compile time. The default value is 64k. </td></tr>
<tr><td valign="top"><tt>[in]</tt> </td><td valign="top"><em>type</em> </td><td>Type to use. </td></tr>
<tr><td valign="top"><tt>[in]</tt> </td><td valign="top"><em>data</em> </td><td>Data to add. </td></tr>
<tr><td valign="top"><tt>[in]</tt> </td><td valign="top"><em>length</em> </td><td>Length of the data.</td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>0 - Property was added successfully. </dd>
<dd>
ENOMEM - No memory. </dd>
<dd>
EINVAL - Invalid characters in the property name. Value argument is invalid in some way. </dd>
<dd>
EMSGSIZE - Property name is too long. </dd></dl>
</div>
</div>
<a class="anchor" id="ga616c30e83e3e161417e6e7b2a8c9814b"></a><!-- doxytag: member="collection_queue.h::col_enqueue_binary_property" ref="ga616c30e83e3e161417e6e7b2a8c9814b" args="(struct collection_item *queue, const char *property, void *binary_data, int length)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int col_enqueue_binary_property </td>
<td>(</td>
<td class="paramtype">struct <a class="el" href="structcollection__item.html">collection_item</a> * </td>
<td class="paramname"> <em>queue</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const char * </td>
<td class="paramname"> <em>property</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">void * </td>
<td class="paramname"> <em>binary_data</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int </td>
<td class="paramname"> <em>length</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Add binary value to the queue. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"><tt>[in]</tt> </td><td valign="top"><em>queue</em> </td><td>Queue object. </td></tr>
<tr><td valign="top"><tt>[in]</tt> </td><td valign="top"><em>property</em> </td><td>Name of the property.<br/>
Name should consist of the ASCII characters with codes non less than space. Exclamation mark character is a special character and can't be used in name of collection or property.<br/>
Maximum allowed length is defined at compile time. The default value is 64k. </td></tr>
<tr><td valign="top"><tt>[in]</tt> </td><td valign="top"><em>binary_data</em> </td><td>Data to add. </td></tr>
<tr><td valign="top"><tt>[in]</tt> </td><td valign="top"><em>length</em> </td><td>Length of the binary data.</td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>0 - Property was added successfully. </dd>
<dd>
ENOMEM - No memory. </dd>
<dd>
EINVAL - Invalid argument. </dd>
<dd>
EMSGSIZE - Property name is too long. </dd></dl>
</div>
</div>
<a class="anchor" id="ga47f60c511ab963c7efe185240f3c6dba"></a><!-- doxytag: member="collection_queue.h::col_enqueue_bool_property" ref="ga47f60c511ab963c7efe185240f3c6dba" args="(struct collection_item *queue, const char *property, unsigned char logical)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int col_enqueue_bool_property </td>
<td>(</td>
<td class="paramtype">struct <a class="el" href="structcollection__item.html">collection_item</a> * </td>
<td class="paramname"> <em>queue</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const char * </td>
<td class="paramname"> <em>property</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">unsigned char </td>
<td class="paramname"> <em>logical</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Add Boolean value to the queue. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"><tt>[in]</tt> </td><td valign="top"><em>queue</em> </td><td>Queue object. </td></tr>
<tr><td valign="top"><tt>[in]</tt> </td><td valign="top"><em>property</em> </td><td>Name of the property.<br/>
Name should consist of the ASCII characters with codes non less than space. Exclamation mark character is a special character and can't be used in name of collection or property.<br/>
Maximum allowed length is defined at compile time. The default value is 64k. </td></tr>
<tr><td valign="top"><tt>[in]</tt> </td><td valign="top"><em>logical</em> </td><td>Value to add.</td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>0 - Property was added successfully. </dd>
<dd>
ENOMEM - No memory. </dd>
<dd>
EINVAL - Invalid argument. </dd>
<dd>
EMSGSIZE - Property name is too long. </dd></dl>
</div>
</div>
<a class="anchor" id="ga1481bf588e96e20da2fa955e39c13449"></a><!-- doxytag: member="collection_queue.h::col_enqueue_double_property" ref="ga1481bf588e96e20da2fa955e39c13449" args="(struct collection_item *queue, const char *property, double number)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int col_enqueue_double_property </td>
<td>(</td>
<td class="paramtype">struct <a class="el" href="structcollection__item.html">collection_item</a> * </td>
<td class="paramname"> <em>queue</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const char * </td>
<td class="paramname"> <em>property</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">double </td>
<td class="paramname"> <em>number</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Add floating point value to the queue. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"><tt>[in]</tt> </td><td valign="top"><em>queue</em> </td><td>Queue object. </td></tr>
<tr><td valign="top"><tt>[in]</tt> </td><td valign="top"><em>property</em> </td><td>Name of the property.<br/>
Name should consist of the ASCII characters with codes non less than space. Exclamation mark character is a special character and can't be used in name of collection or property.<br/>
Maximum allowed length is defined at compile time. The default value is 64k. </td></tr>
<tr><td valign="top"><tt>[in]</tt> </td><td valign="top"><em>number</em> </td><td>Value to add.</td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>0 - Property was added successfully. </dd>
<dd>
ENOMEM - No memory. </dd>
<dd>
EINVAL - Invalid argument. </dd>
<dd>
EMSGSIZE - Property name is too long. </dd></dl>
</div>
</div>
<a class="anchor" id="gafe5b4d9e85cfc728f18e8f4b6bbc92f1"></a><!-- doxytag: member="collection_queue.h::col_enqueue_int_property" ref="gafe5b4d9e85cfc728f18e8f4b6bbc92f1" args="(struct collection_item *queue, const char *property, int32_t number)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int col_enqueue_int_property </td>
<td>(</td>
<td class="paramtype">struct <a class="el" href="structcollection__item.html">collection_item</a> * </td>
<td class="paramname"> <em>queue</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const char * </td>
<td class="paramname"> <em>property</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int32_t </td>
<td class="paramname"> <em>number</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Add integer value to the queue. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"><tt>[in]</tt> </td><td valign="top"><em>queue</em> </td><td>Queue object. </td></tr>
<tr><td valign="top"><tt>[in]</tt> </td><td valign="top"><em>property</em> </td><td>Name of the property.<br/>
Name should consist of the ASCII characters with codes non less than space. Exclamation mark character is a special character and can't be used in name of collection or property.<br/>
Maximum allowed length is defined at compile time. The default value is 64k. </td></tr>
<tr><td valign="top"><tt>[in]</tt> </td><td valign="top"><em>number</em> </td><td>Value to add.</td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>0 - Property was added successfully. </dd>
<dd>
ENOMEM - No memory. </dd>
<dd>
EINVAL - Invalid argument. </dd>
<dd>
EMSGSIZE - Property name is too long. </dd></dl>
</div>
</div>
<a class="anchor" id="gab4bbd6438dc2b04c48fa3f2017fc222e"></a><!-- doxytag: member="collection_queue.h::col_enqueue_item" ref="gab4bbd6438dc2b04c48fa3f2017fc222e" args="(struct collection_item *queue, struct collection_item *item)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int col_enqueue_item </td>
<td>(</td>
<td class="paramtype">struct <a class="el" href="structcollection__item.html">collection_item</a> * </td>
<td class="paramname"> <em>queue</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">struct <a class="el" href="structcollection__item.html">collection_item</a> * </td>
<td class="paramname"> <em>item</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Push item into the queue. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"><tt>[in]</tt> </td><td valign="top"><em>queue</em> </td><td>Queue object. </td></tr>
<tr><td valign="top"><tt>[in]</tt> </td><td valign="top"><em>item</em> </td><td>Item to push.</td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>0 - Item was added successfully. </dd>
<dd>
ENOMEM - No memory. </dd>
<dd>
EINVAL - Invalid argument. </dd></dl>
</div>
</div>
<a class="anchor" id="gab8687f8dda5931d3d699808dbd1c3d60"></a><!-- doxytag: member="collection_queue.h::col_enqueue_long_property" ref="gab8687f8dda5931d3d699808dbd1c3d60" args="(struct collection_item *queue, const char *property, int64_t number)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int col_enqueue_long_property </td>
<td>(</td>
<td class="paramtype">struct <a class="el" href="structcollection__item.html">collection_item</a> * </td>
<td class="paramname"> <em>queue</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const char * </td>
<td class="paramname"> <em>property</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int64_t </td>
<td class="paramname"> <em>number</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Add long integer value to the queue. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"><tt>[in]</tt> </td><td valign="top"><em>queue</em> </td><td>Queue object. </td></tr>
<tr><td valign="top"><tt>[in]</tt> </td><td valign="top"><em>property</em> </td><td>Name of the property.<br/>
Name should consist of the ASCII characters with codes non less than space. Exclamation mark character is a special character and can't be used in name of collection or property.<br/>
Maximum allowed length is defined at compile time. The default value is 64k. </td></tr>
<tr><td valign="top"><tt>[in]</tt> </td><td valign="top"><em>number</em> </td><td>Value to add.</td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>0 - Property was added successfully. </dd>
<dd>
ENOMEM - No memory. </dd>
<dd>
EINVAL - Invalid argument. </dd>
<dd>
EMSGSIZE - Property name is too long. </dd></dl>
</div>
</div>
<a class="anchor" id="ga6155490c452060d1489d0e6c594b41aa"></a><!-- doxytag: member="collection_queue.h::col_enqueue_str_property" ref="ga6155490c452060d1489d0e6c594b41aa" args="(struct collection_item *queue, const char *property, const char *string, int length)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int col_enqueue_str_property </td>
<td>(</td>
<td class="paramtype">struct <a class="el" href="structcollection__item.html">collection_item</a> * </td>
<td class="paramname"> <em>queue</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const char * </td>
<td class="paramname"> <em>property</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const char * </td>
<td class="paramname"> <em>string</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int </td>
<td class="paramname"> <em>length</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Add string to the queue. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"><tt>[in]</tt> </td><td valign="top"><em>queue</em> </td><td>Queue object. </td></tr>
<tr><td valign="top"><tt>[in]</tt> </td><td valign="top"><em>property</em> </td><td>Name of the property.<br/>
Name should consist of the ASCII characters with codes non less than space. Exclamation mark character is a special character and can't be used in name of collection or property.<br/>
Maximum allowed length is defined at compile time. The default value is 64k. </td></tr>
<tr><td valign="top"><tt>[in]</tt> </td><td valign="top"><em>string</em> </td><td>Null terminated string to add. </td></tr>
<tr><td valign="top"><tt>[in]</tt> </td><td valign="top"><em>length</em> </td><td>Length of the string. Should include the length of the terminating 0. If the length is shorter than the full string the string will be truncated. If the length is longer than the actual string there might be garbage at end of the actual string. Library will always properly NULL terminate the string at the given position dictated by length but in no way will inspect the validity of the passed in data. This is left to the calling application.</td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>0 - Property was added successfully. </dd>
<dd>
ENOMEM - No memory. </dd>
<dd>
EINVAL - Invalid characters in the property name. Value argument is invalid in some way. </dd>
<dd>
EMSGSIZE - Property name is too long. </dd></dl>
</div>
</div>
<a class="anchor" id="ga016d34622f7fd18f18da1f11a43fb9cf"></a><!-- doxytag: member="collection_queue.h::col_enqueue_ulong_property" ref="ga016d34622f7fd18f18da1f11a43fb9cf" args="(struct collection_item *queue, const char *property, uint64_t number)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int col_enqueue_ulong_property </td>
<td>(</td>
<td class="paramtype">struct <a class="el" href="structcollection__item.html">collection_item</a> * </td>
<td class="paramname"> <em>queue</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const char * </td>
<td class="paramname"> <em>property</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">uint64_t </td>
<td class="paramname"> <em>number</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Add unsigned long value to the queue. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"><tt>[in]</tt> </td><td valign="top"><em>queue</em> </td><td>Queue object. </td></tr>
<tr><td valign="top"><tt>[in]</tt> </td><td valign="top"><em>property</em> </td><td>Name of the property.<br/>
Name should consist of the ASCII characters with codes non less than space. Exclamation mark character is a special character and can't be used in name of collection or property.<br/>
Maximum allowed length is defined at compile time. The default value is 64k. </td></tr>
<tr><td valign="top"><tt>[in]</tt> </td><td valign="top"><em>number</em> </td><td>Value to add.</td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>0 - Property was added successfully. </dd>
<dd>
ENOMEM - No memory. </dd>
<dd>
EINVAL - Invalid argument. </dd>
<dd>
EMSGSIZE - Property name is too long. </dd></dl>
</div>
</div>
<a class="anchor" id="ga443f5626091e46b77c0a031309ec3f94"></a><!-- doxytag: member="collection_queue.h::col_enqueue_unsigned_property" ref="ga443f5626091e46b77c0a031309ec3f94" args="(struct collection_item *queue, const char *property, uint32_t number)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int col_enqueue_unsigned_property </td>
<td>(</td>
<td class="paramtype">struct <a class="el" href="structcollection__item.html">collection_item</a> * </td>
<td class="paramname"> <em>queue</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const char * </td>
<td class="paramname"> <em>property</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">uint32_t </td>
<td class="paramname"> <em>number</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Add unsigned value to the queue. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"><tt>[in]</tt> </td><td valign="top"><em>queue</em> </td><td>Queue object. </td></tr>
<tr><td valign="top"><tt>[in]</tt> </td><td valign="top"><em>property</em> </td><td>Name of the property.<br/>
Name should consist of the ASCII characters with codes non less than space. Exclamation mark character is a special character and can't be used in name of collection or property.<br/>
Maximum allowed length is defined at compile time. The default value is 64k. </td></tr>
<tr><td valign="top"><tt>[in]</tt> </td><td valign="top"><em>number</em> </td><td>Value to add.</td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>0 - Property was added successfully. </dd>
<dd>
ENOMEM - No memory. </dd>
<dd>
EINVAL - Invalid argument. </dd>
<dd>
EMSGSIZE - Property name is too long. </dd></dl>
</div>
</div>
</div>
<!--- 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>Data Structures</a></div>
<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<iframe src="" frameborder="0"
name="MSearchResults" id="MSearchResults">
</iframe>
</div>
<hr size="1"/><address style="text-align: right;"><small>Generated on 25 Jun 2011 for libcollection by
<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.6.1 </small></address>
</body>
</html>
distrib
>
CentOS
>
6
>
i386
>
media
>
updates
>
by-pkgid
>
5d98b2995a46d456a9243853c7259619
>
files
>
33
