<!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="#nested-classes">Classes</a> | <a href="#func-members">Functions</a> </div> <div class="headertitle"> <h1>opaque<br/> <small> [<a class="el" href="group__playerc__proxies.html">Device proxies</a>]</small> </h1> </div> </div> <div class="contents"> <p>The opaque proxy provides an interface for generic messages to drivers. <a href="#_details">More...</a></p> <table class="memberdecls"> <tr><td colspan="2"><h2><a name="nested-classes"></a> Classes</h2></td></tr> <tr><td class="memItemLeft" align="right" valign="top">struct </td><td class="memItemRight" valign="bottom"><a class="el" href="structplayerc__opaque__t.html">playerc_opaque_t</a></td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">Opaque device data. <a href="structplayerc__opaque__t.html#_details">More...</a><br/></td></tr> <tr><td colspan="2"><h2><a name="func-members"></a> Functions</h2></td></tr> <tr><td class="memItemLeft" align="right" valign="top">PLAYERC_EXPORT <a class="el" href="structplayerc__opaque__t.html">playerc_opaque_t</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="group__playerc__proxy__opaque.html#ga149b1617d2934dd8e09ff17651865f97">playerc_opaque_create</a> (<a class="el" href="struct__playerc__client__t.html">playerc_client_t</a> *client, int index)</td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">Create an opaque device proxy. <a href="#ga149b1617d2934dd8e09ff17651865f97"></a><br/></td></tr> <tr><td class="memItemLeft" align="right" valign="top">PLAYERC_EXPORT void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__playerc__proxy__opaque.html#ga8fa12864eaade5c7d4005a5ca64e241b">playerc_opaque_destroy</a> (<a class="el" href="structplayerc__opaque__t.html">playerc_opaque_t</a> *device)</td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">Destroy an opaque device proxy. <a href="#ga8fa12864eaade5c7d4005a5ca64e241b"></a><br/></td></tr> <tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ga094081dc0446517302f04d7f35a88ed1"></a><!-- doxytag: member="playerc_proxy_opaque::playerc_opaque_subscribe" ref="ga094081dc0446517302f04d7f35a88ed1" args="(playerc_opaque_t *device, int access)" --> PLAYERC_EXPORT int </td><td class="memItemRight" valign="bottom"><a class="el" href="group__playerc__proxy__opaque.html#ga094081dc0446517302f04d7f35a88ed1">playerc_opaque_subscribe</a> (<a class="el" href="structplayerc__opaque__t.html">playerc_opaque_t</a> *device, int access)</td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">Subscribe to the opaque device. <br/></td></tr> <tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ga94d68d7e208f166f76a2dfb9108f856c"></a><!-- doxytag: member="playerc_proxy_opaque::playerc_opaque_unsubscribe" ref="ga94d68d7e208f166f76a2dfb9108f856c" args="(playerc_opaque_t *device)" --> PLAYERC_EXPORT int </td><td class="memItemRight" valign="bottom"><a class="el" href="group__playerc__proxy__opaque.html#ga94d68d7e208f166f76a2dfb9108f856c">playerc_opaque_unsubscribe</a> (<a class="el" href="structplayerc__opaque__t.html">playerc_opaque_t</a> *device)</td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">Un-subscribe from the opaque device. <br/></td></tr> <tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ga3051a1c763e962bca93a0446f9f0ddab"></a><!-- doxytag: member="playerc_proxy_opaque::playerc_opaque_cmd" ref="ga3051a1c763e962bca93a0446f9f0ddab" args="(playerc_opaque_t *device, player_opaque_data_t *data)" --> PLAYERC_EXPORT int </td><td class="memItemRight" valign="bottom"><a class="el" href="group__playerc__proxy__opaque.html#ga3051a1c763e962bca93a0446f9f0ddab">playerc_opaque_cmd</a> (<a class="el" href="structplayerc__opaque__t.html">playerc_opaque_t</a> *device, <a class="el" href="structplayer__opaque__data.html">player_opaque_data_t</a> *data)</td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">Send a generic command. <br/></td></tr> <tr><td class="memItemLeft" align="right" valign="top">PLAYERC_EXPORT int </td><td class="memItemRight" valign="bottom"><a class="el" href="group__playerc__proxy__opaque.html#ga536ef6cfbba398936946b25f622b8c82">playerc_opaque_req</a> (<a class="el" href="structplayerc__opaque__t.html">playerc_opaque_t</a> *device, <a class="el" href="structplayer__opaque__data.html">player_opaque_data_t</a> *request, <a class="el" href="structplayer__opaque__data.html">player_opaque_data_t</a> **reply)</td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">Send a generic request. <a href="#ga536ef6cfbba398936946b25f622b8c82"></a><br/></td></tr> </table> <hr/><a name="_details"></a><h2>Detailed Description</h2> <p>The opaque proxy provides an interface for generic messages to drivers. </p> <p>See examples/plugins/opaquedriver for an example of using this interface in combination with a custom plugin. </p> <hr/><h2>Function Documentation</h2> <a class="anchor" id="ga149b1617d2934dd8e09ff17651865f97"></a><!-- doxytag: member="playerc.h::playerc_opaque_create" ref="ga149b1617d2934dd8e09ff17651865f97" args="(playerc_client_t *client, int index)" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">PLAYERC_EXPORT <a class="el" href="structplayerc__opaque__t.html">playerc_opaque_t</a>* playerc_opaque_create </td> <td>(</td> <td class="paramtype"><a class="el" href="struct__playerc__client__t.html">playerc_client_t</a> * </td> <td class="paramname"> <em>client</em>, </td> </tr> <tr> <td class="paramkey"></td> <td></td> <td class="paramtype">int </td> <td class="paramname"> <em>index</em></td><td> </td> </tr> <tr> <td></td> <td>)</td> <td></td><td></td><td></td> </tr> </table> </div> <div class="memdoc"> <p>Create an opaque device proxy. </p> </div> </div> <a class="anchor" id="ga8fa12864eaade5c7d4005a5ca64e241b"></a><!-- doxytag: member="playerc.h::playerc_opaque_destroy" ref="ga8fa12864eaade5c7d4005a5ca64e241b" args="(playerc_opaque_t *device)" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">PLAYERC_EXPORT void playerc_opaque_destroy </td> <td>(</td> <td class="paramtype"><a class="el" href="structplayerc__opaque__t.html">playerc_opaque_t</a> * </td> <td class="paramname"> <em>device</em></td> <td> ) </td> <td></td> </tr> </table> </div> <div class="memdoc"> <p>Destroy an opaque device proxy. </p> </div> </div> <a class="anchor" id="ga536ef6cfbba398936946b25f622b8c82"></a><!-- doxytag: member="playerc.h::playerc_opaque_req" ref="ga536ef6cfbba398936946b25f622b8c82" args="(playerc_opaque_t *device, player_opaque_data_t *request, player_opaque_data_t **reply)" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">PLAYERC_EXPORT int playerc_opaque_req </td> <td>(</td> <td class="paramtype"><a class="el" href="structplayerc__opaque__t.html">playerc_opaque_t</a> * </td> <td class="paramname"> <em>device</em>, </td> </tr> <tr> <td class="paramkey"></td> <td></td> <td class="paramtype"><a class="el" href="structplayer__opaque__data.html">player_opaque_data_t</a> * </td> <td class="paramname"> <em>request</em>, </td> </tr> <tr> <td class="paramkey"></td> <td></td> <td class="paramtype"><a class="el" href="structplayer__opaque__data.html">player_opaque_data_t</a> ** </td> <td class="paramname"> <em>reply</em></td><td> </td> </tr> <tr> <td></td> <td>)</td> <td></td><td></td><td></td> </tr> </table> </div> <div class="memdoc"> <p>Send a generic request. </p> <p>If a non null value is passed for reply memory for the response will be allocated and its pointer stored in reply. The caller is responsible for freeing this memory</p> <p>If an error is returned no memory will have been allocated </p> </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>