From 589e6c881bd2cf11e8615e9c1bf8cb4012293bad Mon Sep 17 00:00:00 2001 From: David Runge Date: Thu, 31 Dec 2015 03:34:08 +0100 Subject: libraries/oscP5: Adding oscP5 library for OSC capabilities. --- .../oscP5/reference/netP5/AbstractTcpClient.html | 869 +++++++++++++++++++++ 1 file changed, 869 insertions(+) create mode 100644 libraries/oscP5/reference/netP5/AbstractTcpClient.html (limited to 'libraries/oscP5/reference/netP5/AbstractTcpClient.html') diff --git a/libraries/oscP5/reference/netP5/AbstractTcpClient.html b/libraries/oscP5/reference/netP5/AbstractTcpClient.html new file mode 100644 index 0000000..afc5010 --- /dev/null +++ b/libraries/oscP5/reference/netP5/AbstractTcpClient.html @@ -0,0 +1,869 @@ + + + + + + +AbstractTcpClient (Javadocs: oscP5) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + +
Overview  Package   Class  Tree  Deprecated  Index  Help 
+		 + +
+ PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
+ SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
+ + + +
+ +

+ +netP5 +
+Class AbstractTcpClient

+
+java.lang.Object
+  extended by netP5.AbstractTcpClient
+
+
+
All Implemented Interfaces:
Runnable
+
+
+
Direct Known Subclasses:
TcpClient
+
+
+
+
public abstract class AbstractTcpClient
extends Object
implements Runnable
+ + +

+

+ +

+ + + + + + + + + + + + + + + + + + + + + + + +
+Field Summary
+static intMODE_NEWLINE + +
+          terminator is newline.
+static intMODE_READLINE + +
+          terminator is readline.
+static intMODE_STREAM + +
+          no terminator required, packets are sent via + a tcp stream.
+static intMODE_TERMINATED + +
+          terminator is terminated, by default this is character '\0' + and can be set with setTerminator
+  + + + + + + + + + + + + + + + + + + + + + + +
+Constructor Summary
AbstractTcpClient(AbstractTcpServer theTcpServer, + Socket theSocket, + TcpPacketListener theTcpPacketListener, + int theServerPort, + int theMode) + +
+           
AbstractTcpClient(String theHost, + int thePort) + +
+           
AbstractTcpClient(String theHost, + int thePort, + int theMode) + +
+           
AbstractTcpClient(TcpPacketListener theTcpPacketListener, + String theHost, + int thePort) + +
+           
AbstractTcpClient(TcpPacketListener theTcpPacketListener, + String theHost, + int thePort, + int theMode) + +
+           
+  + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+Method Summary
+ voiddispose() + +
+          stop and dispose a tcp client.
+ booleanequals(NetAddress theNetAddress) + +
+           
+ booleanequals(TcpClient theClient) + +
+           
+ StringgetString() + +
+           
+ StringBuffergetStringBuffer() + +
+           
+abstract  voidhandleInput() + +
+           
+abstract  voidhandleStatus(int theIndex) + +
+           
+ TcpPacketListenerlistener() + +
+           
+ intmode() + +
+          get the mode of the terminator.
+ NetAddressnetaddress() + +
+          Deprecated.  
+ NetAddressnetAddress() + +
+           
+ voidreconnect() + +
+          when a TCP connection is lost, reconnect to the server with reconnect().
+ voidrun() + +
+           
+ voidsend(byte[] theBytes) + +
+           
+ voidsend(byte[][] theBytes) + +
+           
+ voidsend(String theString) + +
+           
+ intserverport() + +
+          get the server port.
+ voidsetTerminator(char theTerminator) + +
+          to parse an incomming tcp message, a terminator character is required to + determine the end of the message so that it can be parsed and forwarded.
+ Socketsocket() + +
+          get the instance of the socket.
+  + + + + + + + +
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
+  +

+ + + + + + + + +
+Field Detail
+ +

+MODE_READLINE

+
+public static final int MODE_READLINE
+
+
terminator is readline. +

+

+
See Also:
Constant Field Values
+
+
+ +

+MODE_TERMINATED

+
+public static final int MODE_TERMINATED
+
+
terminator is terminated, by default this is character '\0' + and can be set with setTerminator +

+

+
See Also:
Constant Field Values
+
+
+ +

+MODE_NEWLINE

+
+public static final int MODE_NEWLINE
+
+
terminator is newline. +

+

+
See Also:
Constant Field Values
+
+
+ +

+MODE_STREAM

