processing.net

Class Client

Object

Client

All Implemented Interfaces:

Runnable

public class Client
extends Object
implements Runnable

( begin auto-generated from Client.xml ) 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. ( end auto-generated )

In brief:

The client class is used to create client Objects which connect to a server to exchange data.

Usage:

Application

Field Summary

Fields

Modifier and Type	Field and Description
InputStream	input
OutputStream	output

Constructor Summary

Constructors

Constructor and Description
Client(PApplet parent, Socket socket)
Client(PApplet parent, String host, int port)

Method Summary

Modifier and Type	Method and Description
boolean	active() ( begin auto-generated from Client_active.xml ) Returns true if this client is still active and hasn't run into any trouble.
int	available() ( begin auto-generated from Client_available.xml ) Returns the number of bytes available.
void	clear() ( begin auto-generated from Client_clear.xml ) Empty the buffer, removes all the data stored there.
void	dispose() Disconnect from the server: internal use only.
String	ip() ( begin auto-generated from Client_ip.xml ) Returns the IP address of the computer to which the Client is attached.
int	read() ( begin auto-generated from Client_read.xml ) Returns a number between 0 and 255 for the next byte that's waiting in the buffer.
byte[]	readBytes() ( begin auto-generated from Client_readBytes.xml ) Reads a group of bytes from the buffer.
int	readBytes(byte[] bytebuffer) Advanced
byte[]	readBytes(int max) Advanced
byte[]	readBytesUntil(int interesting) ( begin auto-generated from Client_readBytesUntil.xml ) Reads from the port into a buffer of bytes up to and including a particular character.
int	readBytesUntil(int interesting, byte[] byteBuffer) Advanced
char	readChar() ( begin auto-generated from Client_readChar.xml ) Returns the next byte in the buffer as a char.
String	readString() ( begin auto-generated from Client_readString.xml ) Returns the all the data from the buffer as a String.
String	readStringUntil(int interesting) ( begin auto-generated from Client_readStringUntil.xml ) Combination of readBytesUntil() and readString().
void	run()
void	stop() ( begin auto-generated from Client_stop.xml ) Disconnects from the server.
void	write(byte[] data)
void	write(int data) ( begin auto-generated from Client_write.xml ) Writes data to a server specified when constructing the client.
void	write(String data) Advanced

Methods inherited from class Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

input

public InputStream input

output

public OutputStream output

Constructor Detail

Client

public Client(PApplet parent,
              String host,
              int port)

Parameters:

parent - typically use "this"

host - address of the server

port - port to read/write from on the server

Client

public Client(PApplet parent,
              Socket socket)
       throws IOException

Parameters:

socket - any object of type Socket

Throws:

IOException

Method Detail

stop

public void stop()

( begin auto-generated from Client_stop.xml ) Disconnects from the server. Use to shut the connection when you're finished with the Client. ( end auto-generated )

In brief:

Disconnects from the server

Usage:

application

dispose

public void dispose()

Disconnect from the server: internal use only.

This should only be called by the internal functions in PApplet, use stop() instead from within your own applets.

run

public void run()

Specified by:

run in interface Runnable

active

public boolean active()

( begin auto-generated from Client_active.xml ) Returns true if this client is still active and hasn't run into any trouble. ( end auto-generated )

In brief:

Returns true if this client is still active

Usage:

application

ip

public String ip()

( begin auto-generated from Client_ip.xml ) Returns the IP address of the computer to which the Client is attached. ( end auto-generated )

In brief:

Returns the IP address of the machine as a String

Usage:

application

available

public int available()

( begin auto-generated from Client_available.xml ) Returns the number of bytes available. When any client has bytes available from the server, it returns the number of bytes. ( end auto-generated )

In brief:

Returns the number of bytes in the buffer waiting to be read

Usage:

application

clear

public void clear()

( begin auto-generated from Client_clear.xml ) Empty the buffer, removes all the data stored there. ( end auto-generated )

In brief:

Clears the buffer

Usage:

application

read

public int read()

( begin auto-generated from Client_read.xml ) Returns a number between 0 and 255 for the next byte that's waiting in the buffer. Returns -1 if there is no byte, although this should be avoided by first cheacking available() to see if any data is available. ( end auto-generated )

In brief:

Returns a value from the buffer

Usage:

application

readChar

public char readChar()

( begin auto-generated from Client_readChar.xml ) Returns the next byte in the buffer as a char. Returns -1 or 0xffff if nothing is there. ( end auto-generated )

