<!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="headertitle">
<h1>playertcp.h</h1> </div>
</div>
<div class="contents">
<div class="fragment"><pre class="fragment"><a name="l00001"></a>00001 <span class="comment">/*</span>
<a name="l00002"></a>00002 <span class="comment"> * Player - One Hell of a Robot Server</span>
<a name="l00003"></a>00003 <span class="comment"> * Copyright (C) 2005 -</span>
<a name="l00004"></a>00004 <span class="comment"> * Brian Gerkey</span>
<a name="l00005"></a>00005 <span class="comment"> *</span>
<a name="l00006"></a>00006 <span class="comment"> *</span>
<a name="l00007"></a>00007 <span class="comment"> * This program is free software; you can redistribute it and/or modify</span>
<a name="l00008"></a>00008 <span class="comment"> * it under the terms of the GNU General Public License as published by</span>
<a name="l00009"></a>00009 <span class="comment"> * the Free Software Foundation; either version 2 of the License, or</span>
<a name="l00010"></a>00010 <span class="comment"> * (at your option) any later version.</span>
<a name="l00011"></a>00011 <span class="comment"> *</span>
<a name="l00012"></a>00012 <span class="comment"> * This program is distributed in the hope that it will be useful,</span>
<a name="l00013"></a>00013 <span class="comment"> * but WITHOUT ANY WARRANTY; without even the implied warranty of</span>
<a name="l00014"></a>00014 <span class="comment"> * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the</span>
<a name="l00015"></a>00015 <span class="comment"> * GNU General Public License for more details.</span>
<a name="l00016"></a>00016 <span class="comment"> *</span>
<a name="l00017"></a>00017 <span class="comment"> * You should have received a copy of the GNU General Public License</span>
<a name="l00018"></a>00018 <span class="comment"> * along with this program; if not, write to the Free Software</span>
<a name="l00019"></a>00019 <span class="comment"> * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA</span>
<a name="l00020"></a>00020 <span class="comment"> *</span>
<a name="l00021"></a>00021 <span class="comment"> */</span>
<a name="l00022"></a>00022 <span class="comment">/********************************************************************</span>
<a name="l00023"></a>00023 <span class="comment"> *</span>
<a name="l00024"></a>00024 <span class="comment"> * This library is free software; you can redistribute it and/or</span>
<a name="l00025"></a>00025 <span class="comment"> * modify it under the terms of the GNU Lesser General Public</span>
<a name="l00026"></a>00026 <span class="comment"> * License as published by the Free Software Foundation; either</span>
<a name="l00027"></a>00027 <span class="comment"> * version 2.1 of the License, or (at your option) any later version.</span>
<a name="l00028"></a>00028 <span class="comment"> *</span>
<a name="l00029"></a>00029 <span class="comment"> * This library is distributed in the hope that it will be useful,</span>
<a name="l00030"></a>00030 <span class="comment"> * but WITHOUT ANY WARRANTY; without even the implied warranty of</span>
<a name="l00031"></a>00031 <span class="comment"> * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU</span>
<a name="l00032"></a>00032 <span class="comment"> * Lesser General Public License for more details.</span>
<a name="l00033"></a>00033 <span class="comment"> *</span>
<a name="l00034"></a>00034 <span class="comment"> * You should have received a copy of the GNU Lesser General Public</span>
<a name="l00035"></a>00035 <span class="comment"> * License along with this library; if not, write to the Free Software</span>
<a name="l00036"></a>00036 <span class="comment"> * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA</span>
<a name="l00037"></a>00037 <span class="comment"> *</span>
<a name="l00038"></a>00038 <span class="comment"> ********************************************************************/</span>
<a name="l00039"></a>00039
<a name="l00040"></a>00040 <span class="comment">/*</span>
<a name="l00041"></a>00041 <span class="comment"> * Interface to libplayertcp</span>
<a name="l00042"></a>00042 <span class="comment"> *</span>
<a name="l00043"></a>00043 <span class="comment"> * $Id: playertcp.h 7878 2009-06-23 11:14:00Z thjc $</span>
<a name="l00044"></a>00044 <span class="comment"> */</span>
<a name="l00045"></a>00045
<a name="l00093"></a>00093 <span class="preprocessor">#ifndef _PLAYERTCP_H_</span>
<a name="l00094"></a>00094 <span class="preprocessor"></span><span class="preprocessor">#define _PLAYERTCP_H_</span>
<a name="l00095"></a>00095 <span class="preprocessor"></span>
<a name="l00096"></a>00096 <span class="preprocessor">#if defined (WIN32)</span>
<a name="l00097"></a>00097 <span class="preprocessor"></span><span class="preprocessor"> #if defined (PLAYER_STATIC)</span>
<a name="l00098"></a>00098 <span class="preprocessor"></span><span class="preprocessor"> #define PLAYERTCP_EXPORT</span>
<a name="l00099"></a>00099 <span class="preprocessor"></span><span class="preprocessor"> #elif defined (playertcp_EXPORTS)</span>
<a name="l00100"></a>00100 <span class="preprocessor"></span><span class="preprocessor"> #define PLAYERTCP_EXPORT __declspec (dllexport)</span>
<a name="l00101"></a>00101 <span class="preprocessor"></span><span class="preprocessor"> #else</span>
<a name="l00102"></a>00102 <span class="preprocessor"></span><span class="preprocessor"> #define PLAYERTCP_EXPORT __declspec (dllimport)</span>
<a name="l00103"></a>00103 <span class="preprocessor"></span><span class="preprocessor"> #endif</span>
<a name="l00104"></a>00104 <span class="preprocessor"></span><span class="preprocessor">#else</span>
<a name="l00105"></a><a class="code" href="group__libplayertcp.html#ga0b8f1e24c88d94a636b23e19d2f89dfb">00105</a> <span class="preprocessor"></span><span class="preprocessor"> #define PLAYERTCP_EXPORT</span>
<a name="l00106"></a>00106 <span class="preprocessor"></span><span class="preprocessor">#endif</span>
<a name="l00107"></a>00107 <span class="preprocessor"></span>
<a name="l00108"></a>00108 <span class="preprocessor">#if defined (WIN32)</span>
<a name="l00109"></a>00109 <span class="preprocessor"></span><span class="preprocessor"> #include <winsock2.h></span>
<a name="l00110"></a>00110 <span class="preprocessor"> #include <ws2tcpip.h></span>
<a name="l00111"></a>00111 <span class="preprocessor">#else</span>
<a name="l00112"></a>00112 <span class="preprocessor"></span><span class="preprocessor"> #include <sys/socket.h></span>
<a name="l00113"></a>00113 <span class="preprocessor"> #include <sys/ioctl.h></span>
<a name="l00114"></a>00114 <span class="preprocessor"> #include <netdb.h></span>
<a name="l00115"></a>00115 <span class="preprocessor"> #include <netinet/in.h></span>
<a name="l00116"></a>00116 <span class="preprocessor">#endif</span>
<a name="l00117"></a>00117 <span class="preprocessor"></span><span class="preprocessor">#include <sys/types.h></span>
<a name="l00118"></a>00118 <span class="preprocessor">#include <pthread.h></span>
<a name="l00119"></a>00119
<a name="l00120"></a>00120 <span class="preprocessor">#include <libplayercore/playercore.h></span>
<a name="l00121"></a>00121
<a name="l00123"></a><a class="code" href="group__libplayertcp.html#gad17dc747d07c14be2cc95969031fe2ed">00123</a> <span class="preprocessor">#define PLAYERTCP_DEFAULT_PORT 6665</span>
<a name="l00124"></a>00124 <span class="preprocessor"></span>
<a name="l00127"></a><a class="code" href="group__libplayertcp.html#gab1d9776d83146f1a598dfd47fee044dc">00127</a> <span class="preprocessor">#define PLAYERTCP_READBUFFER_SIZE 65536</span>
<a name="l00128"></a>00128 <span class="preprocessor"></span>
<a name="l00131"></a><a class="code" href="group__libplayertcp.html#ga091e4697561ad9aaf65f31591cf071a7">00131</a> <span class="preprocessor">#define PLAYERTCP_WRITEBUFFER_SIZE 65536</span>
<a name="l00132"></a>00132 <span class="preprocessor"></span>
<a name="l00133"></a>00133 <span class="comment">// Forward declarations</span>
<a name="l00134"></a>00134 <span class="keyword">struct </span>pollfd;
<a name="l00135"></a>00135
<a name="l00136"></a>00136 <span class="keyword">struct </span>playertcp_listener;
<a name="l00137"></a>00137 <span class="keyword">struct </span>playertcp_conn;
<a name="l00138"></a>00138
<a name="l00139"></a><a class="code" href="classPlayerTCP.html">00139</a> <span class="keyword">class </span><a class="code" href="group__libplayertcp.html#ga0b8f1e24c88d94a636b23e19d2f89dfb" title="Default TCP port.">PLAYERTCP_EXPORT</a> <a class="code" href="classPlayerTCP.html">PlayerTCP</a>
<a name="l00140"></a>00140 {
<a name="l00141"></a>00141 <span class="keyword">private</span>:
<a name="l00142"></a>00142 uint32_t host;
<a name="l00143"></a>00143 <span class="keywordtype">int</span> num_listeners;
<a name="l00144"></a>00144 playertcp_listener* listeners;
<a name="l00145"></a>00145 <span class="keyword">struct </span>pollfd* listen_ufds;
<a name="l00146"></a>00146
<a name="l00147"></a>00147 pthread_mutex_t clients_mutex;
<a name="l00148"></a>00148 <span class="keywordtype">int</span> size_clients;
<a name="l00149"></a>00149 <span class="keywordtype">int</span> num_clients;
<a name="l00150"></a>00150 playertcp_conn* clients;
<a name="l00151"></a>00151 <span class="keyword">struct </span>pollfd* client_ufds;
<a name="l00152"></a>00152
<a name="l00154"></a><a class="code" href="classPlayerTCP.html#a4f3e1f11c6fc0b1bac1a26850fae9c30">00154</a> <span class="keywordtype">char</span>* decode_readbuffer;
<a name="l00156"></a><a class="code" href="classPlayerTCP.html#ab89c250563e959c2f109185bb53d8248">00156</a> <span class="keywordtype">int</span> decode_readbuffersize;
<a name="l00157"></a>00157
<a name="l00158"></a>00158 <span class="keyword">public</span>:
<a name="l00159"></a>00159 <a class="code" href="classPlayerTCP.html">PlayerTCP</a>();
<a name="l00160"></a>00160 ~<a class="code" href="classPlayerTCP.html">PlayerTCP</a>();
<a name="l00161"></a>00161
<a name="l00162"></a>00162 <span class="keywordtype">void</span> Lock();
<a name="l00163"></a>00163 <span class="keywordtype">void</span> Unlock();
<a name="l00164"></a>00164
<a name="l00165"></a>00165 <span class="keyword">static</span> <span class="keywordtype">void</span> InitGlobals(<span class="keywordtype">void</span>);
<a name="l00166"></a>00166
<a name="l00167"></a>00167 pthread_t thread;
<a name="l00168"></a>00168
<a name="l00169"></a>00169 <span class="keywordtype">int</span> Listen(<span class="keywordtype">int</span>* ports, <span class="keywordtype">int</span> num_ports, <span class="keywordtype">int</span>* new_ports=NULL);
<a name="l00170"></a>00170 <span class="keywordtype">int</span> Listen(<span class="keywordtype">int</span> port);
<a name="l00171"></a>00171 <a class="code" href="classQueuePointer.html" title="An autopointer for the message queue.">QueuePointer</a> AddClient(<span class="keyword">struct</span> sockaddr_in* cliaddr,
<a name="l00172"></a>00172 <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> local_host,
<a name="l00173"></a>00173 <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> local_port,
<a name="l00174"></a>00174 <span class="keywordtype">int</span> newsock,
<a name="l00175"></a>00175 <span class="keywordtype">bool</span> send_banner,
<a name="l00176"></a>00176 <span class="keywordtype">int</span>* kill_flag,
<a name="l00177"></a>00177 <span class="keywordtype">bool</span> have_lock);
<a name="l00178"></a>00178 <a class="code" href="classQueuePointer.html" title="An autopointer for the message queue.">QueuePointer</a> AddClient(<span class="keyword">struct</span> sockaddr_in* cliaddr,
<a name="l00179"></a>00179 <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> local_host,
<a name="l00180"></a>00180 <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> local_port,
<a name="l00181"></a>00181 <span class="keywordtype">int</span> newsock,
<a name="l00182"></a>00182 <span class="keywordtype">bool</span> send_banner,
<a name="l00183"></a>00183 <span class="keywordtype">int</span>* kill_flag,
<a name="l00184"></a>00184 <span class="keywordtype">bool</span> have_lock,
<a name="l00185"></a>00185 <a class="code" href="classQueuePointer.html" title="An autopointer for the message queue.">QueuePointer</a> queue);
<a name="l00186"></a>00186 <span class="keywordtype">int</span> Update(<span class="keywordtype">int</span> timeout);
<a name="l00187"></a>00187 <span class="keywordtype">int</span> Accept(<span class="keywordtype">int</span> timeout);
<a name="l00188"></a>00188 <span class="keywordtype">void</span> Close(<span class="keywordtype">int</span> cli);
<a name="l00189"></a>00189 <span class="keywordtype">int</span> ReadClient(<span class="keywordtype">int</span> cli);
<a name="l00190"></a>00190 <span class="keywordtype">int</span> ReadClient(<a class="code" href="classQueuePointer.html" title="An autopointer for the message queue.">QueuePointer</a> q);
<a name="l00191"></a>00191 <span class="keywordtype">int</span> Read(<span class="keywordtype">int</span> timeout, <span class="keywordtype">bool</span> have_lock);
<a name="l00192"></a>00192 <span class="keywordtype">int</span> Write(<span class="keywordtype">bool</span> have_lock);
<a name="l00193"></a>00193 <span class="keywordtype">int</span> WriteClient(<span class="keywordtype">int</span> cli);
<a name="l00194"></a>00194 <span class="keywordtype">void</span> DeleteClients();
<a name="l00195"></a>00195 <span class="keywordtype">void</span> ParseBuffer(<span class="keywordtype">int</span> cli);
<a name="l00196"></a>00196 <span class="keywordtype">int</span> HandlePlayerMessage(<span class="keywordtype">int</span> cli, <a class="code" href="classMessage.html" title="Reference-counted message objects.">Message</a>* msg);
<a name="l00197"></a>00197 <span class="keywordtype">void</span> DeleteClient(<a class="code" href="classQueuePointer.html" title="An autopointer for the message queue.">QueuePointer</a> &q, <span class="keywordtype">bool</span> have_lock);
<a name="l00198"></a>00198 <span class="keywordtype">bool</span> Listening(<span class="keywordtype">int</span> port);
<a name="l00199"></a>00199 uint32_t GetHost() {<span class="keywordflow">return</span> host;};
<a name="l00200"></a>00200 };
<a name="l00201"></a>00201
<a name="l00204"></a>00204 <span class="preprocessor">#endif</span>
</pre></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>
distrib
>
Fedora
>
14
>
x86_64
>
media
>
updates
>
by-pkgid
>
727fa15453fcace956b835e2377d4269
>
files
>
894
