Sophie

Sophie

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

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="#pub-static-methods">Static Public Member Functions</a> &#124;
<a href="#pub-attribs">Public Attributes</a> &#124;
<a href="#pri-attribs">Private Attributes</a>  </div>
  <div class="headertitle">
<h1>PlayerTCP Class Reference</h1>  </div>
</div>
<div class="contents">
<!-- doxytag: class="PlayerTCP" -->
<p><a href="classPlayerTCP-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="a1c076ed882b4d94e213d5a199276c82c"></a><!-- doxytag: member="PlayerTCP::Lock" ref="a1c076ed882b4d94e213d5a199276c82c" args="()" -->
void&nbsp;</td><td class="memItemRight" valign="bottom"><b>Lock</b> ()</td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a3e61267972e06d9099816b255eabcd4c"></a><!-- doxytag: member="PlayerTCP::Unlock" ref="a3e61267972e06d9099816b255eabcd4c" args="()" -->
void&nbsp;</td><td class="memItemRight" valign="bottom"><b>Unlock</b> ()</td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ab69bad9171258ea77e0265275d73ccff"></a><!-- doxytag: member="PlayerTCP::Listen" ref="ab69bad9171258ea77e0265275d73ccff" args="(int *ports, int num_ports, int *new_ports=NULL)" -->
int&nbsp;</td><td class="memItemRight" valign="bottom"><b>Listen</b> (int *ports, int num_ports, int *new_ports=NULL)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a0f33ef954d5bb743b36a77246c37a86c"></a><!-- doxytag: member="PlayerTCP::Listen" ref="a0f33ef954d5bb743b36a77246c37a86c" args="(int port)" -->
int&nbsp;</td><td class="memItemRight" valign="bottom"><b>Listen</b> (int port)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a06c3667a7e5f3298bf99cff5e02202e7"></a><!-- doxytag: member="PlayerTCP::AddClient" ref="a06c3667a7e5f3298bf99cff5e02202e7" args="(struct sockaddr_in *cliaddr, unsigned int local_host, unsigned int local_port, int newsock, bool send_banner, int *kill_flag, bool have_lock)" -->
<a class="el" href="classQueuePointer.html">QueuePointer</a>&nbsp;</td><td class="memItemRight" valign="bottom"><b>AddClient</b> (struct sockaddr_in *cliaddr, unsigned int local_host, unsigned int local_port, int newsock, bool send_banner, int *kill_flag, bool have_lock)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ae24c7f2c9942eec94d8c9058a4fa60ef"></a><!-- doxytag: member="PlayerTCP::AddClient" ref="ae24c7f2c9942eec94d8c9058a4fa60ef" args="(struct sockaddr_in *cliaddr, unsigned int local_host, unsigned int local_port, int newsock, bool send_banner, int *kill_flag, bool have_lock, QueuePointer queue)" -->
<a class="el" href="classQueuePointer.html">QueuePointer</a>&nbsp;</td><td class="memItemRight" valign="bottom"><b>AddClient</b> (struct sockaddr_in *cliaddr, unsigned int local_host, unsigned int local_port, int newsock, bool send_banner, int *kill_flag, bool have_lock, <a class="el" href="classQueuePointer.html">QueuePointer</a> queue)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a4c0cee1ad01340e55b235f74a9e37607"></a><!-- doxytag: member="PlayerTCP::Update" ref="a4c0cee1ad01340e55b235f74a9e37607" args="(int timeout)" -->
int&nbsp;</td><td class="memItemRight" valign="bottom"><b>Update</b> (int timeout)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a8139855ab820a05c3b2ce03eed342ab1"></a><!-- doxytag: member="PlayerTCP::Accept" ref="a8139855ab820a05c3b2ce03eed342ab1" args="(int timeout)" -->
int&nbsp;</td><td class="memItemRight" valign="bottom"><b>Accept</b> (int timeout)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ac7d474999d65221713749bd903db93d6"></a><!-- doxytag: member="PlayerTCP::Close" ref="ac7d474999d65221713749bd903db93d6" args="(int cli)" -->
void&nbsp;</td><td class="memItemRight" valign="bottom"><b>Close</b> (int cli)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="aa7cfbec56395f186a02c28a2168f9728"></a><!-- doxytag: member="PlayerTCP::ReadClient" ref="aa7cfbec56395f186a02c28a2168f9728" args="(int cli)" -->
int&nbsp;</td><td class="memItemRight" valign="bottom"><b>ReadClient</b> (int cli)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a76d45412e30bfdaffccbbd078abc639f"></a><!-- doxytag: member="PlayerTCP::ReadClient" ref="a76d45412e30bfdaffccbbd078abc639f" args="(QueuePointer q)" -->
int&nbsp;</td><td class="memItemRight" valign="bottom"><b>ReadClient</b> (<a class="el" href="classQueuePointer.html">QueuePointer</a> q)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a2c8175f3fd2b4784d92e568b130262f5"></a><!-- doxytag: member="PlayerTCP::Read" ref="a2c8175f3fd2b4784d92e568b130262f5" args="(int timeout, bool have_lock)" -->
int&nbsp;</td><td class="memItemRight" valign="bottom"><b>Read</b> (int timeout, bool have_lock)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a525e992190aec9b23736264324a2fbe9"></a><!-- doxytag: member="PlayerTCP::Write" ref="a525e992190aec9b23736264324a2fbe9" args="(bool have_lock)" -->
int&nbsp;</td><td class="memItemRight" valign="bottom"><b>Write</b> (bool have_lock)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ac4472c045515081d5034a6807872da39"></a><!-- doxytag: member="PlayerTCP::WriteClient" ref="ac4472c045515081d5034a6807872da39" args="(int cli)" -->
int&nbsp;</td><td class="memItemRight" valign="bottom"><b>WriteClient</b> (int cli)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="aefd6153b299f897524a1502452b91693"></a><!-- doxytag: member="PlayerTCP::DeleteClients" ref="aefd6153b299f897524a1502452b91693" args="()" -->
void&nbsp;</td><td class="memItemRight" valign="bottom"><b>DeleteClients</b> ()</td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="aedb7f62391c6f727bc8a508f866471ac"></a><!-- doxytag: member="PlayerTCP::ParseBuffer" ref="aedb7f62391c6f727bc8a508f866471ac" args="(int cli)" -->
void&nbsp;</td><td class="memItemRight" valign="bottom"><b>ParseBuffer</b> (int cli)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a0d68f3a7c065cdef7e348845f440fc19"></a><!-- doxytag: member="PlayerTCP::HandlePlayerMessage" ref="a0d68f3a7c065cdef7e348845f440fc19" args="(int cli, Message *msg)" -->
int&nbsp;</td><td class="memItemRight" valign="bottom"><b>HandlePlayerMessage</b> (int cli, <a class="el" href="classMessage.html">Message</a> *msg)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a8c8c423ac2f8199448127dd6d5c5163f"></a><!-- doxytag: member="PlayerTCP::DeleteClient" ref="a8c8c423ac2f8199448127dd6d5c5163f" args="(QueuePointer &amp;q, bool have_lock)" -->
void&nbsp;</td><td class="memItemRight" valign="bottom"><b>DeleteClient</b> (<a class="el" href="classQueuePointer.html">QueuePointer</a> &amp;q, bool have_lock)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a2838baae40ec874f7c52130b905686fd"></a><!-- doxytag: member="PlayerTCP::Listening" ref="a2838baae40ec874f7c52130b905686fd" args="(int port)" -->
bool&nbsp;</td><td class="memItemRight" valign="bottom"><b>Listening</b> (int port)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="af8d3a796dd315029cad5711175ce9f22"></a><!-- doxytag: member="PlayerTCP::GetHost" ref="af8d3a796dd315029cad5711175ce9f22" args="()" -->
uint32_t&nbsp;</td><td class="memItemRight" valign="bottom"><b>GetHost</b> ()</td></tr>
<tr><td colspan="2"><h2><a name="pub-static-methods"></a>
Static Public Member Functions</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a036a0dc56b274b2f603768727add4262"></a><!-- doxytag: member="PlayerTCP::InitGlobals" ref="a036a0dc56b274b2f603768727add4262" args="(void)" -->
static void&nbsp;</td><td class="memItemRight" valign="bottom"><b>InitGlobals</b> (void)</td></tr>
<tr><td colspan="2"><h2><a name="pub-attribs"></a>
Public Attributes</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a88bbe8ee39bcac6c19e063e9df538672"></a><!-- doxytag: member="PlayerTCP::thread" ref="a88bbe8ee39bcac6c19e063e9df538672" args="" -->
pthread_t&nbsp;</td><td class="memItemRight" valign="bottom"><b>thread</b></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="afe0467f2fd6c518f15d4b2e3180eae13"></a><!-- doxytag: member="PlayerTCP::host" ref="afe0467f2fd6c518f15d4b2e3180eae13" args="" -->
uint32_t&nbsp;</td><td class="memItemRight" valign="bottom"><b>host</b></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="aaf4de015fde0d34499a5a137296098fb"></a><!-- doxytag: member="PlayerTCP::num_listeners" ref="aaf4de015fde0d34499a5a137296098fb" args="" -->
int&nbsp;</td><td class="memItemRight" valign="bottom"><b>num_listeners</b></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a111ad461d14596326ff7f2e8a97f77c0"></a><!-- doxytag: member="PlayerTCP::listeners" ref="a111ad461d14596326ff7f2e8a97f77c0" args="" -->
playertcp_listener *&nbsp;</td><td class="memItemRight" valign="bottom"><b>listeners</b></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a3a6d3a310d2853b9ba6b5b5f6551c97e"></a><!-- doxytag: member="PlayerTCP::listen_ufds" ref="a3a6d3a310d2853b9ba6b5b5f6551c97e" args="" -->
struct pollfd *&nbsp;</td><td class="memItemRight" valign="bottom"><b>listen_ufds</b></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a736ecb7bdc635002cce80ca57e3fcaa0"></a><!-- doxytag: member="PlayerTCP::clients_mutex" ref="a736ecb7bdc635002cce80ca57e3fcaa0" args="" -->
pthread_mutex_t&nbsp;</td><td class="memItemRight" valign="bottom"><b>clients_mutex</b></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ae137c63e9dbe6dbd8fc140d3ccf069ab"></a><!-- doxytag: member="PlayerTCP::size_clients" ref="ae137c63e9dbe6dbd8fc140d3ccf069ab" args="" -->
int&nbsp;</td><td class="memItemRight" valign="bottom"><b>size_clients</b></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a738b1ffe08cde27feb82fe8c34f6025f"></a><!-- doxytag: member="PlayerTCP::num_clients" ref="a738b1ffe08cde27feb82fe8c34f6025f" args="" -->
int&nbsp;</td><td class="memItemRight" valign="bottom"><b>num_clients</b></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a3be423af917498299e5a70180658a662"></a><!-- doxytag: member="PlayerTCP::clients" ref="a3be423af917498299e5a70180658a662" args="" -->
playertcp_conn *&nbsp;</td><td class="memItemRight" valign="bottom"><b>clients</b></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a78d8ebcd0be3d02f6d35a9d4d8bf98a4"></a><!-- doxytag: member="PlayerTCP::client_ufds" ref="a78d8ebcd0be3d02f6d35a9d4d8bf98a4" args="" -->
struct pollfd *&nbsp;</td><td class="memItemRight" valign="bottom"><b>client_ufds</b></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a4f3e1f11c6fc0b1bac1a26850fae9c30"></a><!-- doxytag: member="PlayerTCP::decode_readbuffer" ref="a4f3e1f11c6fc0b1bac1a26850fae9c30" args="" -->
char *&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classPlayerTCP.html#a4f3e1f11c6fc0b1bac1a26850fae9c30">decode_readbuffer</a></td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Buffer in which to store decoded incoming messages. <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ab89c250563e959c2f109185bb53d8248"></a><!-- doxytag: member="PlayerTCP::decode_readbuffersize" ref="ab89c250563e959c2f109185bb53d8248" args="" -->
int&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classPlayerTCP.html#ab89c250563e959c2f109185bb53d8248">decode_readbuffersize</a></td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Total size of <code>decode_readbuffer</code>. <br/></td></tr>
</table>
<hr/>The documentation for this class was generated from the following file:<ul>
<li><a class="el" href="playertcp_8h_source.html">playertcp.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