e1lama/stk
1
0
Fork 0
mirror of https://github.com/thestk/stk synced 2026-01-15 14:01:52 +00:00
Code Issues Packages Projects Releases Wiki Activity

Release 4.1.3 tarball

Browse Source
This commit is contained in:
Gary Scavone
2013-09-29 23:38:16 +02:00
committed by Stephen Sinclair
parent 503ed3cc9f
commit e11bff2fe8
275 changed files with 1190 additions and 1228 deletions
Download Patch File Download Diff File Expand all files Collapse all files

22
doc/html/classSocket.html
View File

@@ -8,7 +8,7 @@
<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="tutorial.html">Tutorial</a></CENTER>
<HR>
<!-- Generated by Doxygen 1.3.6 -->
<!-- Generated by Doxygen 1.3.4 -->
<h1>Socket Class Reference</h1>STK TCP socket client/server class.
<a href="#_details">More...</a>
<p>
@@ -24,17 +24,17 @@
<tr><td colspan=2><br><h2>Public Member Functions</h2></td></tr>
<tr><td class="memItemLeft" nowrap align=right valign=top>&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classSocket.html#a0">Socket</a> (int port=2006)</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Default constructor which creates a local socket server on port 2006 (or the specified port number). <a href="#a0"></a><br><br></td></tr>
<tr><td class="memItemLeft" nowrap align=right valign=top>&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classSocket.html#a1">Socket</a> (int port, const char *hostname)</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Default constructor which creates a local socket server on port 2006 (or the specified port number). </em> <a href="#a0"></a><em><br><br></td></tr>
<tr><td class="memItemLeft" nowrap align=right valign=top>&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classSocket.html#a1">Socket</a> (int port, const char *hostname)</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Class constructor which creates a socket client connection to the specified host and port. <a href="#a1"></a><br><br></td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Class constructor which creates a socket client connection to the specified host and port. </em> <a href="#a1"></a><em><br><br></td></tr>
<tr><td class="memItemLeft" nowrap align=right valign=top><a class="anchor" name="a2" doxytag="Socket::~Socket" ></a>
&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classSocket.html#a2">~Socket</a> ()</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">The class destructor closes the socket instance, breaking any existing connections. <br><br></td></tr>
<tr><td class="memItemLeft" nowrap align=right valign=top>int&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classSocket.html#a3">connect</a> (int port, const char *hostname="localhost")</td></tr>
<tr><td class="memItemLeft" nowrap align=right valign=top>int&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classSocket.html#a3">connect</a> (int port, const char *hostname="localhost")</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Connect a socket client to the specified host and port and returns the resulting socket descriptor. <a href="#a3"></a><br><br></td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Connect a socket client to the specified host and port and returns the resulting socket descriptor. </em> <a href="#a3"></a><em><br><br></td></tr>
<tr><td class="memItemLeft" nowrap align=right valign=top><a class="anchor" name="a4" doxytag="Socket::close" ></a>
void&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classSocket.html#a4">close</a> (void)</td></tr>
@@ -49,9 +49,9 @@ int&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classSo
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Return the server/client port number. <br><br></td></tr>
<tr><td class="memItemLeft" nowrap align=right valign=top>int&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classSocket.html#a7">accept</a> (void)</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">If this is a socket server, extract the first pending connection request from the queue and create a new connection, returning the descriptor for the accepted socket. <a href="#a7"></a><br><br></td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">If this is a socket server, extract the first pending connection request from the queue and create a new connection, returning the descriptor for the accepted socket. </em> <a href="#a7"></a><em><br><br></td></tr>
<tr><td class="memItemLeft" nowrap align=right valign=top><a class="anchor" name="a8" doxytag="Socket::writeBuffer" ></a>
int&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classSocket.html#a8">writeBuffer</a> (const void *buffer, long bufferSize, int flags=0)</td></tr>
int&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classSocket.html#a8">writeBuffer</a> (const void *buffer, long bufferSize, int flags=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><br></td></tr>
<tr><td class="memItemLeft" nowrap align=right valign=top><a class="anchor" name="a9" doxytag="Socket::readBuffer" ></a>
@@ -72,7 +72,7 @@ bool&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classS
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Returns TRUE is the socket descriptor is valid. <br><br></td></tr>
<tr><td class="memItemLeft" nowrap align=right valign=top><a class="anchor" name="e3" doxytag="Socket::writeBuffer" ></a>
int&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classSocket.html#e3">writeBuffer</a> (int socket, const void *buffer, long bufferSize, int flags)</td></tr>
int&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classSocket.html#e3">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><br></td></tr>
<tr><td class="memItemLeft" nowrap align=right valign=top><a class="anchor" name="e4" doxytag="Socket::readBuffer" ></a>
@@ -133,7 +133,7 @@ An <a class="el" href="classStkError.html">StkError</a> will be thrown if a sock
<td class="mdname" nowrap> <em>port</em>, </td>
</tr>
<tr>
<td class="md" nowrap align="right"></td>
<td></td>
<td></td>
<td class="md" nowrap>const char *&nbsp;</td>
<td class="mdname" nowrap> <em>hostname</em></td>
@@ -174,7 +174,7 @@ An <a class="el" href="classStkError.html">StkError</a> will be thrown if a sock
<td class="mdname" nowrap> <em>port</em>, </td>
</tr>
<tr>
<td class="md" nowrap align="right"></td>
<td></td>
<td></td>
<td class="md" nowrap>const char *&nbsp;</td>
<td class="mdname" nowrap> <em>hostname</em> = "localhost"</td>