mirror of
https://github.com/thestk/stk
synced 2026-01-13 13:01:52 +00:00
88 lines
7.6 KiB
HTML
88 lines
7.6 KiB
HTML
<HTML>
|
|
<HEAD>
|
|
<TITLE>The Synthesis ToolKit in C++ (STK)</TITLE>
|
|
<LINK HREF="doxygen.css" REL="stylesheet" TYPE="text/css">
|
|
</HEAD>
|
|
<BODY BGCOLOR="#FFFFFF">
|
|
<CENTER>
|
|
<img src="princeton.gif"> <img src="ccrma.gif"> <img src="mcgill.gif"><P>
|
|
<a class="qindex" href="index.html">Home</a> <a class="qindex" href="information.html">Information</a> <a class="qindex" href="classes.html">Classes</a> <a class="qindex" href="download.html">Download</a> <a class="qindex" href="usage.html">Usage</a> <a class="qindex" href="maillist.html">Mail List</a> <a class="qindex" href="system.html">Requirements</a> <a class="qindex" href="links.html">Links</a> <a class="qindex" href="faq.html">FAQ</a> <a class="qindex" href="tutorial.html">Tutorial</a></CENTER>
|
|
<HR>
|
|
<!-- Generated by Doxygen 1.4.4 -->
|
|
<h1>Socket Class Reference</h1><!-- doxytag: class="Socket" --><!-- doxytag: inherits="Stk" --><code>#include <<a class="el" href="Socket_8h-source.html">Socket.h</a>></code>
|
|
<p>
|
|
<p>Inheritance diagram for Socket:
|
|
<p><center><img src="classSocket.png" usemap="#Socket_map" border="0" alt=""></center>
|
|
<map name="Socket_map">
|
|
<area href="classStk.html" alt="Stk" shape="rect" coords="82,0,154,24">
|
|
<area href="classTcpClient.html" alt="TcpClient" shape="rect" coords="0,112,72,136">
|
|
<area href="classTcpServer.html" alt="TcpServer" shape="rect" coords="82,112,154,136">
|
|
<area href="classUdpSocket.html" alt="UdpSocket" shape="rect" coords="164,112,236,136">
|
|
</map>
|
|
<a href="classSocket-members.html">List of all members.</a><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 - 2007.
|
|
<p>
|
|
<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="a0"></a><!-- doxytag: member="Socket::Socket" ref="a0" args="()" -->
|
|
</td><td class="memItemRight" valign="bottom"><a class="el" href="classSocket.html#a0">Socket</a> ()</td></tr>
|
|
|
|
<tr><td class="mdescLeft"> </td><td class="mdescRight">Class constructor. <br></td></tr>
|
|
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="a1"></a><!-- doxytag: member="Socket::~Socket" ref="a1" args="()" -->
|
|
virtual </td><td class="memItemRight" valign="bottom"><a class="el" href="classSocket.html#a1">~Socket</a> ()</td></tr>
|
|
|
|
<tr><td class="mdescLeft"> </td><td class="mdescRight">Class destructor. <br></td></tr>
|
|
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="a2"></a><!-- doxytag: member="Socket::id" ref="a2" args="(void) const " -->
|
|
int </td><td class="memItemRight" valign="bottom"><a class="el" href="classSocket.html#a2">id</a> (void) const </td></tr>
|
|
|
|
<tr><td class="mdescLeft"> </td><td class="mdescRight">Return the socket descriptor. <br></td></tr>
|
|
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="a3"></a><!-- doxytag: member="Socket::port" ref="a3" args="(void) const " -->
|
|
int </td><td class="memItemRight" valign="bottom"><a class="el" href="classSocket.html#a3">port</a> (void) const </td></tr>
|
|
|
|
<tr><td class="mdescLeft"> </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="a4"></a><!-- doxytag: member="Socket::writeBuffer" ref="a4" args="(const void *buffer, long bufferSize, int flags=0)=0" -->
|
|
virtual int </td><td class="memItemRight" valign="bottom"><a class="el" href="classSocket.html#a4">writeBuffer</a> (const void *buffer, long bufferSize, int flags=0)=0</td></tr>
|
|
|
|
<tr><td class="mdescLeft"> </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="a5"></a><!-- doxytag: member="Socket::readBuffer" ref="a5" args="(void *buffer, long bufferSize, int flags=0)=0" -->
|
|
virtual int </td><td class="memItemRight" valign="bottom"><a class="el" href="classSocket.html#a5">readBuffer</a> (void *buffer, long bufferSize, int flags=0)=0</td></tr>
|
|
|
|
<tr><td class="mdescLeft"> </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="e0"></a><!-- doxytag: member="Socket::close" ref="e0" args="(int socket)" -->
|
|
static void </td><td class="memItemRight" valign="bottom"><a class="el" href="classSocket.html#e0">close</a> (int socket)</td></tr>
|
|
|
|
<tr><td class="mdescLeft"> </td><td class="mdescRight">Close the socket. <br></td></tr>
|
|
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="e1"></a><!-- doxytag: member="Socket::isValid" ref="e1" args="(int socket)" -->
|
|
static bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classSocket.html#e1">isValid</a> (int socket)</td></tr>
|
|
|
|
<tr><td class="mdescLeft"> </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="e2"></a><!-- doxytag: member="Socket::setBlocking" ref="e2" args="(int socket, bool enable)" -->
|
|
static void </td><td class="memItemRight" valign="bottom"><a class="el" href="classSocket.html#e2">setBlocking</a> (int socket, bool enable)</td></tr>
|
|
|
|
<tr><td class="mdescLeft"> </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="e3"></a><!-- doxytag: member="Socket::writeBuffer" ref="e3" args="(int socket, const void *buffer, long bufferSize, int flags)" -->
|
|
static int </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"> </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="e4"></a><!-- doxytag: member="Socket::readBuffer" ref="e4" args="(int socket, void *buffer, long bufferSize, int flags)" -->
|
|
static int </td><td class="memItemRight" valign="bottom"><a class="el" href="classSocket.html#e4">readBuffer</a> (int socket, void *buffer, long bufferSize, int flags)</td></tr>
|
|
|
|
<tr><td class="mdescLeft"> </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>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>
|
|
|
|
<table>
|
|
<tr><td><A HREF="http://ccrma.stanford.edu/software/stk/"><I>The Synthesis ToolKit in C++ (STK)</I></A></td></tr>
|
|
<tr><td>©1995-2007 Perry R. Cook and Gary P. Scavone. All Rights Reserved.</td></tr>
|
|
</table>
|
|
|
|
</BODY>
|
|
</HTML>
|