+
+public static final int MODE_STREAM
+
+
no terminator required, packets are sent via + a tcp stream. +

+

+
See Also:
Constant Field Values
+
+ + + + + + + + +
+Constructor Detail
+ +

+AbstractTcpClient

+
+public AbstractTcpClient(TcpPacketListener theTcpPacketListener,
+                         String theHost,
+                         int thePort)
+
+
+
Parameters:
theTcpPacketListener - TcpPacketListener
theHost - String
thePort - int
+
+
+ +

+AbstractTcpClient

+
+public AbstractTcpClient(String theHost,
+                         int thePort)
+
+
+
Parameters:
theHost - String
thePort - int
+
+
+ +

+AbstractTcpClient

+
+public AbstractTcpClient(TcpPacketListener theTcpPacketListener,
+                         String theHost,
+                         int thePort,
+                         int theMode)
+
+
+
Parameters:
theTcpPacketListener - TcpPacketListener
theHost - String
thePort - int
theMode - int
+
+
+ +

+AbstractTcpClient

+
+public AbstractTcpClient(String theHost,
+                         int thePort,
+                         int theMode)
+
+
+
Parameters:
theHost - String
thePort - int
theMode - int
+
+
+ +

+AbstractTcpClient

+
+public AbstractTcpClient(AbstractTcpServer theTcpServer,
+                         Socket theSocket,
+                         TcpPacketListener theTcpPacketListener,
+                         int theServerPort,
+                         int theMode)
+
+
+
Parameters:
theTcpServer - AbstractTcpServer
theSocket - Socket
theTcpPacketListener - TcpPacketListener
theServerPort - int
theMode - int
+
+ + + + + + + + +
+Method Detail
+ +

+reconnect

+
+public void reconnect()
+
+
when a TCP connection is lost, reconnect to the server with reconnect(). +

+

+
+
+
+
+
+
+
+ +

+setTerminator

+
+public void setTerminator(char theTerminator)
+
+
to parse an incomming tcp message, a terminator character is required to + determine the end of the message so that it can be parsed and forwarded. +

+

+
+
+
+
Parameters:
theTerminator -
+
+
+
+ +

+dispose

+
+public void dispose()
+
+
stop and dispose a tcp client. +

+

+
+
+
+
+
+
+
+ +

+run

+
+public void run()
+
+
+
Specified by:
run in interface Runnable
+
+
+
+
+
+
+ +

+handleInput

+
+public abstract void handleInput()
+
+
+
+
+
+
+
+
+
+ +

+handleStatus

+
+public abstract void handleStatus(int theIndex)
+
+
+
+
+
+
Parameters:
theIndex -
+
+
+
+ +

+listener

+
+public TcpPacketListener listener()
+
+
+
+
+
+ +
Returns:
+
+
+
+ +

+serverport

+
+public int serverport()
+
+
get the server port. +

+

+
+
+
+ +
Returns:
+
+
+
+ +

+socket

+
+public Socket socket()
+
+
get the instance of the socket. more info at java.net.Socket +

+

+
+
+
+ +
Returns:
+
+
+
+ +

+mode

+
+public int mode()
+
+
get the mode of the terminator. +

+

+
+
+
+ +
Returns:
+
+
+
+ +

+getString

+
+public String getString()
+
+
+
+
+
+
+
+
+
+ +

+getStringBuffer

+
+public StringBuffer getStringBuffer()
+
+
+
+
+
+
+
+
+
+ +

+send

+
+public void send(byte[] theBytes)
+
+
+
+
+
+
+
+
+
+ +

+send

+
+public void send(byte[][] theBytes)
+
+
+
+
+
+
+
+
+
+ +

+send

+
+public void send(String theString)
+
+
+
+
+
+
+
+
+
+ +

+netAddress

+
+public NetAddress netAddress()
+
+
+
+
+
+
+
+
+
+ +

+netaddress

+
+public NetAddress netaddress()
+
+
Deprecated.  +

+

+
+
+
+ +
Returns:
NetAddress
+
+
+
+ +

+equals

+
+public boolean equals(NetAddress theNetAddress)
+
+
+
+
+
+
Parameters:
theNetAddress - NetAddress +
Returns:
boolean
+
+
+
+ +

+equals

+
+public boolean equals(TcpClient theClient)
+
+
+
+
+
+
+
+
+ +
+ + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + +
Overview  Package   Class  Tree  Deprecated  Index  Help 
+		 + +
+ PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
+ SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
+ + + +
+processing library oscP5 by Andreas Schlegel. (c) 2004-2012 + + -- cgit v1.2.3-54-g00ecf