Files
Examples/Java/Processing/processing-3.3.6/modes/java/reference/libraries/net/Client.html
2018-04-20 10:15:15 +01:00

244 lines
9.1 KiB
HTML

<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
<head>
<title>Client \ Language (API) \ Processing 2+</title>
<link rel="icon" href="/favicon.ico" type="image/x-icon" />
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<meta name="Author" content="Processing Foundation" />
<meta name="Publisher" content="Processing Foundation" />
<meta name="Keywords" content="Processing, Sketchbook, Programming, Coding, Code, Art, Design" />
<meta name="Description" content="Processing is a flexible software sketchbook and a language for learning how to code within the context of the visual arts. Since 2001, Processing has promoted software literacy within the visual arts and visual literacy within technology." />
<meta name="Copyright" content="All contents copyright the Processing Foundation, Ben Fry, Casey Reas, and the MIT Media Laboratory" />
<script src="../../javascript/modernizr-2.6.2.touch.js" type="text/javascript"></script>
<link href="../../css/style.css" rel="stylesheet" type="text/css" />
</head>
<body id="Langauge-en" onload="" >
<!-- ==================================== PAGE ============================ -->
<div id="container">
<!-- ==================================== HEADER ============================ -->
<div id="ribbon">
<ul class="left">
<li class="highlight"><a href="http://processing.org/">Processing</a></li>
<li><a href="http://p5js.org/">p5.js</a></li>
<li><a href="http://py.processing.org/">Processing.py</a></li>
<li><a href="http://android.processing.org/">Processing for Android</a></li>
</ul>
<ul class="right">
<li><a href="https://processingfoundation.org/">Processing Foundation</a></li>
</ul>
<div class="clear"></div>
</div>
<div id="header">
<a href="/" title="Back to the Processing cover."><div class="processing-logo no-cover" alt="Processing cover"></div></a>
<form name="search" method="get" action="//www.google.com/search">
<p><input type="hidden" name="as_sitesearch" value="processing.org" />
<input type="text" name="as_q" value="" size="20" class="text" />
<input type="submit" value=" " /></p>
</form>
</div>
<a id="TOP" name="TOP"></a>
<div id="navigation">
<div class="navBar" id="mainnav">
<a href="../../index.html" >Language</a><br>
<a href="../../libraries/index.html" class='active'>Libraries</a><br>
<a href="../../tools/index.html">Tools</a><br>
<a href="../../environment/index.html">Environment</a><br>
</div>
<script> document.querySelectorAll(".processing-logo")[0].className = "processing-logo"; </script>
</div>
<!-- ==================================== CONTENT - Headers ============================ -->
<div class="content">
<p class="ref-notice">This reference is for Processing 3.0+. If you have a previous version, use the reference included with your software in the Help menu. If you see any errors or have suggestions, <a href="https://github.com/processing/processing-docs/issues?state=open">please let us know</a>. If you prefer a more technical reference, visit the <a href="http://processing.github.io/processing-javadocs/core/">Processing Core Javadoc</a> and <a href="http://processing.github.io/processing-javadocs/libraries/">Libraries Javadoc</a>.</p>
<table cellpadding="0" cellspacing="0" border="0" class="ref-item">
<tr class="name-row">
<th scope="row">Name</th>
<td><h3>Client</h3></td>
</tr>
<tr class=""><th scope="row">Examples</th><td><div class="example"><pre >
import processing.net.*;
Client myClient;
int dataIn;
void setup() {
size(200, 200);
// Connect to the local machine at port 5204.
// This example will not run if you haven't
// previously started a server on this port.
myClient = new Client(this, "127.0.0.1", 5204);
}
void draw() {
if (myClient.available() > 0) {
dataIn = myClient.read();
}
background(dataIn);
}
</pre></div>
</td></tr>
<tr class="">
<th scope="row">Description</th>
<td>
A client connects to a server and sends data back and forth. If anything goes wrong with the connection, for example the host is not there or is listening on a different port, an exception is thrown.
</td>
</tr>
<tr class=""><th scope="row">Methods</th><td><table cellpadding="0" cellspacing="0" border="0"><tr class="">
<th scope="row"><a href="Client_stop_.html">stop()</a></th>
<td>Disconnects from the server</td>
</tr>
<tr class="">
<th scope="row"><a href="Client_active_.html">active()</a></th>
<td>Returns true if this client is still active</td>
</tr>
<tr class="">
<th scope="row"><a href="Client_ip_.html">ip()</a></th>
<td>Returns the IP address of the machine as a String</td>
</tr>
<tr class="">
<th scope="row"><a href="Client_available_.html">available()</a></th>
<td>Returns the number of bytes in the buffer waiting to be read</td>
</tr>
<tr class="">
<th scope="row"><a href="Client_clear_.html">clear()</a></th>
<td>Clears the buffer</td>
</tr>
<tr class="">
<th scope="row"><a href="Client_read_.html">read()</a></th>
<td>Returns a value from the buffer</td>
</tr>
<tr class="">
<th scope="row"><a href="Client_readChar_.html">readChar()</a></th>
<td>Returns the next byte in the buffer as a char</td>
</tr>
<tr class="">
<th scope="row"><a href="Client_readBytes_.html">readBytes()</a></th>
<td>Reads everything in the buffer</td>
</tr>
<tr class="">
<th scope="row"><a href="Client_readBytesUntil_.html">readBytesUntil()</a></th>
<td>Reads from the buffer of bytes up to and including a particular character</td>
</tr>
<tr class="">
<th scope="row"><a href="Client_readString_.html">readString()</a></th>
<td>Returns the buffer as a String</td>
</tr>
<tr class="">
<th scope="row"><a href="Client_readStringUntil_.html">readStringUntil()</a></th>
<td>Returns the buffer as a String up to and including a particular character</td>
</tr>
<tr class="">
<th scope="row"><a href="Client_write_.html">write()</a></th>
<td>Writes bytes, chars, ints, bytes[], Strings</td>
</tr></table></td></tr>
<tr class=""><th scope="row">Constructor</th><td><pre>Client(<kbd>parent</kbd>, <kbd>host</kbd>, <kbd>port</kbd>)
Client(<kbd>parent</kbd>, <kbd>socket</kbd>)
</pre></td></tr>
<tr class=""> <th scope="row">Parameters</th><td><table cellpadding="0" cellspacing="0" border="0"><tr class="">
<th scope="row" class="code">parent</th>
<td>PApplet: typically use "this"</td>
</tr>
<tr class="">
<th scope="row" class="code">host</th>
<td>String: address of the server</td>
</tr>
<tr class="">
<th scope="row" class="code">port</th>
<td>int: port to read/write from on the server</td>
</tr>
<tr class="">
<th scope="row" class="code">socket</th>
<td>Socket: any object of type Socket</td>
</tr></table></td> </tr>
<tr class=""><th scope="row">Related</th><td><a class="code" href="clientEvent_.html">clientEvent()</a><br /></td></tr>
</table>
Updated on April 30, 2017 02:33:21pm EDT<br /><br />
<!-- Creative Commons License -->
<div class="license">
<a rel="license" href="//creativecommons.org/licenses/by-nc-sa/4.0/"><img alt="Creative Commons License" style="border: none" src="https://licensebuttons.net/l/by-nc-sa/4.0/88x31.png" /></a>
</div>
<!--
<?xpacket begin='' id=''?>
<x:xmpmeta xmlns:x='adobe:ns:meta/'>
<rdf:RDF xmlns:rdf='http://www.w3.org/1999/02/22-rdf-syntax-ns#'>
<rdf:Description rdf:about=''
xmlns:xapRights='http://ns.adobe.com/xap/1.0/rights/'>
<xapRights:Marked>True</xapRights:Marked>
</rdf:Description>
<rdf:Description rdf:about=''
xmlns:xapRights='http://ns.adobe.com/xap/1.0/rights/'
>
<xapRights:UsageTerms>
<rdf:Alt>
<rdf:li xml:lang='x-default' >This work is licensed under a &lt;a rel=&#34;license&#34; href=&#34;http://creativecommons.org/licenses/by-nc-sa/4.0/&#34;&gt;Creative Commons Attribution-NonCommercial-ShareAlike 4.0 International License&lt;/a&gt;.</rdf:li>
<rdf:li xml:lang='en' >This work is licensed under a &lt;a rel=&#34;license&#34; href=&#34;http://creativecommons.org/licenses/by-nc-sa/4.0/&#34;&gt;Creative Commons Attribution-NonCommercial-ShareAlike 4.0 International License&lt;/a&gt;.</rdf:li>
</rdf:Alt>
</xapRights:UsageTerms>
</rdf:Description>
<rdf:Description rdf:about=''
xmlns:cc='http://creativecommons.org/ns#'>
<cc:license rdf:resource='http://creativecommons.org/licenses/by-nc-sa/4.0/'/>
</rdf:Description>
</rdf:RDF>
</x:xmpmeta>
<?xpacket end='r'?>
-->
</div>
<!-- ==================================== FOOTER ============================ -->
<div id="footer">
<div id="copyright">Processing is an open project intiated by <a href="http://benfry.com/">Ben Fry</a> and <a href="http://reas.com">Casey Reas</a>. It is developed by a <a href="../../about/people.html">team of volunteers</a>. </div>
<div id="colophon">
<a href="../../copyright.html">&copy; Info</a>
</div>
</div>
</div>
<script src="../../javascript/jquery-1.9.1.min.js"></script>
<script src="../../javascript/site.js" type="text/javascript"></script>
</body>
</html>