<!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: vtkSocket Class Reference</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 class="current"><a href="classes.html"><span>Classes</span></a></li>
<li><a href="files.html"><span>Files</span></a></li>
</ul>
</div>
<div class="tabs">
<ul>
<li><a href="classes.html"><span>Alphabetical List</span></a></li>
<li><a href="annotated.html"><span>Class List</span></a></li>
<li><a href="hierarchy.html"><span>Class Hierarchy</span></a></li>
<li><a href="functions.html"><span>Class Members</span></a></li>
</ul>
</div>
</div>
<div class="contents">
<h1>vtkSocket Class Reference</h1><!-- doxytag: class="vtkSocket" --><!-- doxytag: inherits="vtkObject" --><code>#include <<a class="el" href="a03925.html">vtkSocket.h</a>></code>
<p>
<div class="dynheader">
Inheritance diagram for vtkSocket:</div>
<div class="dynsection">
<p><center><img src="a14545.png" border="0" usemap="#a14546" alt="Inheritance graph"></center>
<map name="a14546">
<area shape="rect" href="a00269.html" title="Encapsulates a client socket." alt="" coords="6,229,123,256"><area shape="rect" href="a01530.html" title="Encapsulate a socket that accepts connections." alt="" coords="147,229,270,256"><area shape="rect" href="a01084.html" title="abstract base class for most VTK objects" alt="" coords="96,80,176,107"><area shape="rect" href="a01085.html" title="abstract base class for most VTK objects" alt="" coords="82,5,191,32"></map>
<center><font size="2">[<a href="graph_legend.html">legend</a>]</font></center></div>
<div class="dynheader">
Collaboration diagram for vtkSocket:</div>
<div class="dynsection">
<p><center><img src="a14547.png" border="0" usemap="#a14548" alt="Collaboration graph"></center>
<map name="a14548">
<area shape="rect" href="a01084.html" title="abstract base class for most VTK objects" alt="" coords="87,96,167,123"><area shape="rect" href="a01085.html" title="abstract base class for most VTK objects" alt="" coords="5,5,115,32"><area shape="rect" href="a01719.html" title="record modification and/or execution time" alt="" coords="139,5,248,32"></map>
<center><font size="2">[<a href="graph_legend.html">legend</a>]</font></center></div>
<p>
<a href="a14549.html">List of all members.</a><hr><a name="_details"></a><h2>Detailed Description</h2>
BSD socket encapsulation.
<p>
This abstract class encapsulates a BSD socket. It provides an API for basic socket operations.
<p>Definition at line <a class="el" href="a03925.html#l00028">28</a> of file <a class="el" href="a03925.html">vtkSocket.h</a>.</p>
<table border="0" cellpadding="0" cellspacing="0">
<tr><td></td></tr>
<tr><td colspan="2"><br><h2>Public Types</h2></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">typedef <a class="el" href="a01084.html">vtkObject</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="a01568.html#b7109f0c2bc39762da4dc9678398c486">Superclass</a></td></tr>
<tr><td colspan="2"><br><h2>Public Member Functions</h2></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual const char * </td><td class="memItemRight" valign="bottom"><a class="el" href="a01568.html#6d013405409398869e03c86673f21fd2">GetClassName</a> ()</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual int </td><td class="memItemRight" valign="bottom"><a class="el" href="a01568.html#3a09f0d95dd22a27fd00c6d417fbc536">IsA</a> (const char *type)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="a01568.html#9ae372275d7a8691e44cca057bb9f95c">PrintSelf</a> (ostream &os, <a class="el" href="a00869.html">vtkIndent</a> indent)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="a01568.html#88ce9a9c047f7aea703e1e03b12664e8">GetConnected</a> ()</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="a01568.html#1df485d17ebb3a9fdb391b9747fa9c4c">CloseSocket</a> ()</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="a01568.html#fa43cb51b073bdcc80d7ccc4866a22e7">Send</a> (const void *data, int length)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="a01568.html#eef00337cadda3ee372cbff59765fc57">Receive</a> (void *data, int length, int readFully=1)</td></tr>
<tr><td colspan="2"><br><h2>Static Public Member Functions</h2></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">static int </td><td class="memItemRight" valign="bottom"><a class="el" href="a01568.html#46822c59c3861450c273dc539e536c26">IsTypeOf</a> (const char *type)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">static <a class="el" href="a01568.html">vtkSocket</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="a01568.html#3c8fb773bc4123fe06d047ecac55b220">SafeDownCast</a> (<a class="el" href="a01084.html">vtkObject</a> *o)</td></tr>
<tr><td colspan="2"><br><h2>Protected Member Functions</h2></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="a01568.html#0d7cfedad2db9b1ea40d0951d8a714c1">vtkSocket</a> ()</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="a01568.html#80f9751a13edb9aa45c2cdecd5cce9c2">~vtkSocket</a> ()</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual int </td><td class="memItemRight" valign="bottom"><a class="el" href="a01568.html#5b0f042288e6ebb348d9869e9c9c4ccc">GetSocketDescriptor</a> ()</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="a01568.html#26e167d12ec4b711ee2ce187ef345c39">CreateSocket</a> ()</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="a01568.html#9d331e226e57dbf198b1175380c16485">CloseSocket</a> (int socketdescriptor)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="a01568.html#a74dec5c0975ff864082d79878be0a42">BindSocket</a> (int socketdescriptor, int port)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="a01568.html#40829cf3eed550bfb50d2ccf1a61685a">SelectSocket</a> (int socketdescriptor, unsigned long msec)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="a01568.html#3c6ee8585c695a83107910baeb150bc2">Accept</a> (int socketdescriptor)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="a01568.html#6beeb518161c87e479b4db1ff6bfcb97">Listen</a> (int socketdescriptor)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="a01568.html#e50716c51c11c4debcec216cef982eb2">Connect</a> (int socketdescriptor, const char *hostname, int port)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="a01568.html#ada7299072ca8052d3d2cb4cad3592b9">GetPort</a> (int socketdescriptor)</td></tr>
<tr><td colspan="2"><br><h2>Static Protected Member Functions</h2></td></tr>
<tr><td colspan="2"><div class="groupHeader"></div></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">static int </td><td class="memItemRight" valign="bottom"><a class="el" href="a01568.html#342c9e3a14152a61953e552c7b769445">SelectSockets</a> (const int *sockets_to_select, int size, unsigned long msec, int *selected_index)</td></tr>
<tr><td colspan="2"><br><h2>Protected Attributes</h2></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="a01568.html#dceba7003bb47a40082e2c5c0e69d157">SocketDescriptor</a></td></tr>
<tr><td colspan="2"><br><h2>Friends</h2></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">class </td><td class="memItemRight" valign="bottom"><a class="el" href="a01568.html#4e3b82b42752248c8d22cf7842f683bf">vtkSocketCollection</a></td></tr>
</table>
<hr><h2>Member Typedef Documentation</h2>
<a class="anchor" name="b7109f0c2bc39762da4dc9678398c486"></a><!-- doxytag: member="vtkSocket::Superclass" ref="b7109f0c2bc39762da4dc9678398c486" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">typedef <a class="el" href="a01084.html">vtkObject</a> <a class="el" href="a01084.html">vtkSocket::Superclass</a> </td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
<p>Reimplemented from <a class="el" href="a01084.html#11429dee69f4b562e03e07b453dae9b5">vtkObject</a>.</p>
<p>Reimplemented in <a class="el" href="a00269.html#18d231b2f933ba41b7a0eef99947e2db">vtkClientSocket</a>, and <a class="el" href="a01530.html#4bd07251ac6a5f29c8f223c16b8edaa9">vtkServerSocket</a>.</p>
<p>Definition at line <a class="el" href="a03925.html#l00031">31</a> of file <a class="el" href="a03925.html">vtkSocket.h</a>.</p>
</div>
</div><p>
<hr><h2>Constructor & Destructor Documentation</h2>
<a class="anchor" name="0d7cfedad2db9b1ea40d0951d8a714c1"></a><!-- doxytag: member="vtkSocket::vtkSocket" ref="0d7cfedad2db9b1ea40d0951d8a714c1" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">vtkSocket::vtkSocket </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td><code> [protected]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
</div>
</div><p>
<a class="anchor" name="80f9751a13edb9aa45c2cdecd5cce9c2"></a><!-- doxytag: member="vtkSocket::~vtkSocket" ref="80f9751a13edb9aa45c2cdecd5cce9c2" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">vtkSocket::~vtkSocket </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td><code> [protected]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
</div>
</div><p>
<hr><h2>Member Function Documentation</h2>
<a class="anchor" name="6d013405409398869e03c86673f21fd2"></a><!-- doxytag: member="vtkSocket::GetClassName" ref="6d013405409398869e03c86673f21fd2" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual const char* vtkSocket::GetClassName </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td><code> [virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
<p>Reimplemented from <a class="el" href="a01084.html#d95975c85c2896ea32ff4cf1f8de0886">vtkObject</a>.</p>
<p>Reimplemented in <a class="el" href="a00269.html#aad47793d332e79c6e879c810057d2ff">vtkClientSocket</a>, and <a class="el" href="a01530.html#9e3ca71b86fb0558c859c75169dd3cbc">vtkServerSocket</a>.</p>
</div>
</div><p>
<a class="anchor" name="46822c59c3861450c273dc539e536c26"></a><!-- doxytag: member="vtkSocket::IsTypeOf" ref="46822c59c3861450c273dc539e536c26" args="(const char *type)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">static int vtkSocket::IsTypeOf </td>
<td>(</td>
<td class="paramtype">const char * </td>
<td class="paramname"> <em>name</em> </td>
<td> ) </td>
<td><code> [static]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Return 1 if this class type is the same type of (or a subclass of) the named class. Returns 0 otherwise. This method works in combination with vtkTypeRevisionMacro found in vtkSetGet.h.
<p>Reimplemented from <a class="el" href="a01084.html#e9548a248bce0f02f73bbcccd0a9489e">vtkObject</a>.</p>
<p>Reimplemented in <a class="el" href="a00269.html#aa034b80097836b06534a58352846c54">vtkClientSocket</a>, and <a class="el" href="a01530.html#ad09be0e83c06f72cf9c47fb48c511ac">vtkServerSocket</a>.</p>
</div>
</div><p>
<a class="anchor" name="3a09f0d95dd22a27fd00c6d417fbc536"></a><!-- doxytag: member="vtkSocket::IsA" ref="3a09f0d95dd22a27fd00c6d417fbc536" args="(const char *type)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual int vtkSocket::IsA </td>
<td>(</td>
<td class="paramtype">const char * </td>
<td class="paramname"> <em>name</em> </td>
<td> ) </td>
<td><code> [virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Return 1 if this class is the same type of (or a subclass of) the named class. Returns 0 otherwise. This method works in combination with vtkTypeRevisionMacro found in vtkSetGet.h.
<p>Reimplemented from <a class="el" href="a01084.html#831e57b04e46827a7098aa81abadee69">vtkObject</a>.</p>
<p>Reimplemented in <a class="el" href="a00269.html#132da5f82756cc40c8cbd6b48883d2e8">vtkClientSocket</a>, and <a class="el" href="a01530.html#89850c7b08c1080abe2a71f9a98a5c77">vtkServerSocket</a>.</p>
</div>
</div><p>
<a class="anchor" name="3c8fb773bc4123fe06d047ecac55b220"></a><!-- doxytag: member="vtkSocket::SafeDownCast" ref="3c8fb773bc4123fe06d047ecac55b220" args="(vtkObject *o)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">static <a class="el" href="a01568.html">vtkSocket</a>* vtkSocket::SafeDownCast </td>
<td>(</td>
<td class="paramtype"><a class="el" href="a01084.html">vtkObject</a> * </td>
<td class="paramname"> <em>o</em> </td>
<td> ) </td>
<td><code> [static]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
<p>Reimplemented from <a class="el" href="a01084.html#bb9351f076544c427ee91229dce83abe">vtkObject</a>.</p>
<p>Reimplemented in <a class="el" href="a00269.html#d0d14db6a1e646dd0066568e0966a887">vtkClientSocket</a>, and <a class="el" href="a01530.html#598ebd7a95f0093d3ddf8d9a47c0a157">vtkServerSocket</a>.</p>
</div>
</div><p>
<a class="anchor" name="9ae372275d7a8691e44cca057bb9f95c"></a><!-- doxytag: member="vtkSocket::PrintSelf" ref="9ae372275d7a8691e44cca057bb9f95c" args="(ostream &os, vtkIndent indent)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void vtkSocket::PrintSelf </td>
<td>(</td>
<td class="paramtype">ostream & </td>
<td class="paramname"> <em>os</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="a00869.html">vtkIndent</a> </td>
<td class="paramname"> <em>indent</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td><code> [virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Methods invoked by print to print information about the object including superclasses. Typically not called by the user (use <a class="el" href="a01085.html#edadf6378465fd81c2592ef64262e2a5">Print()</a> instead) but used in the hierarchical print process to combine the output of several classes.
<p>Reimplemented from <a class="el" href="a01084.html#bf3dbb4154289b56a12483eee3866263">vtkObject</a>.</p>
<p>Reimplemented in <a class="el" href="a00269.html#97cd2148f5384983a9a2055f42715a3e">vtkClientSocket</a>, and <a class="el" href="a01530.html#9575af1296deda89aa0b1646e5590f52">vtkServerSocket</a>.</p>
</div>
</div><p>
<a class="anchor" name="88ce9a9c047f7aea703e1e03b12664e8"></a><!-- doxytag: member="vtkSocket::GetConnected" ref="88ce9a9c047f7aea703e1e03b12664e8" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int vtkSocket::GetConnected </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td><code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Check is the socket is alive.
<p>Definition at line <a class="el" href="a03925.html#l00036">36</a> of file <a class="el" href="a03925.html">vtkSocket.h</a>.</p>
</div>
</div><p>
<a class="anchor" name="1df485d17ebb3a9fdb391b9747fa9c4c"></a><!-- doxytag: member="vtkSocket::CloseSocket" ref="1df485d17ebb3a9fdb391b9747fa9c4c" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void vtkSocket::CloseSocket </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td><code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Close the socket.
<p>Definition at line <a class="el" href="a03925.html#l00039">39</a> of file <a class="el" href="a03925.html">vtkSocket.h</a>.</p>
</div>
</div><p>
<a class="anchor" name="fa43cb51b073bdcc80d7ccc4866a22e7"></a><!-- doxytag: member="vtkSocket::Send" ref="fa43cb51b073bdcc80d7ccc4866a22e7" args="(const void *data, int length)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int vtkSocket::Send </td>
<td>(</td>
<td class="paramtype">const void * </td>
<td class="paramname"> <em>data</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int </td>
<td class="paramname"> <em>length</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
These methods send data over the socket. Returns 1 on success, 0 on error and raises <a class="el" href="a00291.html#59a8690330ebcb1af6b66b0f3121f8fe0a12f04e4e497c06cfc86a007e777f0d">vtkCommand::ErrorEvent</a>.
</div>
</div><p>
<a class="anchor" name="eef00337cadda3ee372cbff59765fc57"></a><!-- doxytag: member="vtkSocket::Receive" ref="eef00337cadda3ee372cbff59765fc57" args="(void *data, int length, int readFully=1)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int vtkSocket::Receive </td>
<td>(</td>
<td class="paramtype">void * </td>
<td class="paramname"> <em>data</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int </td>
<td class="paramname"> <em>length</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int </td>
<td class="paramname"> <em>readFully</em> = <code>1</code></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Receive data from the socket. This call blocks until some data is read from the socket. When readFully is set, this call will block until all the requested data is read from the socket. 0 on error, else number of bytes read is returned. On error, <a class="el" href="a00291.html#59a8690330ebcb1af6b66b0f3121f8fe0a12f04e4e497c06cfc86a007e777f0d">vtkCommand::ErrorEvent</a> is raised.
</div>
</div><p>
<a class="anchor" name="5b0f042288e6ebb348d9869e9c9c4ccc"></a><!-- doxytag: member="vtkSocket::GetSocketDescriptor" ref="5b0f042288e6ebb348d9869e9c9c4ccc" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual int vtkSocket::GetSocketDescriptor </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td><code> [protected, virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
</div>
</div><p>
<a class="anchor" name="26e167d12ec4b711ee2ce187ef345c39"></a><!-- doxytag: member="vtkSocket::CreateSocket" ref="26e167d12ec4b711ee2ce187ef345c39" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int vtkSocket::CreateSocket </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td><code> [protected]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Creates an endpoint for communication and returns the descriptor. -1 indicates error.
</div>
</div><p>
<a class="anchor" name="9d331e226e57dbf198b1175380c16485"></a><!-- doxytag: member="vtkSocket::CloseSocket" ref="9d331e226e57dbf198b1175380c16485" args="(int socketdescriptor)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void vtkSocket::CloseSocket </td>
<td>(</td>
<td class="paramtype">int </td>
<td class="paramname"> <em>socketdescriptor</em> </td>
<td> ) </td>
<td><code> [protected]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Close the socket.
</div>
</div><p>
<a class="anchor" name="a74dec5c0975ff864082d79878be0a42"></a><!-- doxytag: member="vtkSocket::BindSocket" ref="a74dec5c0975ff864082d79878be0a42" args="(int socketdescriptor, int port)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int vtkSocket::BindSocket </td>
<td>(</td>
<td class="paramtype">int </td>
<td class="paramname"> <em>socketdescriptor</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int </td>
<td class="paramname"> <em>port</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td><code> [protected]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Binds socket to a particular port. Returns 0 on success other -1 is returned.
</div>
</div><p>
<a class="anchor" name="40829cf3eed550bfb50d2ccf1a61685a"></a><!-- doxytag: member="vtkSocket::SelectSocket" ref="40829cf3eed550bfb50d2ccf1a61685a" args="(int socketdescriptor, unsigned long msec)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int vtkSocket::SelectSocket </td>
<td>(</td>
<td class="paramtype">int </td>
<td class="paramname"> <em>socketdescriptor</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">unsigned long </td>
<td class="paramname"> <em>msec</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td><code> [protected]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Selects a socket ie. waits for it to change status. Returns 1 on success; 0 on timeout; -1 on error. msec=0 implies no timeout.
</div>
</div><p>
<a class="anchor" name="3c6ee8585c695a83107910baeb150bc2"></a><!-- doxytag: member="vtkSocket::Accept" ref="3c6ee8585c695a83107910baeb150bc2" args="(int socketdescriptor)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int vtkSocket::Accept </td>
<td>(</td>
<td class="paramtype">int </td>
<td class="paramname"> <em>socketdescriptor</em> </td>
<td> ) </td>
<td><code> [protected]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Accept a connection on a socket. Returns -1 on error. Otherwise the descriptor of the accepted socket.
</div>
</div><p>
<a class="anchor" name="6beeb518161c87e479b4db1ff6bfcb97"></a><!-- doxytag: member="vtkSocket::Listen" ref="6beeb518161c87e479b4db1ff6bfcb97" args="(int socketdescriptor)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int vtkSocket::Listen </td>
<td>(</td>
<td class="paramtype">int </td>
<td class="paramname"> <em>socketdescriptor</em> </td>
<td> ) </td>
<td><code> [protected]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Listen for connections on a socket. Returns 0 on success. -1 on error.
</div>
</div><p>
<a class="anchor" name="e50716c51c11c4debcec216cef982eb2"></a><!-- doxytag: member="vtkSocket::Connect" ref="e50716c51c11c4debcec216cef982eb2" args="(int socketdescriptor, const char *hostname, int port)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int vtkSocket::Connect </td>
<td>(</td>
<td class="paramtype">int </td>
<td class="paramname"> <em>socketdescriptor</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const char * </td>
<td class="paramname"> <em>hostname</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int </td>
<td class="paramname"> <em>port</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td><code> [protected]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Connect to a server socket. Returns 0 on success, -1 on error.
</div>
</div><p>
<a class="anchor" name="ada7299072ca8052d3d2cb4cad3592b9"></a><!-- doxytag: member="vtkSocket::GetPort" ref="ada7299072ca8052d3d2cb4cad3592b9" args="(int socketdescriptor)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int vtkSocket::GetPort </td>
<td>(</td>
<td class="paramtype">int </td>
<td class="paramname"> <em>socketdescriptor</em> </td>
<td> ) </td>
<td><code> [protected]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Returns the port to which the socket is connected. 0 on error.
</div>
</div><p>
<a class="anchor" name="342c9e3a14152a61953e552c7b769445"></a><!-- doxytag: member="vtkSocket::SelectSockets" ref="342c9e3a14152a61953e552c7b769445" args="(const int *sockets_to_select, int size, unsigned long msec, int *selected_index)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">static int vtkSocket::SelectSockets </td>
<td>(</td>
<td class="paramtype">const int * </td>
<td class="paramname"> <em>sockets_to_select</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int </td>
<td class="paramname"> <em>size</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">unsigned long </td>
<td class="paramname"> <em>msec</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int * </td>
<td class="paramname"> <em>selected_index</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td><code> [static, protected]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Selects set of sockets. Returns 0 on timeout, -1 on error. 1 on success. Selected socket's index is returned thru selected_index
</div>
</div><p>
<hr><h2>Friends And Related Function Documentation</h2>
<a class="anchor" name="4e3b82b42752248c8d22cf7842f683bf"></a><!-- doxytag: member="vtkSocket::vtkSocketCollection" ref="4e3b82b42752248c8d22cf7842f683bf" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">friend class <a class="el" href="a01569.html">vtkSocketCollection</a><code> [friend]</code> </td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
<p>Definition at line <a class="el" href="a03925.html#l00058">58</a> of file <a class="el" href="a03925.html">vtkSocket.h</a>.</p>
</div>
</div><p>
<hr><h2>Member Data Documentation</h2>
<a class="anchor" name="dceba7003bb47a40082e2c5c0e69d157"></a><!-- doxytag: member="vtkSocket::SocketDescriptor" ref="dceba7003bb47a40082e2c5c0e69d157" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int <a class="el" href="a01568.html#dceba7003bb47a40082e2c5c0e69d157">vtkSocket::SocketDescriptor</a><code> [protected]</code> </td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
<p>Definition at line <a class="el" href="a03925.html#l00057">57</a> of file <a class="el" href="a03925.html">vtkSocket.h</a>.</p>
</div>
</div><p>
<hr>The documentation for this class was generated from the following file:<ul>
<li>dox/Common/<a class="el" href="a03925.html">vtkSocket.h</a></ul>
</div>
<hr size="1"><address style="text-align: right;"><small>Generated on Wed Jun 3 19:34:57 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>
distrib
>
Mandriva
>
2010.0
>
i586
>
media
>
contrib-release
>
by-pkgid
>
60f1dc962abad0f3b492991a4fbef9be
>
files
>
1571