In brief:

Returns the next byte in the buffer as a char

Usage:

application

readBytes

public byte[] readBytes()

( begin auto-generated from Client_readBytes.xml ) Reads a group of bytes from the buffer. The version with no parameters returns a byte array of all data in the buffer. This is not efficient, but is easy to use. The version with the byteBuffer parameter is more memory and time efficient. It grabs the data in the buffer and puts it into the byte array passed in and returns an int value for the number of bytes read. If more bytes are available than can fit into the byteBuffer, only those that fit are read. ( end auto-generated )

Advanced

Return a byte array of anything that's in the serial buffer. Not particularly memory/speed efficient, because it creates a byte array on each read, but it's easier to use than readBytes(byte b[]) (see below).

In brief:

Reads everything in the buffer

Usage:

application

readBytes

public byte[] readBytes(int max)

Advanced

Return a byte array of anything that's in the serial buffer up to the specified maximum number of bytes. Not particularly memory/speed efficient, because it creates a byte array on each read, but it's easier to use than readBytes(byte b[]) (see below).

Parameters:

max - the maximum number of bytes to read

readBytes

public int readBytes(byte[] bytebuffer)

Advanced

Grab whatever is in the serial buffer, and stuff it into a byte buffer passed in by the user. This is more memory/time efficient than readBytes() returning a byte[] array. Returns an int for how many bytes were read. If more bytes are available than can fit into the byte array, only those that will fit are read.

Parameters:

bytebuffer - passed in byte array to be altered

readBytesUntil

public byte[] readBytesUntil(int interesting)

( begin auto-generated from Client_readBytesUntil.xml ) Reads from the port into a buffer of bytes up to and including a particular character. If the character isn't in the buffer, 'null' is returned. The version with no byteBuffer parameter returns a byte array of all data up to and including the interesting byte. This is not efficient, but is easy to use. The version with the byteBuffer parameter is more memory and time efficient. It grabs the data in the buffer and puts it into the byte array passed in and returns an int value for the number of bytes read. If the byte buffer is not large enough, -1 is returned and an error is printed to the message area. If nothing is in the buffer, 0 is returned. ( end auto-generated )

Parameters:

interesting - character designated to mark the end of the data

In brief:

Reads from the buffer of bytes up to and including a particular character

Usage:

application

readBytesUntil

public int readBytesUntil(int interesting,
                          byte[] byteBuffer)

Advanced

Reads from the serial port into a buffer of bytes until a particular character. If the character isn't in the serial buffer, then 'null' is returned. If outgoing[] is not big enough, then -1 is returned, and an error message is printed on the console. If nothing is in the buffer, zero is returned. If 'interesting' byte is not in the buffer, then 0 is returned.

Parameters:

byteBuffer - passed in byte array to be altered

readString

public String readString()

( begin auto-generated from Client_readString.xml ) Returns the all the data from the buffer as a String. This method assumes the incoming characters are ASCII. If you want to transfer Unicode data, first convert the String to a byte stream in the representation of your choice (i.e. UTF8 or two-byte Unicode data), and send it as a byte array. ( end auto-generated )

In brief:

Returns the buffer as a String

Usage:

application

readStringUntil

public String readStringUntil(int interesting)

( begin auto-generated from Client_readStringUntil.xml ) Combination of readBytesUntil() and readString(). Returns null if it doesn't find what you're looking for. ( end auto-generated )

Advanced

If you want to move Unicode data, you can first convert the String to a byte stream in the representation of your choice (i.e. UTF8 or two-byte Unicode data), and send it as a byte array.

Parameters:

interesting - character designated to mark the end of the data

In brief:

Returns the buffer as a String up to and including a particular character

Usage:

application

write

public void write(int data)

( begin auto-generated from Client_write.xml ) Writes data to a server specified when constructing the client. ( end auto-generated )

Parameters:

data - data to write

In brief:

Writes bytes, chars, ints, bytes[], Strings

Usage:

application

write

public void write(byte[] data)

write

public void write(String data)

Advanced

Write a String to the output. Note that this doesn't account for Unicode (two bytes per char), nor will it send UTF8 characters.. It assumes that you mean to send a byte buffer (most often the case for networking and serial i/o) and will only use the bottom 8 bits of each char in the string. (Meaning that internally it uses String.getBytes) If you want to move Unicode data, you can first convert the String to a byte stream in the representation of your choice (i.e. UTF8 or two-byte Unicode data), and send it as a byte array.