1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
|
<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.6.2 -->
<div class="navpath"><a class="el" href="namespacestk.html">stk</a>::<a class="el" href="classstk_1_1TcpClient.html">TcpClient</a>
</div>
<div class="contents">
<h1>stk::TcpClient Class Reference</h1><!-- doxytag: class="stk::TcpClient" --><!-- doxytag: inherits="stk::Socket" -->
<p>STK TCP socket client class.
<a href="#_details">More...</a></p>
<p><code>#include <<a class="el" href="TcpClient_8h_source.html">TcpClient.h</a>></code></p>
<div class="dynheader">
Inheritance diagram for stk::TcpClient:</div>
<div class="dynsection">
<div class="center">
<img src="classstk_1_1TcpClient.png" usemap="#stk::TcpClient_map" alt=""/>
<map id="stk::TcpClient_map" name="stk::TcpClient_map">
<area href="classstk_1_1Socket.html" alt="stk::Socket" shape="rect" coords="0,56,86,80"/>
<area href="classstk_1_1Stk.html" alt="stk::Stk" shape="rect" coords="0,0,86,24"/>
</map>
</div>
</div>
<p><a href="classstk_1_1TcpClient-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"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classstk_1_1TcpClient.html#a1e1e2cf0981774147d516efcaf12e786">TcpClient</a> (int port, std::string hostname="localhost")</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Default class constructor creates a socket client connection to the specified host and port. <a href="#a1e1e2cf0981774147d516efcaf12e786"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ae4d515e14471f5d65730c6ccccb6f653"></a><!-- doxytag: member="stk::TcpClient::~TcpClient" ref="ae4d515e14471f5d65730c6ccccb6f653" args="()" -->
</td><td class="memItemRight" valign="bottom"><a class="el" href="classstk_1_1TcpClient.html#ae4d515e14471f5d65730c6ccccb6f653">~TcpClient</a> ()</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">The class destructor closes the socket instance, breaking any existing connections. <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="classstk_1_1TcpClient.html#a46ff34075ef3a0342c396af5fe1aedda">connect</a> (int port, std::string hostname="localhost")</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Connect the socket client to the specified host and port and returns the resulting socket descriptor. <a href="#a46ff34075ef3a0342c396af5fe1aedda"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="af101788bd77c2026cc3ade330caf7fc5"></a><!-- doxytag: member="stk::TcpClient::writeBuffer" ref="af101788bd77c2026cc3ade330caf7fc5" args="(const void *buffer, long bufferSize, int flags=0)" -->
int </td><td class="memItemRight" valign="bottom"><a class="el" href="classstk_1_1TcpClient.html#af101788bd77c2026cc3ade330caf7fc5">writeBuffer</a> (const void *buffer, long bufferSize, int flags=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" align="right" valign="top"><a class="anchor" id="af0c6f44c9f3d3812a7d0cb79f94eba5f"></a><!-- doxytag: member="stk::TcpClient::readBuffer" ref="af0c6f44c9f3d3812a7d0cb79f94eba5f" args="(void *buffer, long bufferSize, int flags=0)" -->
int </td><td class="memItemRight" valign="bottom"><a class="el" href="classstk_1_1TcpClient.html#af0c6f44c9f3d3812a7d0cb79f94eba5f">readBuffer</a> (void *buffer, long bufferSize, int flags=0)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Read a buffer from the socket connection, up to length <em>bufferSize</em>. 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>
<p>STK TCP socket client class. </p>
<p>This class provides a uniform cross-platform TCP socket client interface. Methods are provided for reading or writing data buffers to/from connections.</p>
<p>TCP sockets are reliable and connection-oriented. A TCP socket client must be connected to a TCP server before data can be sent or received. Data delivery is guaranteed in order, without loss, error, or duplication. That said, TCP transmissions tend to be slower than those using the UDP protocol and data sent with multiple <em>write()</em> calls can be arbitrarily combined by the underlying system.</p>
<p>The user is responsible for checking the values returned by the read/write methods. Values less than or equal to zero indicate a closed or lost connection or the occurence of an error.</p>
<p>by Perry R. Cook and Gary P. Scavone, 1995-2012. </p>
<hr/><h2>Constructor & Destructor Documentation</h2>
<a class="anchor" id="a1e1e2cf0981774147d516efcaf12e786"></a><!-- doxytag: member="stk::TcpClient::TcpClient" ref="a1e1e2cf0981774147d516efcaf12e786" args="(int port, std::string hostname="localhost")" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">stk::TcpClient::TcpClient </td>
<td>(</td>
<td class="paramtype">int </td>
<td class="paramname"> <em>port</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">std::string </td>
<td class="paramname"> <em>hostname</em> = <code>"localhost"</code></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Default class constructor creates a socket client connection to the specified host and port. </p>
<p>An <a class="el" href="classstk_1_1StkError.html" title="STK error handling class.">StkError</a> will be thrown if a socket error occurs during instantiation. </p>
</div>
</div>
<hr/><h2>Member Function Documentation</h2>
<a class="anchor" id="a46ff34075ef3a0342c396af5fe1aedda"></a><!-- doxytag: member="stk::TcpClient::connect" ref="a46ff34075ef3a0342c396af5fe1aedda" args="(int port, std::string hostname="localhost")" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int stk::TcpClient::connect </td>
<td>(</td>
<td class="paramtype">int </td>
<td class="paramname"> <em>port</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">std::string </td>
<td class="paramname"> <em>hostname</em> = <code>"localhost"</code></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Connect the socket client to the specified host and port and returns the resulting socket descriptor. </p>
<p>If the socket client is already connected, that connection is terminated and a new connection is attempted. An <a class="el" href="classstk_1_1StkError.html" title="STK error handling class.">StkError</a> will be thrown if a socket error occurs. </p>
</div>
</div>
<hr/>The documentation for this class was generated from the following file:<ul>
<li><a class="el" href="TcpClient_8h_source.html">TcpClient.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>©1995-2012 Perry R. Cook and Gary P. Scavone. All Rights Reserved.</td></tr>
</table>
</BODY>
</HTML>
|
