e1lama/stk
1
0
Fork 0
mirror of https://github.com/thestk/stk synced 2026-01-20 07:51:53 +00:00
Code Issues Packages Projects Releases Wiki Activity

Release 4.4.2 tarball

Browse Source
This commit is contained in:
Gary Scavone
2013-09-29 23:48:48 +02:00
committed by Stephen Sinclair
parent c37de52787
commit 7fcf920d3e
711 changed files with 28790 additions and 16452 deletions
Download Patch File Download Diff File Expand all files Collapse all files

128
doc/html/classstk_1_1Socket.html
View File

@@ -8,90 +8,80 @@
<img src="princeton.gif"> &nbsp; <img src="ccrma.gif"> &nbsp; <img src="mcgill.gif"><P>
<a class="qindex" href="index.html">Home</a> &nbsp; <a class="qindex" href="information.html">Information</a> &nbsp; <a class="qindex" href="classes.html">Classes</a> &nbsp; <a class="qindex" href="download.html">Download</a> &nbsp; <a class="qindex" href="usage.html">Usage</a> &nbsp; <a class="qindex" href="maillist.html">Mail List</a> &nbsp; <a class="qindex" href="system.html">Requirements</a> &nbsp; <a class="qindex" href="links.html">Links</a> &nbsp; <a class="qindex" href="faq.html">FAQ</a> &nbsp; <a class="qindex" href="tutorial.html">Tutorial</a></CENTER>
<HR>
<!-- Generated by Doxygen 1.5.8 -->
<!-- Generated by Doxygen 1.6.2 -->
<div class="navpath"><a class="el" href="namespacestk.html">stk</a>::<a class="el" href="classstk_1_1Socket.html">Socket</a>
</div>
<div class="contents">
<h1>stk::Socket Class Reference</h1><!-- doxytag: class="stk::Socket" --><!-- doxytag: inherits="stk::Stk" -->STK internet socket abstract base class.
<a href="#_details">More...</a>
<p>
<code>#include &lt;<a class="el" href="Socket_8h-source.html">Socket.h</a>&gt;</code>
<p>
<h1>stk::Socket Class Reference</h1><!-- doxytag: class="stk::Socket" --><!-- doxytag: inherits="stk::Stk" -->
<p>STK internet socket abstract base class.
<a href="#_details">More...</a></p>
<p><code>#include &lt;<a class="el" href="Socket_8h_source.html">Socket.h</a>&gt;</code></p>
<div class="dynheader">
Inheritance diagram for stk::Socket:</div>
<div class="dynsection">
<p><center><img src="classstk_1_1Socket.png" usemap="#stk::Socket_map" border="0" alt=""></center>
<map name="stk::Socket_map">
<area href="classstk_1_1Stk.html" alt="stk::Stk" shape="rect" coords="103,0,196,24">
<area href="classstk_1_1TcpClient.html" alt="stk::TcpClient" shape="rect" coords="0,112,93,136">
<area href="classstk_1_1TcpServer.html" alt="stk::TcpServer" shape="rect" coords="103,112,196,136">
<area href="classstk_1_1UdpSocket.html" alt="stk::UdpSocket" shape="rect" coords="206,112,299,136">
<div class="center">
<img src="classstk_1_1Socket.png" usemap="#stk::Socket_map" alt=""/>
<map id="stk::Socket_map" name="stk::Socket_map">
<area href="classstk_1_1Stk.html" alt="stk::Stk" shape="rect" coords="103,0,196,24"/>
<area href="classstk_1_1TcpClient.html" alt="stk::TcpClient" shape="rect" coords="0,112,93,136"/>
<area href="classstk_1_1TcpServer.html" alt="stk::TcpServer" shape="rect" coords="103,112,196,136"/>
<area href="classstk_1_1UdpSocket.html" alt="stk::UdpSocket" shape="rect" coords="206,112,299,136"/>
</map>
</div>
</div>
<p>
<a href="classstk_1_1Socket-members.html">List of all members.</a><table border="0" cellpadding="0" cellspacing="0">
<tr><td></td></tr>
<tr><td colspan="2"><br><h2>Public Member Functions</h2></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="2558d3b2001c07eeae9d3e301df399fe"></a><!-- doxytag: member="stk::Socket::Socket" ref="2558d3b2001c07eeae9d3e301df399fe" args="()" -->
&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classstk_1_1Socket.html#2558d3b2001c07eeae9d3e301df399fe">Socket</a> ()</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Class constructor. <br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="8fb79fcfba5d1438575e0fb933f8b37b"></a><!-- doxytag: member="stk::Socket::~Socket" ref="8fb79fcfba5d1438575e0fb933f8b37b" args="()" -->
virtual&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classstk_1_1Socket.html#8fb79fcfba5d1438575e0fb933f8b37b">~Socket</a> ()</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Class destructor. <br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="eae0c6721248eecd5dae0b77ea66cb2c"></a><!-- doxytag: member="stk::Socket::id" ref="eae0c6721248eecd5dae0b77ea66cb2c" args="(void) const " -->
int&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classstk_1_1Socket.html#eae0c6721248eecd5dae0b77ea66cb2c">id</a> (void) const </td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Return the socket descriptor. <br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="be3040ecfff6ce921284c6ab4b0500a7"></a><!-- doxytag: member="stk::Socket::port" ref="be3040ecfff6ce921284c6ab4b0500a7" args="(void) const " -->
int&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classstk_1_1Socket.html#be3040ecfff6ce921284c6ab4b0500a7">port</a> (void) const </td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Return the socket port number. <br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="7938202181552306d0ea74c6c04abf4a"></a><!-- doxytag: member="stk::Socket::writeBuffer" ref="7938202181552306d0ea74c6c04abf4a" args="(const void *buffer, long bufferSize, int flags=0)=0" -->
virtual int&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classstk_1_1Socket.html#7938202181552306d0ea74c6c04abf4a">writeBuffer</a> (const void *buffer, long bufferSize, int flags=0)=0</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Write a buffer over the socket connection. Returns the number of bytes written or -1 if an error occurs. <br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="a99d0f4e1c0ebae768a9f3f124364906"></a><!-- doxytag: member="stk::Socket::readBuffer" ref="a99d0f4e1c0ebae768a9f3f124364906" args="(void *buffer, long bufferSize, int flags=0)=0" -->
virtual int&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classstk_1_1Socket.html#a99d0f4e1c0ebae768a9f3f124364906">readBuffer</a> (void *buffer, long bufferSize, int flags=0)=0</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Read an input buffer, up to length <em>bufferSize</em>. Returns the number of bytes read or -1 if an error occurs. <br></td></tr>
<tr><td colspan="2"><br><h2>Static Public Member Functions</h2></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="816c3dfae2549db692944042821d6019"></a><!-- doxytag: member="stk::Socket::close" ref="816c3dfae2549db692944042821d6019" args="(int socket)" -->
static void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classstk_1_1Socket.html#816c3dfae2549db692944042821d6019">close</a> (int socket)</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Close the socket. <br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="61375099d0d0811bf79c894587cc3724"></a><!-- doxytag: member="stk::Socket::isValid" ref="61375099d0d0811bf79c894587cc3724" args="(int socket)" -->
static bool&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classstk_1_1Socket.html#61375099d0d0811bf79c894587cc3724">isValid</a> (int socket)</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Returns true if the socket descriptor is valid. <br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="12f0abb799fbf7d5d2ee6364627cb6ac"></a><!-- doxytag: member="stk::Socket::setBlocking" ref="12f0abb799fbf7d5d2ee6364627cb6ac" args="(int socket, bool enable)" -->
static void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classstk_1_1Socket.html#12f0abb799fbf7d5d2ee6364627cb6ac">setBlocking</a> (int socket, bool enable)</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">If enable = false, the socket is set to non-blocking mode. When first created, sockets are by default in blocking mode. <br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="a9687b9332995717aa95022a133254a2"></a><!-- doxytag: member="stk::Socket::writeBuffer" ref="a9687b9332995717aa95022a133254a2" args="(int socket, const void *buffer, long bufferSize, int flags)" -->
static int&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classstk_1_1Socket.html#a9687b9332995717aa95022a133254a2">writeBuffer</a> (int socket, const void *buffer, long bufferSize, int flags)</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Write a buffer via the specified socket. Returns the number of bytes written or -1 if an error occurs. <br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="742cdc0d2ef4aed91c61f87be67cb38e"></a><!-- doxytag: member="stk::Socket::readBuffer" ref="742cdc0d2ef4aed91c61f87be67cb38e" args="(int socket, void *buffer, long bufferSize, int flags)" -->
static int&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classstk_1_1Socket.html#742cdc0d2ef4aed91c61f87be67cb38e">readBuffer</a> (int socket, void *buffer, long bufferSize, int flags)</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Read a buffer via the specified socket. Returns the number of bytes read or -1 if an error occurs. <br></td></tr>
<p><a href="classstk_1_1Socket-members.html">List of all members.</a></p>
<table border="0" cellpadding="0" cellspacing="0">
<tr><td colspan="2"><h2>Public Member Functions</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a2558d3b2001c07eeae9d3e301df399fe"></a><!-- doxytag: member="stk::Socket::Socket" ref="a2558d3b2001c07eeae9d3e301df399fe" args="()" -->
&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classstk_1_1Socket.html#a2558d3b2001c07eeae9d3e301df399fe">Socket</a> ()</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Class constructor. <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a8fb79fcfba5d1438575e0fb933f8b37b"></a><!-- doxytag: member="stk::Socket::~Socket" ref="a8fb79fcfba5d1438575e0fb933f8b37b" args="()" -->
virtual&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classstk_1_1Socket.html#a8fb79fcfba5d1438575e0fb933f8b37b">~Socket</a> ()</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Class destructor. <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="aeae0c6721248eecd5dae0b77ea66cb2c"></a><!-- doxytag: member="stk::Socket::id" ref="aeae0c6721248eecd5dae0b77ea66cb2c" args="(void) const " -->
int&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classstk_1_1Socket.html#aeae0c6721248eecd5dae0b77ea66cb2c">id</a> (void) const </td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Return the socket descriptor. <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="abe3040ecfff6ce921284c6ab4b0500a7"></a><!-- doxytag: member="stk::Socket::port" ref="abe3040ecfff6ce921284c6ab4b0500a7" args="(void) const " -->
int&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classstk_1_1Socket.html#abe3040ecfff6ce921284c6ab4b0500a7">port</a> (void) const </td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Return the socket port number. <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a7938202181552306d0ea74c6c04abf4a"></a><!-- doxytag: member="stk::Socket::writeBuffer" ref="a7938202181552306d0ea74c6c04abf4a" args="(const void *buffer, long bufferSize, int flags=0)=0" -->
virtual int&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classstk_1_1Socket.html#a7938202181552306d0ea74c6c04abf4a">writeBuffer</a> (const void *buffer, long bufferSize, int flags=0)=0</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Write a buffer over the socket connection. Returns the number of bytes written or -1 if an error occurs. <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="aa99d0f4e1c0ebae768a9f3f124364906"></a><!-- doxytag: member="stk::Socket::readBuffer" ref="aa99d0f4e1c0ebae768a9f3f124364906" args="(void *buffer, long bufferSize, int flags=0)=0" -->
virtual int&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classstk_1_1Socket.html#aa99d0f4e1c0ebae768a9f3f124364906">readBuffer</a> (void *buffer, long bufferSize, int flags=0)=0</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Read an input buffer, up to length <em>bufferSize</em>. Returns the number of bytes read or -1 if an error occurs. <br/></td></tr>
<tr><td colspan="2"><h2>Static Public Member Functions</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a816c3dfae2549db692944042821d6019"></a><!-- doxytag: member="stk::Socket::close" ref="a816c3dfae2549db692944042821d6019" args="(int socket)" -->
static void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classstk_1_1Socket.html#a816c3dfae2549db692944042821d6019">close</a> (int socket)</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Close the socket. <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a61375099d0d0811bf79c894587cc3724"></a><!-- doxytag: member="stk::Socket::isValid" ref="a61375099d0d0811bf79c894587cc3724" args="(int socket)" -->
static bool&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classstk_1_1Socket.html#a61375099d0d0811bf79c894587cc3724">isValid</a> (int socket)</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Returns true if the socket descriptor is valid. <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a12f0abb799fbf7d5d2ee6364627cb6ac"></a><!-- doxytag: member="stk::Socket::setBlocking" ref="a12f0abb799fbf7d5d2ee6364627cb6ac" args="(int socket, bool enable)" -->
static void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classstk_1_1Socket.html#a12f0abb799fbf7d5d2ee6364627cb6ac">setBlocking</a> (int socket, bool enable)</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">If enable = false, the socket is set to non-blocking mode. When first created, sockets are by default in blocking mode. <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="aa9687b9332995717aa95022a133254a2"></a><!-- doxytag: member="stk::Socket::writeBuffer" ref="aa9687b9332995717aa95022a133254a2" args="(int socket, const void *buffer, long bufferSize, int flags)" -->
static int&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classstk_1_1Socket.html#aa9687b9332995717aa95022a133254a2">writeBuffer</a> (int socket, const void *buffer, long bufferSize, int flags)</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Write a buffer via the specified socket. Returns the number of bytes written or -1 if an error occurs. <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a742cdc0d2ef4aed91c61f87be67cb38e"></a><!-- doxytag: member="stk::Socket::readBuffer" ref="a742cdc0d2ef4aed91c61f87be67cb38e" args="(int socket, void *buffer, long bufferSize, int flags)" -->
static int&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classstk_1_1Socket.html#a742cdc0d2ef4aed91c61f87be67cb38e">readBuffer</a> (int socket, void *buffer, long bufferSize, int flags)</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Read a buffer via the specified socket. Returns the number of bytes read or -1 if an error occurs. <br/></td></tr>
</table>
<hr><a name="_details"></a><h2>Detailed Description</h2>
STK internet socket abstract base class.
<p>
This class provides common functionality for TCP and UDP internet socket server and client subclasses. This class also provides a number of static functions for use with external socket descriptors.<p>
by Perry R. Cook and Gary P. Scavone, 1995 - 2009. <hr>The documentation for this class was generated from the following file:<ul>
<li><a class="el" href="Socket_8h-source.html">Socket.h</a></ul>
<hr/><a name="_details"></a><h2>Detailed Description</h2>
<p>STK internet socket abstract base class. </p>
<p>This class provides common functionality for TCP and UDP internet socket server and client subclasses. This class also provides a number of static functions for use with external socket descriptors.</p>
<p>by Perry R. Cook and Gary P. Scavone, 1995 - 2010. </p>
<hr/>The documentation for this class was generated from the following file:<ul>
<li><a class="el" href="Socket_8h_source.html">Socket.h</a></li>
</ul>
</div>
<HR>
<table>
<tr><td><A HREF="http://ccrma.stanford.edu/software/stk/"><I>The Synthesis ToolKit in C++ (STK)</I></A></td></tr>
<tr><td>&copy;1995-2009 Perry R. Cook and Gary P. Scavone. All Rights Reserved.</td></tr>
<tr><td>&copy;1995-2010 Perry R. Cook and Gary P. Scavone. All Rights Reserved.</td></tr>
</table>
</BODY>