processing.net

Class Server

Object

Server

All Implemented Interfaces:

Runnable

public class Server
extends Object
implements Runnable

( begin auto-generated from Server.xml ) A server sends and receives data to and from its associated clients (other programs connected to it). When a server is started, it begins listening for connections on the port specified by the port parameter. Computers have many ports for transferring data and some are commonly used so be sure to not select one of these. For example, web servers usually use port 80 and POP mail uses port 110. ( end auto-generated )

In brief:

The server class is used to create server objects which send and receives data to and from its associated clients (other programs connected to it).

Usage:

application

Field Summary

Fields

Modifier and Type	Field and Description
int	clientCount Number of clients currently connected.
Client[]	clients Array of client objects, useful length is determined by clientCount.

Constructor Summary

Constructors

Constructor and Description
Server(PApplet parent, int port)
Server(PApplet parent, int port, String host)

Method Summary

Modifier and Type	Method and Description
boolean	active() ( begin auto-generated from Server_active.xml ) Returns true if this server is still active and hasn't run into any trouble.
Client	available() ( begin auto-generated from Server_available.xml ) Returns the next client in line with a new message.
void	disconnect(Client client) ( begin auto-generated from Server_disconnect.xml ) Disconnect a particular client.
void	dispose() Disconnect all clients and stop the server: internal use only.
static String	ip()
void	run()
void	stop() ( begin auto-generated from Server_stop.xml ) Disconnects all clients and stops the server.
void	write(byte[] data)
void	write(int data) ( begin auto-generated from Server_write.xml ) Writes a value to all the connected clients.
void	write(String data)

Methods inherited from class Object

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

Field Detail

clientCount

public int clientCount

Number of clients currently connected.

clients

public Client[] clients

Array of client objects, useful length is determined by clientCount.

Constructor Detail

Server

public Server(PApplet parent,
              int port)

Parameters:

parent - typically use "this"

port - port used to transfer data

Server

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

Parameters:

host - when multiple NICs are in use, the ip (or name) to bind from

Method Detail

disconnect

public void disconnect(Client client)

( begin auto-generated from Server_disconnect.xml ) Disconnect a particular client. ( end auto-generated )

Parameters:

client - the client to disconnect

In brief:

Disconnect a particular client.

active

public boolean active()

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

In brief:

Return true if this server is still active.

ip

public static String ip()

available

public Client available()

( begin auto-generated from Server_available.xml ) Returns the next client in line with a new message. ( end auto-generated )

In brief:

Returns the next client in line with a new message.

Usage:

application

stop

public void stop()

( begin auto-generated from Server_stop.xml ) Disconnects all clients and stops the server. ( end auto-generated )

Advanced

Use this to shut down the server if you finish using it while your applet is still running. Otherwise, it will be automatically be shut down by the host PApplet using dispose(), which is identical.

In brief:

Disconnects all clients and stops the server.

Usage:

application

dispose

public void dispose()

Disconnect all clients and stop the server: internal use only.

run

public void run()

Specified by:

run in interface Runnable

write

public void write(int data)

( begin auto-generated from Server_write.xml ) Writes a value to all the connected clients. It sends bytes out from the Server object. ( end auto-generated )

Parameters:

data - data to write

In brief:

Writes data to all connected clients

write

public void write(byte[] data)

write

public void write(String data)