<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"> <html><head><meta http-equiv="Content-Type" content="text/html;charset=UTF-8"> <title>VTK: dox/Common/vtkSocket.h Source File</title> <link href="doxygen.css" rel="stylesheet" type="text/css"> <link href="tabs.css" rel="stylesheet" type="text/css"> </head><body> <!-- Generated by Doxygen 1.5.6 --> <div class="navigation" id="top"> <div class="tabs"> <ul> <li><a href="index.html"><span>Main Page</span></a></li> <li><a href="pages.html"><span>Related Pages</span></a></li> <li><a href="namespaces.html"><span>Namespaces</span></a></li> <li><a href="classes.html"><span>Classes</span></a></li> <li class="current"><a href="files.html"><span>Files</span></a></li> </ul> </div> <h1>dox/Common/vtkSocket.h</h1><a href="a02129.html">Go to the documentation of this file.</a><div class="fragment"><pre class="fragment"><a name="l00001"></a>00001 <span class="comment">/*=========================================================================</span> <a name="l00002"></a>00002 <span class="comment"></span> <a name="l00003"></a>00003 <span class="comment"> Program: Visualization Toolkit</span> <a name="l00004"></a>00004 <span class="comment"> Module: $RCSfile: vtkSocket.h,v $</span> <a name="l00005"></a>00005 <span class="comment"></span> <a name="l00006"></a>00006 <span class="comment"> Copyright (c) Ken Martin, Will Schroeder, Bill Lorensen</span> <a name="l00007"></a>00007 <span class="comment"> All rights reserved.</span> <a name="l00008"></a>00008 <span class="comment"> See Copyright.txt or http://www.kitware.com/Copyright.htm for details.</span> <a name="l00009"></a>00009 <span class="comment"></span> <a name="l00010"></a>00010 <span class="comment"> This software is distributed WITHOUT ANY WARRANTY; without even</span> <a name="l00011"></a>00011 <span class="comment"> the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR</span> <a name="l00012"></a>00012 <span class="comment"> PURPOSE. See the above copyright notice for more information.</span> <a name="l00013"></a>00013 <span class="comment"></span> <a name="l00014"></a>00014 <span class="comment">=========================================================================*/</span> <a name="l00022"></a>00022 <span class="preprocessor">#ifndef __vtkSocket_h</span> <a name="l00023"></a>00023 <span class="preprocessor"></span><span class="preprocessor">#define __vtkSocket_h</span> <a name="l00024"></a>00024 <span class="preprocessor"></span> <a name="l00025"></a>00025 <span class="preprocessor">#include "<a class="code" href="a02079.html">vtkObject.h</a>"</span> <a name="l00026"></a>00026 <a name="l00027"></a>00027 <span class="keyword">class </span><a class="code" href="a01569.html" title="a collection for sockets.">vtkSocketCollection</a>; <a name="l00028"></a><a class="code" href="a01568.html">00028</a> <span class="keyword">class </span><a class="code" href="a02170.html#873ca0b83d0838a1df577536068a1730">VTK_COMMON_EXPORT</a> <a class="code" href="a01568.html" title="BSD socket encapsulation.">vtkSocket</a> : <span class="keyword">public</span> <a class="code" href="a01084.html" title="abstract base class for most VTK objects">vtkObject</a> <a name="l00029"></a>00029 { <a name="l00030"></a>00030 <span class="keyword">public</span>: <a name="l00031"></a><a class="code" href="a01568.html#b7109f0c2bc39762da4dc9678398c486">00031</a> vtkTypeRevisionMacro(<a class="code" href="a01568.html" title="BSD socket encapsulation.">vtkSocket</a>, <a class="code" href="a01084.html" title="abstract base class for most VTK objects">vtkObject</a>); <a name="l00032"></a>00032 <span class="keywordtype">void</span> <a class="code" href="a01084.html#bf3dbb4154289b56a12483eee3866263">PrintSelf</a>(ostream& os, <a class="code" href="a00869.html" title="a simple class to control print indentation">vtkIndent</a> indent); <a name="l00033"></a>00033 <a name="l00034"></a>00034 <span class="comment">// ----- Status API ----</span> <a name="l00036"></a><a class="code" href="a01568.html#88ce9a9c047f7aea703e1e03b12664e8">00036</a> <span class="comment"></span> <span class="keywordtype">int</span> GetConnected() { <span class="keywordflow">return</span> (this->SocketDescriptor >=0); } <a name="l00037"></a>00037 <a name="l00039"></a><a class="code" href="a01568.html#1df485d17ebb3a9fdb391b9747fa9c4c">00039</a> <span class="keywordtype">void</span> CloseSocket() {this->CloseSocket(this->SocketDescriptor);} <a name="l00040"></a>00040 <a name="l00041"></a>00041 <span class="comment">// ------ Communication API ---</span> <a name="l00044"></a>00044 <span class="comment"></span> <span class="keywordtype">int</span> Send(<span class="keyword">const</span> <span class="keywordtype">void</span>* <a class="code" href="a03761.html#c6551f7bf833e8254b2b3ecdaea0d210eb708a412c0730a6b5f3215b36474a1e">data</a>, <span class="keywordtype">int</span> <a class="code" href="a03761.html#c6551f7bf833e8254b2b3ecdaea0d21042c5d76c3275f5d17bc1b329d83ab003">length</a>); <a name="l00045"></a>00045 <a name="l00051"></a>00051 <span class="keywordtype">int</span> Receive(<span class="keywordtype">void</span>* <a class="code" href="a03761.html#c6551f7bf833e8254b2b3ecdaea0d210eb708a412c0730a6b5f3215b36474a1e">data</a>, <span class="keywordtype">int</span> <a class="code" href="a03761.html#c6551f7bf833e8254b2b3ecdaea0d21042c5d76c3275f5d17bc1b329d83ab003">length</a>, <span class="keywordtype">int</span> readFully=1); <a name="l00052"></a>00052 <a name="l00053"></a>00053 <span class="keyword">protected</span>: <a name="l00054"></a>00054 <a class="code" href="a01568.html" title="BSD socket encapsulation.">vtkSocket</a>(); <a name="l00055"></a>00055 ~<a class="code" href="a01568.html" title="BSD socket encapsulation.">vtkSocket</a>(); <a name="l00056"></a>00056 <a name="l00057"></a><a class="code" href="a01568.html#dceba7003bb47a40082e2c5c0e69d157">00057</a> <span class="keywordtype">int</span> SocketDescriptor; <a name="l00058"></a><a class="code" href="a01568.html#4e3b82b42752248c8d22cf7842f683bf">00058</a> vtkGetMacro(SocketDescriptor, <span class="keywordtype">int</span>); <a name="l00059"></a>00059 <a name="l00060"></a>00060 <span class="comment">//BTX</span> <a name="l00061"></a>00061 <span class="keyword">friend</span> <span class="keyword">class </span><a class="code" href="a01569.html" title="a collection for sockets.">vtkSocketCollection</a>; <a name="l00062"></a>00062 <span class="comment">//ETX</span> <a name="l00063"></a>00063 <a name="l00066"></a>00066 <span class="keywordtype">int</span> CreateSocket(); <a name="l00067"></a>00067 <a name="l00069"></a>00069 <span class="keywordtype">void</span> CloseSocket(<span class="keywordtype">int</span> socketdescriptor); <a name="l00070"></a>00070 <a name="l00073"></a>00073 <span class="keywordtype">int</span> BindSocket(<span class="keywordtype">int</span> socketdescriptor, <span class="keywordtype">int</span> <a class="code" href="a03761.html#c6551f7bf833e8254b2b3ecdaea0d210710cb6d12e418b21e8fb3d79ac32f51c">port</a>); <a name="l00074"></a>00074 <a name="l00077"></a>00077 <span class="keywordtype">int</span> SelectSocket(<span class="keywordtype">int</span> socketdescriptor, <span class="keywordtype">unsigned</span> <span class="keywordtype">long</span> msec); <a name="l00078"></a>00078 <a name="l00081"></a>00081 <span class="keywordtype">int</span> Accept(<span class="keywordtype">int</span> socketdescriptor); <a name="l00082"></a>00082 <a name="l00085"></a>00085 <span class="keywordtype">int</span> Listen(<span class="keywordtype">int</span> socketdescriptor); <a name="l00086"></a>00086 <a name="l00088"></a>00088 <span class="keywordtype">int</span> Connect(<span class="keywordtype">int</span> socketdescriptor, <span class="keyword">const</span> <span class="keywordtype">char</span>* hostname, <span class="keywordtype">int</span> <a class="code" href="a03761.html#c6551f7bf833e8254b2b3ecdaea0d210710cb6d12e418b21e8fb3d79ac32f51c">port</a>); <a name="l00089"></a>00089 <a name="l00091"></a>00091 <span class="keywordtype">int</span> GetPort(<span class="keywordtype">int</span> socketdescriptor); <a name="l00092"></a>00092 <a name="l00094"></a>00094 <a name="l00096"></a>00096 <span class="keyword">static</span> <span class="keywordtype">int</span> <a class="code" href="a01569.html#e21583c20f6a1f8c9ebdb4daa92ee2da">SelectSockets</a>(<span class="keyword">const</span> <span class="keywordtype">int</span>* sockets_to_select, <span class="keywordtype">int</span> <a class="code" href="a03761.html#c6551f7bf833e8254b2b3ecdaea0d210e3d5e7c015dff08d8daf72a0102e1444">size</a>, <a name="l00097"></a>00097 <span class="keywordtype">unsigned</span> <span class="keywordtype">long</span> msec, <span class="keywordtype">int</span>* selected_index); <a name="l00099"></a>00099 <span class="keyword">private</span>: <a name="l00100"></a>00100 <a class="code" href="a01568.html" title="BSD socket encapsulation.">vtkSocket</a>(<span class="keyword">const</span> <a class="code" href="a01568.html" title="BSD socket encapsulation.">vtkSocket</a>&); <span class="comment">// Not implemented.</span> <a name="l00101"></a>00101 <span class="keywordtype">void</span> operator=(<span class="keyword">const</span> <a class="code" href="a01568.html" title="BSD socket encapsulation.">vtkSocket</a>&); <span class="comment">// Not implemented.</span> <a name="l00102"></a>00102 }; <a name="l00103"></a>00103 <a name="l00104"></a>00104 <a name="l00105"></a>00105 <span class="preprocessor">#endif</span> <a name="l00106"></a>00106 <span class="preprocessor"></span> </pre></div></div> <hr size="1"><address style="text-align: right;"><small>Generated on Wed Jun 3 18:35:12 2009 for VTK by <a href="http://www.doxygen.org/index.html"> <img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.5.6 </small></address> </body> </html>