<!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="#pub-attribs">Public Attributes</a> </div>
<div class="headertitle">
<h1>player_add_replace_rule_req Struct Reference</h1> </div>
</div>
<div class="contents">
<!-- doxytag: class="player_add_replace_rule_req" -->
<p>Configuration request: Add client queue replace rule.
<a href="#_details">More...</a></p>
<p><code>#include <<a class="el" href="player__interfaces_8h_source.html">player_interfaces.h</a>></code></p>
<p><a href="structplayer__add__replace__rule__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="a87b5a86997afa20a41941ff3ca77dc59"></a><!-- doxytag: member="player_add_replace_rule_req::interf" ref="a87b5a86997afa20a41941ff3ca77dc59" args="" -->
int32_t </td><td class="memItemRight" valign="bottom"><a class="el" href="structplayer__add__replace__rule__req.html#a87b5a86997afa20a41941ff3ca77dc59">interf</a></td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Interface to set replace rule for (-1 for wildcard). <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a8d6b38ee88a7c6730c757797b5850ded"></a><!-- doxytag: member="player_add_replace_rule_req::index" ref="a8d6b38ee88a7c6730c757797b5850ded" args="" -->
int32_t </td><td class="memItemRight" valign="bottom"><a class="el" href="structplayer__add__replace__rule__req.html#a8d6b38ee88a7c6730c757797b5850ded">index</a></td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">index to set replace rule for (-1 for wildcard) <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">int32_t </td><td class="memItemRight" valign="bottom"><a class="el" href="structplayer__add__replace__rule__req.html#a995bd358601e7139eb5ea29b910322c5">type</a></td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">message type to set replace rule for (-1 for wildcard), i.e. <a href="#a995bd358601e7139eb5ea29b910322c5"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a31483b6c474c3356523c66919bcfb671"></a><!-- doxytag: member="player_add_replace_rule_req::subtype" ref="a31483b6c474c3356523c66919bcfb671" args="" -->
int32_t </td><td class="memItemRight" valign="bottom"><a class="el" href="structplayer__add__replace__rule__req.html#a31483b6c474c3356523c66919bcfb671">subtype</a></td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">message subtype to set replace rule for (-1 for wildcard) <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a8f48e97edd87d5afa8e9d7a54972dd02"></a><!-- doxytag: member="player_add_replace_rule_req::replace" ref="a8f48e97edd87d5afa8e9d7a54972dd02" args="" -->
int32_t </td><td class="memItemRight" valign="bottom"><a class="el" href="structplayer__add__replace__rule__req.html#a8f48e97edd87d5afa8e9d7a54972dd02">replace</a></td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Should we replace these messages. <br/></td></tr>
</table>
<hr/><a name="_details"></a><h2>Detailed Description</h2>
<p>Configuration request: Add client queue replace rule. </p>
<p>Allows the client to add a replace rule to their server queue. Replace rules define which messages will be replaced when new data arrives. If you are not updating frequently from ther server then the use of replace rules for data packets will stop any queue overflow messages</p>
<p>Each field in the request type corresponds to the equivalent field in the message header use -1 for a dont care value. </p>
<hr/><h2>Member Data Documentation</h2>
<a class="anchor" id="a995bd358601e7139eb5ea29b910322c5"></a><!-- doxytag: member="player_add_replace_rule_req::type" ref="a995bd358601e7139eb5ea29b910322c5" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int32_t <a class="el" href="structplayer__add__replace__rule__req.html#a995bd358601e7139eb5ea29b910322c5">player_add_replace_rule_req::type</a></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>message type to set replace rule for (-1 for wildcard), i.e. </p>
<p>PLAYER_MSGTYPE_DATA </p>
</div>
</div>
<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>
