TuioClient

java.lang.Object
- TUIO.TuioClient

All Implemented Interfaces:

com.illposed.osc.OSCListener
```
public class TuioClient
extends java.lang.Object
implements com.illposed.osc.OSCListener
```
The TuioClient class is the central TUIO protocol decoder component. It provides a simple callback infrastructure using the TuioListener interface. In order to receive and decode TUIO messages an instance of TuioClient needs to be created. The TuioClient instance then generates TUIO events which are broadcasted to all registered classes that implement the TuioListener interface.
TuioClient client = new TuioClient(); client.addTuioListener(myTuioListener); client.connect();

Constructor Summary

Constructors
Constructor and Description
`TuioClient()` The default constructor creates a client that listens to the default TUIO port 3333
`TuioClient(int port)` This constructor creates a client that listens to the provided port

Method Summary

All Methods Instance Methods Concrete Methods Deprecated Methods
Modifier and Type	Method and Description
`void`	`acceptMessage(java.util.Date date, com.illposed.osc.OSCMessage message)` The OSC callback method where all TUIO messages are received and decoded and where the TUIO event callbacks are dispatched
`void`	`addTuioListener(TuioListener listener)` Adds the provided TuioListener to the list of registered TUIO event listeners
`void`	`connect()` The TuioClient starts listening to TUIO messages on the configured UDP port All reveived TUIO messages are decoded and the resulting TUIO events are broadcasted to all registered TuioListeners
`void`	`disconnect()` The TuioClient stops listening to TUIO messages on the configured UDP port
`TuioBlob`	`getTuioBlob(long s_id)` Returns the TuioBlob corresponding to the provided Session ID or NULL if the Session ID does not refer to an active TuioBlob
`java.util.ArrayList<TuioBlob>`	`getTuioBlobList()` Returns an ArrayList of all currently active TuioBlobs
`java.util.Vector<TuioBlob>`	`getTuioBlobs()` Deprecated. use `getTuioBlobList()` instead.
`TuioCursor`	`getTuioCursor(long s_id)` Returns the TuioCursor corresponding to the provided Session ID or NULL if the Session ID does not refer to an active TuioCursor
`java.util.ArrayList<TuioCursor>`	`getTuioCursorList()` Returns an ArrayList of all currently active TuioCursors
`java.util.Vector<TuioCursor>`	`getTuioCursors()` Deprecated. use `getTuioCursorList()` instead.
`TuioObject`	`getTuioObject(long s_id)` Returns the TuioObject corresponding to the provided Session ID or NULL if the Session ID does not refer to an active TuioObject
`java.util.ArrayList<TuioObject>`	`getTuioObjectList()` Returns an ArrayList of all currently active TuioObjects
`java.util.Vector<TuioObject>`	`getTuioObjects()` Deprecated. use `getTuioObjectList()` instead.
`boolean`	`isConnected()` Returns true if this TuioClient is currently connected.
`void`	`removeAllTuioListeners()` Removes all TuioListener from the list of registered TUIO event listeners
`void`	`removeTuioListener(TuioListener listener)` Removes the provided TuioListener from the list of registered TUIO event listeners

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - TuioClient
```
public TuioClient()
```
    The default constructor creates a client that listens to the default TUIO port 3333
  - TuioClient
```
public TuioClient(int port)
```
    This constructor creates a client that listens to the provided port
    
    Parameters:
    
    port - the listening port number
- Method Detail
  - connect
```
public void connect()
```
    The TuioClient starts listening to TUIO messages on the configured UDP port All reveived TUIO messages are decoded and the resulting TUIO events are broadcasted to all registered TuioListeners
  - disconnect
```
public void disconnect()
```
    The TuioClient stops listening to TUIO messages on the configured UDP port
  - isConnected
```
public boolean isConnected()
```
    Returns true if this TuioClient is currently connected.
    
    Returns:
    
    true if this TuioClient is currently connected
  - addTuioListener
