Sophie

Sophie

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

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-attribs">Public Attributes</a>  </div>
  <div class="headertitle">
<h1>player_device_req Struct Reference</h1>  </div>
</div>
<div class="contents">
<!-- doxytag: class="player_device_req" -->
<p>Request/reply: (un)subscribe to a device.  
<a href="#_details">More...</a></p>

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

<p><a href="structplayer__device__req-members.html">List of all members.</a></p>
<table class="memberdecls">
<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="a5c5633c672c94f36504d1064fc66920a"></a><!-- doxytag: member="player_device_req::addr" ref="a5c5633c672c94f36504d1064fc66920a" args="" -->
<a class="el" href="structplayer__devaddr.html">player_devaddr_t</a>&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="structplayer__device__req.html#a5c5633c672c94f36504d1064fc66920a">addr</a></td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Address of the device. <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a38c607aebd06484f66fbaa1ba7d3fa20"></a><!-- doxytag: member="player_device_req::access" ref="a38c607aebd06484f66fbaa1ba7d3fa20" args="" -->
uint8_t&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="structplayer__device__req.html#a38c607aebd06484f66fbaa1ba7d3fa20">access</a></td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">The requested / granted access. <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a5d0e7c10004afc1944f7c5992538f768"></a><!-- doxytag: member="player_device_req::driver_name_count" ref="a5d0e7c10004afc1944f7c5992538f768" args="" -->
uint32_t&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="structplayer__device__req.html#a5d0e7c10004afc1944f7c5992538f768">driver_name_count</a></td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Length of driver name. <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a6cace8f9cc1e058a0bc84f4ee6674a06"></a><!-- doxytag: member="player_device_req::driver_name" ref="a6cace8f9cc1e058a0bc84f4ee6674a06" args="[PLAYER_MAX_DRIVER_STRING_LEN]" -->
char&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="structplayer__device__req.html#a6cace8f9cc1e058a0bc84f4ee6674a06">driver_name</a> [PLAYER_MAX_DRIVER_STRING_LEN]</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">The name of the underlying driver. <br/></td></tr>
</table>
<hr/><a name="_details"></a><h2>Detailed Description</h2>
<p>Request/reply: (un)subscribe to a device. </p>
<p>This is the most important request! Before interacting with a device, the client must request appropriate access. Valid access modes are:</p>
<ul>
<li><a class="el" href="group__interface__player.html#ga53dbb758d337a2b6db5fe57dbdba0ea0">PLAYER_OPEN_MODE</a> : subscribe to the device. You will receive any data published by the device and you may send it commands and/or requests.</li>
<li><a class="el" href="group__interface__player.html#gaef871c2315ff593a408e2fb2e496299e">PLAYER_CLOSE_MODE</a> : unsubscribe from the device.</li>
<li><a class="el" href="group__interface__player.html#ga4081785d3f99061bf6bf67fb761dae71">PLAYER_ERROR_MODE</a> : the requested access was not granted (only appears in responses)</li>
</ul>
<p>To request access, send a <a class="el" href="group__interface__player.html#gad1d7a7cc87b5b00b56f62c0a9b8e513c">PLAYER_PLAYER_REQ_DEV</a> request that specifies the desired device address in the addr field and the desired access mode in access. Set driver_name_count to 0 and leave driver_name empty. The response will indicate the granted access in the access field and the name of the underyling driver in the driver_name field. Note that the granted access may not be the same as the requested access (e.g., if initialization of the driver failed). </p>
<hr/>The documentation for this struct was generated from the following file:<ul>
<li><a class="el" href="player__interfaces_8h_source.html">player_interfaces.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