<!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 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 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="#groups">Modules</a> | <a href="#define-members">Defines</a> </div> <div class="headertitle"> <h1>libplayerc<br/> <small> [<a class="el" href="group__clientlibs.html">Client Libraries</a>]</small> </h1> </div> </div> <div class="contents"> <p>A C client library for the <a class="el" href="group__util__player.html">player server</a>. <a href="#_details">More...</a></p> <table class="memberdecls"> <tr><td colspan="2"><h2><a name="groups"></a> Modules</h2></td></tr> <tr><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="group__libplayerc__example.html">libplayerc example</a></td></tr> <p><tr><td class="mdescLeft"> </td><td class="mdescRight"><p>An example. </p> <br/></td></tr> </p> <tr><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="group__playerc__utility.html">Utility and error-handling</a></td></tr> <p><tr><td class="mdescLeft"> </td><td class="mdescRight"><p>Some helper functions. </p> <br/></td></tr> </p> <tr><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="group__multiclient.html">Multi-Client object</a></td></tr> <p><tr><td class="mdescLeft"> </td><td class="mdescRight"><p>The multi-client object manages connections to multiple server in parallel. </p> <br/></td></tr> </p> <tr><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="group__playerc__client.html">Client API</a></td></tr> <p><tr><td class="mdescLeft"> </td><td class="mdescRight"><p>The client object manages the connection with the Player server; it is responsible for reading new data, setting data transmission modes and so on. </p> <br/></td></tr> </p> <tr><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="group__playerc__device.html">Device API</a></td></tr> <p><tr><td class="mdescLeft"> </td><td class="mdescRight"><p>The device object provides a common interface to the functionality that is shared by all device proxies (in OOP parlance, it is a base class). </p> <br/></td></tr> </p> <tr><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="group__playerc__proxies.html">Device proxies</a></td></tr> <p><tr><td class="mdescLeft"> </td><td class="mdescRight"><p>Each interface has a corresponding proxy. </p> <br/></td></tr> </p> <tr><td colspan="2"><h2><a name="define-members"></a> Defines</h2></td></tr> <tr><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__player__clientlib__libplayerc.html#ga3acffbd305ee72dcd4593c0d8af64a4f">MIN</a>(a, b) ((a < b) ? a : b)</td></tr> <tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="gafa99ec4acc4ecb2dc3c2d05da15d0e3f"></a><!-- doxytag: member="player_clientlib_libplayerc::MAX" ref="gafa99ec4acc4ecb2dc3c2d05da15d0e3f" args="(a, b)" --> #define </td><td class="memItemRight" valign="bottom"><b>MAX</b>(a, b) ((a > b) ? a : b)</td></tr> <tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="gaa678ae6167b9c431bbfbdf5d8b7edf79"></a><!-- doxytag: member="player_clientlib_libplayerc::PLAYERC_EXPORT" ref="gaa678ae6167b9c431bbfbdf5d8b7edf79" args="" --> #define </td><td class="memItemRight" valign="bottom"><b>PLAYERC_EXPORT</b></td></tr> <tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ga168094c1cbbf233f963f36ae2aaaec42"></a><!-- doxytag: member="player_clientlib_libplayerc::PLAYERC_OPEN_MODE" ref="ga168094c1cbbf233f963f36ae2aaaec42" args="" --> #define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__player__clientlib__libplayerc.html#ga168094c1cbbf233f963f36ae2aaaec42">PLAYERC_OPEN_MODE</a> PLAYER_OPEN_MODE</td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">The device access modes. <br/></td></tr> <tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ga092902b71cad975c4d589ce98a87026e"></a><!-- doxytag: member="player_clientlib_libplayerc::PLAYERC_CLOSE_MODE" ref="ga092902b71cad975c4d589ce98a87026e" args="" --> #define </td><td class="memItemRight" valign="bottom"><b>PLAYERC_CLOSE_MODE</b> PLAYER_CLOSE_MODE</td></tr> <tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ga10e4284bbb9be62cf60e4cd0ffe4f774"></a><!-- doxytag: member="player_clientlib_libplayerc::PLAYERC_ERROR_MODE" ref="ga10e4284bbb9be62cf60e4cd0ffe4f774" args="" --> #define </td><td class="memItemRight" valign="bottom"><b>PLAYERC_ERROR_MODE</b> PLAYER_ERROR_MODE</td></tr> <tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ga64b35ff9440be6f874c24915b17ec871"></a><!-- doxytag: member="player_clientlib_libplayerc::PLAYERC_DATAMODE_PUSH" ref="ga64b35ff9440be6f874c24915b17ec871" args="" --> #define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__player__clientlib__libplayerc.html#ga64b35ff9440be6f874c24915b17ec871">PLAYERC_DATAMODE_PUSH</a> PLAYER_DATAMODE_PUSH</td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">The valid data delivery modes. <br/></td></tr> <tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="gaf4186384a3bb2fddc61327c20682a6e4"></a><!-- doxytag: member="player_clientlib_libplayerc::PLAYERC_DATAMODE_PULL" ref="gaf4186384a3bb2fddc61327c20682a6e4" args="" --> #define </td><td class="memItemRight" valign="bottom"><b>PLAYERC_DATAMODE_PULL</b> PLAYER_DATAMODE_PULL</td></tr> <tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="gae8f3ab5c538dae89d783bd2b56c7c4c9"></a><!-- doxytag: member="player_clientlib_libplayerc::PLAYERC_TRANSPORT_TCP" ref="gae8f3ab5c538dae89d783bd2b56c7c4c9" args="" --> #define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__player__clientlib__libplayerc.html#gae8f3ab5c538dae89d783bd2b56c7c4c9">PLAYERC_TRANSPORT_TCP</a> 1</td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">The valid transports. <br/></td></tr> <tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ga5fcd07411e6b068599c103d975f5c7c1"></a><!-- doxytag: member="player_clientlib_libplayerc::PLAYERC_TRANSPORT_UDP" ref="ga5fcd07411e6b068599c103d975f5c7c1" args="" --> #define </td><td class="memItemRight" valign="bottom"><b>PLAYERC_TRANSPORT_UDP</b> 2</td></tr> <tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="gaeda32681ef7854dffb0d119adff1bae2"></a><!-- doxytag: member="player_clientlib_libplayerc::PLAYERC_QUEUE_RING_SIZE" ref="gaeda32681ef7854dffb0d119adff1bae2" args="" --> #define </td><td class="memItemRight" valign="bottom"><b>PLAYERC_QUEUE_RING_SIZE</b> 512</td></tr> </table> <hr/><a name="_details"></a><h2>Detailed Description</h2> <p>A C client library for the <a class="el" href="group__util__player.html">player server</a>. </p> <p>libplayerc is a client library for the <a class="el" href="group__util__player.html">player server</a>. It is written in C to maximize portability, and in the expectation that users will write bindings for other languages (such as Python and Java) against this library; <a class="el" href="group__player__clientlib__libplayerc__py.html">Python bindings</a> are already available.</p> <p>Be sure to check out the <a class="el" href="group__libplayerc__example.html">example</a>.</p> <p>The <a class="el" href="group__libplayerc__datamodes.html">data modes</a> section is important reading for all client writers.</p> <p>libplayerc was originally written by Andrew Howard and is maintained by the Player Project. Subsequent contributors include Brian Gerkey, Geoffrey Biggs, Richard Vaughan. </p> <hr/><h2>Define Documentation</h2> <a class="anchor" id="ga3acffbd305ee72dcd4593c0d8af64a4f"></a><!-- doxytag: member="playerc.h::MIN" ref="ga3acffbd305ee72dcd4593c0d8af64a4f" args="(a, b)" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">#define MIN</td> <td>(</td> <td class="paramtype"> </td> <td class="paramname">a, </td> </tr> <tr> <td class="paramkey"></td> <td></td> <td class="paramtype"> </td> <td class="paramname">b</td><td> </td> </tr> <tr> <td></td> <td>)</td> <td></td><td></td><td> ((a < b) ? a : b)</td> </tr> </table> </div> <div class="memdoc"> </div> </div> </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>