```
public void addTuioListener(TuioListener listener)
```
    Adds the provided TuioListener to the list of registered TUIO event listeners
    
    Parameters:
    
    listener - the TuioListener to add
  - removeTuioListener
```
public void removeTuioListener(TuioListener listener)
```
    Removes the provided TuioListener from the list of registered TUIO event listeners
    
    Parameters:
    
    listener - the TuioListener to remove
  - removeAllTuioListeners
```
public void removeAllTuioListeners()
```
    Removes all TuioListener from the list of registered TUIO event listeners
  - getTuioObjects
```
@Deprecated
public java.util.Vector<TuioObject> getTuioObjects()
```
    Deprecated. use getTuioObjectList() instead.
    
    Returns a Vector of all currently active TuioObjects
    
    Returns:
    
    a Vector of all currently active TuioObjects
  - getTuioObjectList
```
public java.util.ArrayList<TuioObject> getTuioObjectList()
```
    Returns an ArrayList of all currently active TuioObjects
    
    Returns:
    
    an ArrayList of all currently active TuioObjects
  - getTuioCursors
```
@Deprecated
public java.util.Vector<TuioCursor> getTuioCursors()
```
    Deprecated. use getTuioCursorList() instead.
    
    Returns a Vector of all currently active TuioCursors
    
    Returns:
    
    a Vector of all currently active TuioCursors
  - getTuioCursorList
```
public java.util.ArrayList<TuioCursor> getTuioCursorList()
```
    Returns an ArrayList of all currently active TuioCursors
    
    Returns:
    
    an ArrayList of all currently active TuioCursors
  - getTuioBlobs
```
@Deprecated
public java.util.Vector<TuioBlob> getTuioBlobs()
```
    Deprecated. use getTuioBlobList() instead.
    
    Returns a Vector of all currently active TuioBlobs
    
    Returns:
    
    a Vector of all currently active TuioBlobs
  - getTuioBlobList
```
public java.util.ArrayList<TuioBlob> getTuioBlobList()
```
    Returns an ArrayList of all currently active TuioBlobs
    
    Returns:
    
    an ArrayList of all currently active TuioBlobs
  - getTuioObject
```
public TuioObject getTuioObject(long s_id)
```
    Returns the TuioObject corresponding to the provided Session ID or NULL if the Session ID does not refer to an active TuioObject
    
    Parameters:
    
    s_id - the Session ID of the required TuioObject
    
    Returns:
    
    an active TuioObject corresponding to the provided Session ID or NULL
  - getTuioCursor
```
public TuioCursor getTuioCursor(long s_id)
```
    Returns the TuioCursor corresponding to the provided Session ID or NULL if the Session ID does not refer to an active TuioCursor
    
    Parameters:
    
    s_id - the Session ID of the required TuioCursor
    
    Returns:
    
    an active TuioCursor corresponding to the provided Session ID or NULL
  - getTuioBlob
```
public TuioBlob getTuioBlob(long s_id)
```
    Returns the TuioBlob corresponding to the provided Session ID or NULL if the Session ID does not refer to an active TuioBlob
    
    Parameters:
    
    s_id - the Session ID of the required TuioBlob
    
    Returns:
    
    an active TuioBlob corresponding to the provided Session ID or NULL
  - acceptMessage
```
public void acceptMessage(java.util.Date date,
                          com.illposed.osc.OSCMessage message)
```
    The OSC callback method where all TUIO messages are received and decoded and where the TUIO event callbacks are dispatched
    
    Specified by:
    
    acceptMessage in interface com.illposed.osc.OSCListener
    
    Parameters:
    
    date - the time stamp of the OSC bundle
    
    message - the received OSC message

Class TuioClient

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

TuioClient

TuioClient

Method Detail

connect

disconnect

isConnected

addTuioListener

removeTuioListener

removeAllTuioListeners

getTuioObjects

getTuioObjectList

getTuioCursors

getTuioCursorList

getTuioBlobs

getTuioBlobList

getTuioObject

getTuioCursor

getTuioBlob

acceptMessage