<!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: vtkClientSocket 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>vtkClientSocket Class Reference</h1><!-- doxytag: class="vtkClientSocket" --><!-- doxytag: inherits="vtkSocket" --><code>#include <<a class="el" href="a03792.html">vtkClientSocket.h</a>></code>
<p>
<div class="dynheader">
Inheritance diagram for vtkClientSocket:</div>
<div class="dynsection">
<p><center><img src="a08586.png" border="0" usemap="#a08587" alt="Inheritance graph"></center>
<map name="a08587">
<area shape="rect" href="a01568.html" title="BSD socket encapsulation." alt="" coords="23,155,105,181"><area shape="rect" href="a01084.html" title="abstract base class for most VTK objects" alt="" coords="24,80,104,107"><area shape="rect" href="a01085.html" title="abstract base class for most VTK objects" alt="" coords="9,5,119,32"></map>
<center><font size="2">[<a href="graph_legend.html">legend</a>]</font></center></div>
<div class="dynheader">
Collaboration diagram for vtkClientSocket:</div>
<div class="dynsection">
<p><center><img src="a08588.png" border="0" usemap="#a08589" alt="Collaboration graph"></center>
<map name="a08589">
<area shape="rect" href="a01568.html" title="BSD socket encapsulation." alt="" coords="85,174,168,200"><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,6,115,32"><area shape="rect" href="a01719.html" title="record modification and/or execution time" alt="" coords="139,6,248,32"></map>
<center><font size="2">[<a href="graph_legend.html">legend</a>]</font></center></div>
<p>
<a href="a08590.html">List of all members.</a><hr><a name="_details"></a><h2>Detailed Description</h2>
Encapsulates a client socket.
<p>Definition at line <a class="el" href="a03792.html#l00025">25</a> of file <a class="el" href="a03792.html">vtkClientSocket.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="a01568.html">vtkSocket</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="a00269.html#18d231b2f933ba41b7a0eef99947e2db">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="a00269.html#aad47793d332e79c6e879c810057d2ff">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="a00269.html#132da5f82756cc40c8cbd6b48883d2e8">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="a00269.html#97cd2148f5384983a9a2055f42715a3e">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="a00269.html#2ce7edb607505a541ad70647d014cac0">ConnectToServer</a> (const char *hostname, int port)</td></tr>
<tr><td colspan="2"><div class="groupHeader"></div></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual bool </td><td class="memItemRight" valign="bottom"><a class="el" href="a00269.html#75a8bf77e1247e6b7f0fc87563e4d361">GetConnectingSide</a> ()</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 <a class="el" href="a00269.html">vtkClientSocket</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="a00269.html#585307a16e4349f9c24ef3e11b652f66">New</a> ()</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">static int </td><td class="memItemRight" valign="bottom"><a class="el" href="a00269.html#aa034b80097836b06534a58352846c54">IsTypeOf</a> (const char *type)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">static <a class="el" href="a00269.html">vtkClientSocket</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="a00269.html#d0d14db6a1e646dd0066568e0966a887">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="a00269.html#2239d376499b1cb0cadfbf55317a0c16">vtkClientSocket</a> ()</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="a00269.html#6507408b14ead0417f37f5957d6767f1">~vtkClientSocket</a> ()</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="a00269.html#e1c8c6a43333b5a6e1fd695e4918614e">SetConnectingSide</a> (bool)</td></tr>
<tr><td colspan="2"><br><h2>Protected Attributes</h2></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="a00269.html#fb5c234ba3c53d28b924b297c44c4ad9">ConnectingSide</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="a00269.html#931d3c979309bdfe51342f24005bb984">vtkServerSocket</a></td></tr>
</table>
<hr><h2>Member Typedef Documentation</h2>
<a class="anchor" name="18d231b2f933ba41b7a0eef99947e2db"></a><!-- doxytag: member="vtkClientSocket::Superclass" ref="18d231b2f933ba41b7a0eef99947e2db" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">typedef <a class="el" href="a01568.html">vtkSocket</a> <a class="el" href="a01568.html">vtkClientSocket::Superclass</a> </td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
<p>Reimplemented from <a class="el" href="a01568.html#b7109f0c2bc39762da4dc9678398c486">vtkSocket</a>.</p>
<p>Definition at line <a class="el" href="a03792.html#l00029">29</a> of file <a class="el" href="a03792.html">vtkClientSocket.h</a>.</p>
</div>
</div><p>
<hr><h2>Constructor & Destructor Documentation</h2>
<a class="anchor" name="2239d376499b1cb0cadfbf55317a0c16"></a><!-- doxytag: member="vtkClientSocket::vtkClientSocket" ref="2239d376499b1cb0cadfbf55317a0c16" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">vtkClientSocket::vtkClientSocket </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="6507408b14ead0417f37f5957d6767f1"></a><!-- doxytag: member="vtkClientSocket::~vtkClientSocket" ref="6507408b14ead0417f37f5957d6767f1" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">vtkClientSocket::~vtkClientSocket </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="585307a16e4349f9c24ef3e11b652f66"></a><!-- doxytag: member="vtkClientSocket::New" ref="585307a16e4349f9c24ef3e11b652f66" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">static <a class="el" href="a00269.html">vtkClientSocket</a>* vtkClientSocket::New </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td><code> [static]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Create an object with Debug turned off, modified time initialized to zero, and reference counting on.
<p>Reimplemented from <a class="el" href="a01084.html#4d5b227267c076d6f9e38483370b6612">vtkObject</a>.</p>
</div>
</div><p>
<a class="anchor" name="aad47793d332e79c6e879c810057d2ff"></a><!-- doxytag: member="vtkClientSocket::GetClassName" ref="aad47793d332e79c6e879c810057d2ff" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual const char* vtkClientSocket::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="a01568.html#6d013405409398869e03c86673f21fd2">vtkSocket</a>.</p>
</div>
</div><p>
<a class="anchor" name="aa034b80097836b06534a58352846c54"></a><!-- doxytag: member="vtkClientSocket::IsTypeOf" ref="aa034b80097836b06534a58352846c54" args="(const char *type)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">static int vtkClientSocket::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="a01568.html#46822c59c3861450c273dc539e536c26">vtkSocket</a>.</p>
</div>
</div><p>
<a class="anchor" name="132da5f82756cc40c8cbd6b48883d2e8"></a><!-- doxytag: member="vtkClientSocket::IsA" ref="132da5f82756cc40c8cbd6b48883d2e8" args="(const char *type)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual int vtkClientSocket::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="a01568.html#3a09f0d95dd22a27fd00c6d417fbc536">vtkSocket</a>.</p>
</div>
</div><p>
<a class="anchor" name="d0d14db6a1e646dd0066568e0966a887"></a><!-- doxytag: member="vtkClientSocket::SafeDownCast" ref="d0d14db6a1e646dd0066568e0966a887" args="(vtkObject *o)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">static <a class="el" href="a00269.html">vtkClientSocket</a>* vtkClientSocket::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="a01568.html#3c8fb773bc4123fe06d047ecac55b220">vtkSocket</a>.</p>
</div>
</div><p>
<a class="anchor" name="97cd2148f5384983a9a2055f42715a3e"></a><!-- doxytag: member="vtkClientSocket::PrintSelf" ref="97cd2148f5384983a9a2055f42715a3e" args="(ostream &os, vtkIndent indent)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void vtkClientSocket::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="a01568.html#9ae372275d7a8691e44cca057bb9f95c">vtkSocket</a>.</p>
</div>
</div><p>
<a class="anchor" name="2ce7edb607505a541ad70647d014cac0"></a><!-- doxytag: member="vtkClientSocket::ConnectToServer" ref="2ce7edb607505a541ad70647d014cac0" args="(const char *hostname, int port)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int vtkClientSocket::ConnectToServer </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></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Connects to host. Returns 0 on success, -1 on error.
</div>
</div><p>
<a class="anchor" name="75a8bf77e1247e6b7f0fc87563e4d361"></a><!-- doxytag: member="vtkClientSocket::GetConnectingSide" ref="75a8bf77e1247e6b7f0fc87563e4d361" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual bool vtkClientSocket::GetConnectingSide </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td><code> [virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Returns if the socket is on the connecting side (the side that requests a <a class="el" href="a00269.html#2ce7edb607505a541ad70647d014cac0">ConnectToServer()</a> or on the connected side (the side that was waiting for the client to connect). This is used to disambiguate the two ends of a socket connection.
</div>
</div><p>
<a class="anchor" name="e1c8c6a43333b5a6e1fd695e4918614e"></a><!-- doxytag: member="vtkClientSocket::SetConnectingSide" ref="e1c8c6a43333b5a6e1fd695e4918614e" args="(bool)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual void vtkClientSocket::SetConnectingSide </td>
<td>(</td>
<td class="paramtype">bool </td>
<td class="paramname"> </td>
<td> ) </td>
<td><code> [protected, virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
</div>
</div><p>
<hr><h2>Friends And Related Function Documentation</h2>
<a class="anchor" name="931d3c979309bdfe51342f24005bb984"></a><!-- doxytag: member="vtkClientSocket::vtkServerSocket" ref="931d3c979309bdfe51342f24005bb984" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">friend class <a class="el" href="a01530.html">vtkServerSocket</a><code> [friend]</code> </td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
<p>Definition at line <a class="el" href="a03792.html#l00050">50</a> of file <a class="el" href="a03792.html">vtkClientSocket.h</a>.</p>
</div>
</div><p>
<hr><h2>Member Data Documentation</h2>
<a class="anchor" name="fb5c234ba3c53d28b924b297c44c4ad9"></a><!-- doxytag: member="vtkClientSocket::ConnectingSide" ref="fb5c234ba3c53d28b924b297c44c4ad9" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool <a class="el" href="a00269.html#fb5c234ba3c53d28b924b297c44c4ad9">vtkClientSocket::ConnectingSide</a><code> [protected]</code> </td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
<p>Definition at line <a class="el" href="a03792.html#l00048">48</a> of file <a class="el" href="a03792.html">vtkClientSocket.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="a03792.html">vtkClientSocket.h</a></ul>
</div>
<hr size="1"><address style="text-align: right;"><small>Generated on Wed Jun 3 18:56:50 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
>
272
