Sophie

Sophie

distrib > Mandriva > 2008.1 > x86_64 > media > main-release > by-pkgid > 554fa56029a60daf7aab25253fdab3d8 > files > 105

clanlib0.6-docs-0.6.5-28mdv2008.1.x86_64.rpm


<html>
<head><title>ClanLib Reference: CL_InputSource_Socket</title></head>
<body text=black link=blue vlink=#800080 bgcolor=white topmargin=0 leftmargin=0>
<table border=0 cellspacing=0 cellpadding=0 width=100%><tr><td><img border=0 src="../images/eyeheader-main-purple-a.gif" alt="ClanSoft logo" width=525 height=96></td></tr>
<tr bgcolor=#dadada><td align=left valign=top><img border=0 src="../images/eyeheader-main-purple-b.gif" alt="ClanSoft logo" width=190 height=14></td><td align=right valign=top><img border=0 src="../images/clanlib_light.gif" width=42 height=14></td></tr></table>
<table align=center border=0 cellspacing=10> <tr>
<td><a href="entire_class_index.html">Entire Class Index</a></td>
<td><a href="class_index.html">Main Class Index</a></td>
<td><a href="cross_index.html">Cross Index</a></td>
<td><a href="global_index.html">Global Index</a></td>
</table><h1 align=center>Class CL_InputSource_Socket</h1><p>
<b>  InputSource Socket Class</b><br>
Contained in: <a href="global_index.html">global</a><br>
Derived from:
<a href="CL_InputSource.html">CL_InputSource</a>
<br>
Derived by:
<i>none</i>
<br>Group: Network (Sockets)
<p>
#include &lt;ClanLib/network.h&gt;
<p>
<hr noshade>
<table border=0>
<tr><td colspan=3><h3>public function member index:</h3></td>
<tr valign=top><td align=left><h3>Construction:</h3></td>
<tr valign=top><td align=right><tt></tt> </td><td align=right><a href="CL_InputSource_Socket.html#2787"><tt><font color=blue><b>CL_InputSource_Socket</b></font></tt></a></td><td><tt>(<tt>const</tt> <a href="CL_Socket.html"><tt><font color=navy><b>CL_Socket</b></font></tt></a>& <tt><font color=blue>socket</font></tt>)</tt>;</td>
<tr valign=top><td align=right><tt><tt>virtual</tt> </tt> </td><td align=right><a href="CL_InputSource_Socket.html#2788"><tt><font color=blue><b>~CL_InputSource_Socket</b></font></tt></a></td><td><tt>()</tt>;</td>
<tr valign=top><td align=left><h3>Attributes:</h3></td>
<tr valign=top><td align=right><tt><tt>virtual</tt> <tt><font color=purple>int</font></tt></tt> </td><td align=right><a href="CL_InputSource_Socket.html#2789"><tt><font color=blue><b>tell</b></font></tt></a></td><td><tt>() <tt>const</tt></tt>;</td>
<tr valign=top><td align=right><tt><tt>virtual</tt> <tt><font color=purple>int</font></tt></tt> </td><td align=right><a href="CL_InputSource_Socket.html#2790"><tt><font color=blue><b>size</b></font></tt></a></td><td><tt>() <tt>const</tt></tt>;</td>
<tr valign=top><td align=left><h3>Operations:</h3></td>
<tr valign=top><td align=right><tt><tt>virtual</tt> <tt><font color=purple>int</font></tt></tt> </td><td align=right><a href="CL_InputSource_Socket.html#2791"><tt><font color=blue><b>read</b></font></tt></a></td><td><tt>(<tt><font color=purple>void</font></tt>* <tt><font color=blue>data</font></tt>, <tt><font color=purple>int</font></tt> <tt><font color=blue>size</font></tt>)</tt>;</td>
<tr valign=top><td align=right><tt><tt>virtual</tt> <tt><font color=purple>void</font></tt></tt> </td><td align=right><a href="CL_InputSource_Socket.html#2792"><tt><font color=blue><b>open</b></font></tt></a></td><td><tt>()</tt>;</td>
<tr valign=top><td align=right><tt><tt>virtual</tt> <tt><font color=purple>void</font></tt></tt> </td><td align=right><a href="CL_InputSource_Socket.html#2793"><tt><font color=blue><b>close</b></font></tt></a></td><td><tt>()</tt>;</td>
<tr valign=top><td align=right><tt><tt>virtual</tt> <a href="CL_InputSource.html"><tt><font color=navy><b>CL_InputSource</b></font></tt></a>*</tt> </td><td align=right><a href="CL_InputSource_Socket.html#2794"><tt><font color=blue><b>clone</b></font></tt></a></td><td><tt>() <tt>const</tt></tt>;</td>
<tr valign=top><td align=right><tt><tt>virtual</tt> <tt><font color=purple>void</font></tt></tt> </td><td align=right><a href="CL_InputSource_Socket.html#2795"><tt><font color=blue><b>seek</b></font></tt></a></td><td><tt>(<tt><font color=purple>int</font></tt> <tt><font color=blue>pos</font></tt>, <tt><font color=navy>SeekEnum</font></tt> <tt><font color=blue>seek_type</font></tt>)</tt>;</td>
<tr valign=top><td align=right><tt><tt>virtual</tt> <tt><font color=purple>void</font></tt></tt> </td><td align=right><a href="CL_InputSource_Socket.html#2796"><tt><font color=blue><b>push_position</b></font></tt></a></td><td><tt>()</tt>;</td>
<tr valign=top><td align=right><tt><tt>virtual</tt> <tt><font color=purple>void</font></tt></tt> </td><td align=right><a href="CL_InputSource_Socket.html#2797"><tt><font color=blue><b>pop_position</b></font></tt></a></td><td><tt>()</tt>;</td>
<tr><td>&nbsp;</td><tr><td colspan=3><h3>private function member index:</h3></td>
<tr valign=top><td align=left><h3>Implementation:</h3></td>
<tr valign=top><td align=right><tt></tt> </td><td align=right><a href="CL_InputSource_Socket.html#2799"><tt><font color=blue><b>CL_InputSource_Socket</b></font></tt></a></td><td><tt>()</tt>;</td>
<tr><td>&nbsp;</td></table>
<hr noshade>
<h2>Description:</h2>
<p>
<hr noshade>
<h2>Function Member Descriptions:</h2>
<a name="2787"><font size=+1><b>CL_InputSource_Socket::CL_InputSource_Socket</b></font></a> -   InputSource Socket Constructor<br><tt></tt> <a href="CL_InputSource_Socket.html#2787"><tt><font color=blue><b>CL_InputSource_Socket</b></font></tt></a><tt>(<tt>const</tt> <a href="CL_Socket.html"><tt><font color=navy><b>CL_Socket</b></font></tt></a>& <tt><font color=blue>socket</font></tt>)</tt>;<hr size="1" width="70%" align="left" noshade="noshade"><br><br>
<a name="2794"><font size=+1><b>CL_InputSource_Socket::clone</b></font></a> -   Make a copy of the current inputsource, standing at the same position.<br><tt><tt>virtual</tt> <a href="CL_InputSource.html"><tt><font color=navy><b>CL_InputSource</b></font></tt></a>*</tt> <a href="CL_InputSource_Socket.html#2794"><tt><font color=blue><b>clone</b></font></tt></a><tt>() <tt>const</tt></tt>;<br><blockquote>  Returns - The copy of the input source.</blockquote>
<hr size="1" width="70%" align="left" noshade="noshade"><br><br>
<a name="2793"><font size=+1><b>CL_InputSource_Socket::close</b></font></a> -   Closes the input source.<br><tt><tt>virtual</tt> <tt><font color=purple>void</font></tt></tt> <a href="CL_InputSource_Socket.html#2793"><tt><font color=blue><b>close</b></font></tt></a><tt>()</tt>;<hr size="1" width="70%" align="left" noshade="noshade"><br><br>
<a name="2792"><font size=+1><b>CL_InputSource_Socket::open</b></font></a> -   Opens the input source. By default, it is open.<br><tt><tt>virtual</tt> <tt><font color=purple>void</font></tt></tt> <a href="CL_InputSource_Socket.html#2792"><tt><font color=blue><b>open</b></font></tt></a><tt>()</tt>;<hr size="1" width="70%" align="left" noshade="noshade"><br><br>
<a name="2797"><font size=+1><b>CL_InputSource_Socket::pop_position</b></font></a> -   Pops a previous pushed input source position (returns to the position).<br><tt><tt>virtual</tt> <tt><font color=purple>void</font></tt></tt> <a href="CL_InputSource_Socket.html#2797"><tt><font color=blue><b>pop_position</b></font></tt></a><tt>()</tt>;<hr size="1" width="70%" align="left" noshade="noshade"><br><br>
<a name="2796"><font size=+1><b>CL_InputSource_Socket::push_position</b></font></a> -   Pushes the current input source position. The position can be restored again with pop_position.<br><tt><tt>virtual</tt> <tt><font color=purple>void</font></tt></tt> <a href="CL_InputSource_Socket.html#2796"><tt><font color=blue><b>push_position</b></font></tt></a><tt>()</tt>;<hr size="1" width="70%" align="left" noshade="noshade"><br><br>
<a name="2791"><font size=+1><b>CL_InputSource_Socket::read</b></font></a> -   Reads larger amounts of data (no endian and 64 bit conversion).<br><tt><tt>virtual</tt> <tt><font color=purple>int</font></tt></tt> <a href="CL_InputSource_Socket.html#2791"><tt><font color=blue><b>read</b></font></tt></a><tt>(<tt><font color=purple>void</font></tt>* <tt><font color=blue>data</font></tt>, <tt><font color=purple>int</font></tt> <tt><font color=blue>size</font></tt>)</tt>;<br><blockquote>  data - Points to an array where the read data is stored.<br>  size - Number of bytes to read.<br>  Returns - Num bytes actually read.</blockquote>
<hr size="1" width="70%" align="left" noshade="noshade"><br><br>
<a name="2795"><font size=+1><b>CL_InputSource_Socket::seek</b></font></a> -   Seeks to the specified position in the input source.<br><tt><tt>virtual</tt> <tt><font color=purple>void</font></tt></tt> <a href="CL_InputSource_Socket.html#2795"><tt><font color=blue><b>seek</b></font></tt></a><tt>(<tt><font color=purple>int</font></tt> <tt><font color=blue>pos</font></tt>, <tt><font color=navy>SeekEnum</font></tt> <tt><font color=blue>seek_type</font></tt>)</tt>;<br><blockquote>  pos - Position relative to 'seek_type'.<br>  seek_type - Defines what the 'pos' is relative to. Can be either seek_set, seek_cur og seek_end.</blockquote>
<hr size="1" width="70%" align="left" noshade="noshade"><br><br>
<a name="2790"><font size=+1><b>CL_InputSource_Socket::size</b></font></a> -   Returns the size of the input source<br><tt><tt>virtual</tt> <tt><font color=purple>int</font></tt></tt> <a href="CL_InputSource_Socket.html#2790"><tt><font color=blue><b>size</b></font></tt></a><tt>() <tt>const</tt></tt>;<br><blockquote>  Returns - Size of the input source.</blockquote>
<hr size="1" width="70%" align="left" noshade="noshade"><br><br>
<a name="2789"><font size=+1><b>CL_InputSource_Socket::tell</b></font></a> -   Returns current position in input source.<br><tt><tt>virtual</tt> <tt><font color=purple>int</font></tt></tt> <a href="CL_InputSource_Socket.html#2789"><tt><font color=blue><b>tell</b></font></tt></a><tt>() <tt>const</tt></tt>;<br><blockquote>  Returns - Current position in input source.</blockquote>
<hr size="1" width="70%" align="left" noshade="noshade"><br><br>
<hr noshade>
<h2>Variable Member Descriptions:</h2>
<hr noshade>
</body>
</html>