Sophie

Sophie

distrib > Fedora > 14 > x86_64 > media > updates > by-pkgid > 727fa15453fcace956b835e2377d4269 > files > 336

player-doc-3.0.2-5.fc14.noarch.rpm

<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01//EN"
   "http://www.w3.org/TR/html4/strict.dtd">

<html>
<!-- $Id: header.html 8799 2010-06-28 04:12:42Z jpgr87 $ -->

<HEAD>


<meta HTTP-EQUIV="Content-Type" CONTENT="text/html;CHARSET=utf-8">
<meta name="keywords" content="stage, robot, simulation, player, player/stage">
<link href="doxygen.css" rel="stylesheet" type="text/css">

<style type="text/css">

.floatright { float: right; margin: 0 0 1em 1em; }

body {
  font-family: sans-serif;
  #font-family: Geneva, Verdana, Helvetica, Arial, sans-serif;
  background-color: #FFF;
  color:#000;
}


a:link { 
	color: #A00;
}

a:visited { 
	color: #800;
}

a { text-decoration: none; }
a:hover { text-decoration: underline; }


.timestamp { text-align:right; background-color: #DDD; font-size:75%;}

h1 { 
  font-size:160%; 
}

h2 {
  font-size:110%;
  #color: #FFF;
  #background-color: #666;
  #padding:3px;
}

h3 { text-align:left; }

img {
  border: 0;
}

ul.menu { 
    position:relative;
    left:-2.5em;
    margin-bottom:0px;
    margin-top:0px;
}

ul.menu1 { 
    position:relative;
    left:-2.1em;
    margin-bottom:0px;
    margin-top:0px;
}

li.menu { 
    list-style-type: none;
    position:relative;
    #left:-0.5em;
}


#sidebar { position: absolute; left:0px; padding:2em; top:0em; width:12em;}

#content { position: absolute; left:12em; top:0em; padding-left:3em; padding-right:3em; padding-bottom:2em; margin-top:1em; margin-right:2em; }

div.box { background-color:#EEE; border: 1px solid #000; padding: 0.5ex 0.4em 0.5ex 0.6em; margin:1em;  }
div.title { font-weight:bold; background-color:#eee; margin-bottom:2px;}

div.topbar { position: absolute; top:0px; left:9em; margin:1em; }

</style>

<TITLE>Player Manual</TITLE>

</HEAD>

<body>

<div id="sidebar"> 

<h2 style="text-align:center;">
<a href="index.html">
<img width=140 src="http://playerstage.sourceforge.net/images/player_button_v3.png" alt="Player logo"><br></a>
</h2>



<div class="box">
<div class=title>Player</div>

<ul class=menu>
<li class=menu><a href="index.html">Frontpage</a>
<li class=menu><a href="modules.html">Contents</a>
</ul>
</div>

<div class="box">
<div class=title>User</div>

<ul class=menu>
<li class=menu><a href="install.html">Installation</a>
<li class=menu><a href="start.html">Quick start</a>
<li class=menu><a href="supported_hardware.html">Supported&nbsp;devices</a>
<li class=menu><a href="group__tutorials.html">Tutorials</a>
<li class=menu><a href="group__utils.html">Utilities</a>
<li class=menu><a href="group__clientlibs.html">Client&nbsp;libraries</a>
<li class=menu><a href="http://playerstage.sourceforge.net/wiki/Basic_FAQ">FAQ</a>
<li class=menu><a href="help.html">Help</a>

</ul>
</div>

<div class=box>
<div class="title">Developer</div>
<ul class=menu>
<li class=menu><a href="architecture.html">Architecture</a>
<li class=menu><a href="group__libplayercore.html">libplayercore</a>
<ul class=menu1>
<li class=menu><a href="group__interfaces.html">interfaces</a></li>
</ul>
<li class=menu><a href="group__libplayerdrivers.html">libplayerdrivers</a>
<ul class=menu1>
<li class=menu><a href="group__drivers.html">drivers</a></li>
</ul>
<li class=menu><a href="group__libplayercommon.html">libplayercommon</a>
<li class=menu><a href="group__libplayerutils.html">libplayerutils</a>
<li class=menu><a href="group__libplayersd.html">libplayersd</a>
<li class=menu><a href="group__libplayertcp.html">libplayertcp</a>
<li class=menu><a href="group__libplayerxdr.html">libplayerxdr</a>
<li class=menu><a href="todo.html">TODO</a>
</ul>
</div>

<div class=box>
<!-- <a href="http://sourceforge.net"><img border=0 src="http://sourceforge.net/sflogo.php?group_id=42445&type=1"></a> -->
<div class="title">Online</div>
<a href="http://playerstage.sourceforge.net">Homepage</a><br>
<a href="http://sourceforge.net/project/showfiles.php?group_id=42445">Download</a><br>
<a href="http://sourceforge.net/projects/playerstage">Project</a><br>
<a href="http://sourceforge.net/tracker/?group_id=42445">Bugs</a><br>
<a href="http://sourceforge.net/mail/?group_id=42445">Help</a>
</div>


</div>

<div id="content" >
<!-- Generated by Doxygen 1.7.1 -->
<div class="header">
  <div class="summary">
<a href="#pub-methods">Public Member Functions</a> &#124;
<a href="#pri-methods">Private Member Functions</a> &#124;
<a href="#pri-attribs">Private Attributes</a>  </div>
  <div class="headertitle">
<h1>QueuePointer Class Reference</h1>  </div>
</div>
<div class="contents">
<!-- doxytag: class="QueuePointer" -->
<p>An autopointer for the message queue.  
<a href="#_details">More...</a></p>

<p><code>#include &lt;<a class="el" href="message_8h_source.html">message.h</a>&gt;</code></p>

<p><a href="classQueuePointer-members.html">List of all members.</a></p>
<table class="memberdecls">
<tr><td colspan="2"><h2><a name="pub-methods"></a>
Public Member Functions</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="af16fa7e6698b2b7bbf62a47e55ae9597"></a><!-- doxytag: member="QueuePointer::QueuePointer" ref="af16fa7e6698b2b7bbf62a47e55ae9597" args="()" -->
&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classQueuePointer.html#af16fa7e6698b2b7bbf62a47e55ae9597">QueuePointer</a> ()</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Create a NULL autopointer;. <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="aab6c08525428cca21e860c4081e30599"></a><!-- doxytag: member="QueuePointer::QueuePointer" ref="aab6c08525428cca21e860c4081e30599" args="(bool _Replace, size_t _Maxlen)" -->
&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classQueuePointer.html#aab6c08525428cca21e860c4081e30599">QueuePointer</a> (bool _Replace, size_t _Maxlen)</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Create an empty message queue and an auto pointer to it. <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="abe32febf83802334b09c8b17c93bebca"></a><!-- doxytag: member="QueuePointer::~QueuePointer" ref="abe32febf83802334b09c8b17c93bebca" args="()" -->
&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classQueuePointer.html#abe32febf83802334b09c8b17c93bebca">~QueuePointer</a> ()</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Destroy our reference to the message queue. <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ad5146f9f9b22b4955c43a16f63e45c5b"></a><!-- doxytag: member="QueuePointer::QueuePointer" ref="ad5146f9f9b22b4955c43a16f63e45c5b" args="(const QueuePointer &amp;CopyFrom)" -->
&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classQueuePointer.html#ad5146f9f9b22b4955c43a16f63e45c5b">QueuePointer</a> (const <a class="el" href="classQueuePointer.html">QueuePointer</a> &amp;CopyFrom)</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Create a new reference to a message queue. <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ae9322496889d8aebb82f9b9f48d7945a"></a><!-- doxytag: member="QueuePointer::operator=" ref="ae9322496889d8aebb82f9b9f48d7945a" args="(const QueuePointer &amp;rhs)" -->
<a class="el" href="classQueuePointer.html">QueuePointer</a> &amp;&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classQueuePointer.html#ae9322496889d8aebb82f9b9f48d7945a">operator=</a> (const <a class="el" href="classQueuePointer.html">QueuePointer</a> &amp;rhs)</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">assign reference to our message queue <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a8cb8df2d301e07a146c8136dafc55beb"></a><!-- doxytag: member="QueuePointer::operator&#45;&gt;" ref="a8cb8df2d301e07a146c8136dafc55beb" args="()" -->
<a class="el" href="classMessageQueue.html">MessageQueue</a> *&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classQueuePointer.html#a8cb8df2d301e07a146c8136dafc55beb">operator-&gt;</a> ()</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">retrieve underlying object for use <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a28566b68410cb9ffe96b0336caf71a03"></a><!-- doxytag: member="QueuePointer::get" ref="a28566b68410cb9ffe96b0336caf71a03" args="() const " -->
<a class="el" href="classMessageQueue.html">MessageQueue</a> *&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classQueuePointer.html#a28566b68410cb9ffe96b0336caf71a03">get</a> () const </td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">retrieve underlying object for use, may return a null pointer <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a4d600f746b10be1a8039dc67a88ab549"></a><!-- doxytag: member="QueuePointer::operator*" ref="a4d600f746b10be1a8039dc67a88ab549" args="()" -->
<a class="el" href="classMessageQueue.html">MessageQueue</a> &amp;&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classQueuePointer.html#a4d600f746b10be1a8039dc67a88ab549">operator*</a> ()</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">retrieve underlying object for use <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a23d7ed1ba9ca5ce8ff358be5a87464fa"></a><!-- doxytag: member="QueuePointer::operator==" ref="a23d7ed1ba9ca5ce8ff358be5a87464fa" args="(const QueuePointer &amp;rhs)" -->
bool&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classQueuePointer.html#a23d7ed1ba9ca5ce8ff358be5a87464fa">operator==</a> (const <a class="el" href="classQueuePointer.html">QueuePointer</a> &amp;rhs)</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">check if pointers are equal <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a3863cc8e97937cbf43b74f4b141a2a06"></a><!-- doxytag: member="QueuePointer::operator==" ref="a3863cc8e97937cbf43b74f4b141a2a06" args="(void *pointer)" -->
bool&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classQueuePointer.html#a3863cc8e97937cbf43b74f4b141a2a06">operator==</a> (void *pointer)</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">check if pointers are equal <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a822780b16a6c18cf5a722f5af5e6b6fc"></a><!-- doxytag: member="QueuePointer::operator!=" ref="a822780b16a6c18cf5a722f5af5e6b6fc" args="(const QueuePointer &amp;rhs)" -->
bool&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classQueuePointer.html#a822780b16a6c18cf5a722f5af5e6b6fc">operator!=</a> (const <a class="el" href="classQueuePointer.html">QueuePointer</a> &amp;rhs)</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">check if pointers are equal <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a852ff50873457f2b56d46ed4bf85c1d3"></a><!-- doxytag: member="QueuePointer::operator!=" ref="a852ff50873457f2b56d46ed4bf85c1d3" args="(void *pointer)" -->
bool&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classQueuePointer.html#a852ff50873457f2b56d46ed4bf85c1d3">operator!=</a> (void *pointer)</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">check if pointers are equal <br/></td></tr>
<tr><td colspan="2"><h2><a name="pri-methods"></a>
Private Member Functions</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a3170d78f7f104afecac12c353003ee0d"></a><!-- doxytag: member="QueuePointer::DecRef" ref="a3170d78f7f104afecac12c353003ee0d" args="()" -->
void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classQueuePointer.html#a3170d78f7f104afecac12c353003ee0d">DecRef</a> ()</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Decrement ref count. <br/></td></tr>
<tr><td colspan="2"><h2><a name="pri-attribs"></a>
Private Attributes</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a39d01b30999959c773b2fc2e6da38b53"></a><!-- doxytag: member="QueuePointer::Queue" ref="a39d01b30999959c773b2fc2e6da38b53" args="" -->
<a class="el" href="classMessageQueue.html">MessageQueue</a> *&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classQueuePointer.html#a39d01b30999959c773b2fc2e6da38b53">Queue</a></td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">The queue we are pointing to. <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="af709d845716d474503d0bbf564a97ca3"></a><!-- doxytag: member="QueuePointer::RefCount" ref="af709d845716d474503d0bbf564a97ca3" args="" -->
unsigned int *&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classQueuePointer.html#af709d845716d474503d0bbf564a97ca3">RefCount</a></td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Reference count. <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="abf724f2525c002316ee6374d25c7f81f"></a><!-- doxytag: member="QueuePointer::Lock" ref="abf724f2525c002316ee6374d25c7f81f" args="" -->
pthread_mutex_t *&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classQueuePointer.html#abf724f2525c002316ee6374d25c7f81f">Lock</a></td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Used to lock access to refcount. <br/></td></tr>
</table>
<hr/><a name="_details"></a><h2>Detailed Description</h2>
<p>An autopointer for the message queue. </p>
<p>Using an autopointer allows the queue to be released by the client and still exist until no drivers have messages relating to the queue still pending. </p>
<hr/>The documentation for this class was generated from the following file:<ul>
<li><a class="el" href="message_8h_source.html">message.h</a></li>
</ul>
</div>
<!-- render the modification time of the source file -->


<div class="timestamp">
<hr>

<table style="width:100%;">
<tr>
<td style="text-align:left;">
Last updated 12 September 2005 21:38:45
<!--
<td style="text-align:right;">
<a href="http://validator.w3.org/check/referer"><img style="vertical-align:middle;border:0;width:88px;height:31px"
          src="http://www.w3.org/Icons/valid-html401"
          alt="Valid HTML 4.01!"></a>

 <a href="http://jigsaw.w3.org/css-validator/">
  <img style="vertical-align:middle;border:0;width:88px;height:31px"
       src="http://jigsaw.w3.org/css-validator/images/vcss"
       alt="Valid CSS!">
 </a>
-->
</tr>
</table>
</div>


</tr>
</table>

</BODY>
</HTML>

Perl :: Catalyst :: PostgreSQL :: RPM Valid HTML 4.01 Transitional