Package org.web3d.vrml.scripting.external.neteai

Class ClientProcessingTask

java.lang.Object

org.web3d.vrml.scripting.external.neteai.ClientProcessingTask

All Implemented Interfaces:

Runnable, FieldAndNodeRequestProcessor

public class ClientProcessingTask
extends Object
implements Runnable, FieldAndNodeRequestProcessor

ClientProcessingTask is the body of processing loop for reading and writing data from the foreign browser. Access to the input stream is controlled by mutual exclusion using SuspendedTaskData instances and readLock.

Method Summary

Modifier and Type	Method	Description
void	addRoute(int fromNodeID, String eventOut, int toNodeID, String eventIn)	Send addRoute request to the server
void	addVrmlEventListener(int fieldID, int fieldType, VrmlEventListener l)	Add a listener to event changes for a field.
void	createVrmlFromURL(String[] url, int nodeID, String eventIn)
void	disposeNode(int nodeID)	Notify server that node is no longer referenced.
float	getCurrentFrameRate()
float	getCurrentSpeed()
EventIn	getEventIn(int nodeID, String fieldName)	* @see org.web3d.vrml.scripting.external.neteai.FieldAndNodeRequestProcessor#getEventIn(int, java.lang.String)
EventOut	getEventOut(int nodeID, String fieldName)	* @see org.web3d.vrml.scripting.external.neteai.FieldAndNodeRequestProcessor#getEventOut(int, java.lang.String)
void	getFieldValue(int fieldID, org.web3d.vrml.scripting.external.neteai.EventWrapper buffer)	Transmit a getFieldValue request.
int	getImageComponents(int fieldID)	Return the number of components in an SFImage field
int	getImageHeight(int fieldID)	Return the height on an SFImage field
int	getImageWidth(int fieldID)	Return the width of an SFImage field
int	getNode(String nodeName)	Transmit a getNode request to the server and wait for reply.
String	getNodeType(int nodeID)	Returns the type name for a given node.
int	getNumFieldValues(int fieldID)	Get the number of elements in this field's value
String	getServerName()
String	getServerVersion()
Object	getUserData(int fieldID)	Get the user data associated with a field.
String	getWorldURL()
void	removeRoute(int fromNodeID, String eventOut, int toNodeID, String eventIn)	Remove a route from the scene
void	removeVrmlEventListener(int fieldID, VrmlEventListener l)	Remove a listener from the listeners for a field.
void	run()
void	setDescription(String desc)
void	setFieldValue(int fieldID, org.web3d.vrml.scripting.external.neteai.EventWrapper buffer)	Transmit a setFieldValue request.
void	setUserData(int fieldID, Object data)	Set the user data associated with a field.
void	shutdownBrowser()	Tell the server that everything should go away.

Methods inherited from class java.lang.Object

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

Method Details

addRoute

public void addRoute(int fromNodeID,
 String eventOut,
 int toNodeID,
 String eventIn)

Send addRoute request to the server

Parameters:

fromNodeID - Network ID of the originating node

eventOut - Name of originating event

toNodeID - Network ID of the destination ndoe

eventIn - Name of the destination event

addVrmlEventListener

public void addVrmlEventListener(int fieldID,
 int fieldType,
 VrmlEventListener l)

Description copied from interface: FieldAndNodeRequestProcessor

Add a listener to event changes for a field. Turns on event notifications as needed. Need to pass the field type so that the broadcast system knows what to generate when updates arrive.

Specified by:

addVrmlEventListener in interface FieldAndNodeRequestProcessor

Parameters:

fieldID - The network ID of the field

fieldType - The type of the field

l - The listener to add.

disposeNode

public void disposeNode(int nodeID)

Notify server that node is no longer referenced. Does not check for remaining instances.

Specified by:

disposeNode in interface FieldAndNodeRequestProcessor

Parameters:

nodeID - The node to dispose

getEventIn

public EventIn getEventIn(int nodeID,
 String fieldName)

* @see org.web3d.vrml.scripting.external.neteai.FieldAndNodeRequestProcessor#getEventIn(int, java.lang.String)

Specified by:

getEventIn in interface FieldAndNodeRequestProcessor

Parameters:

nodeID - The network ID of the node

fieldName - The name of the field

Returns:

The eventIn object

getEventOut

public EventOut getEventOut(int nodeID,
 String fieldName)

* @see org.web3d.vrml.scripting.external.neteai.FieldAndNodeRequestProcessor#getEventOut(int, java.lang.String)

Specified by:

getEventOut in interface FieldAndNodeRequestProcessor

Parameters:

nodeID - The network ID of the node

fieldName - The name of the field

Returns:

The eventOut object

getFieldValue

public void getFieldValue(int fieldID,
 org.web3d.vrml.scripting.external.neteai.EventWrapper buffer)

Description copied from interface: FieldAndNodeRequestProcessor

Transmit a getFieldValue request. The buffer will receive the field value using readFieldValue.

Specified by:

getFieldValue in interface FieldAndNodeRequestProcessor

Parameters:

fieldID - The network field ID

buffer - The buffer to receive the value

See Also:

• FieldAndNodeRequestProcessor.getFieldValue(int, org.web3d.vrml.scripting.external.neteai.EventWrapper)

getNode

public int getNode(String nodeName)

Transmit a getNode request to the server and wait for reply.

Specified by:

getNode in interface FieldAndNodeRequestProcessor

Parameters:

nodeName - The nodeName to request

Returns:

The ID for the node if found.

getNodeType

public String getNodeType(int nodeID)

Returns the type name for a given node.

Specified by:

getNodeType in interface FieldAndNodeRequestProcessor

Parameters:

nodeID - The network ID of the node.

Returns:

The type name of the node.

getNumFieldValues

public int getNumFieldValues(int fieldID)

Description copied from interface: FieldAndNodeRequestProcessor

Get the number of elements in this field's value

Specified by:

getNumFieldValues in interface FieldAndNodeRequestProcessor

Parameters:

fieldID - The network ID of this field

Returns:

The number of elements in the field's value

See Also:

• FieldAndNodeRequestProcessor.getNumFieldValues(int)

getUserData

public Object getUserData(int fieldID)

Description copied from interface: FieldAndNodeRequestProcessor

Get the user data associated with a field. This is implemented on the client side.

Specified by:

getUserData in interface FieldAndNodeRequestProcessor

Parameters:

fieldID - The network field ID

Returns:

The user data object

See Also:

• FieldAndNodeRequestProcessor.getUserData(int)

removeRoute

public void removeRoute(int fromNodeID,
 String eventOut,
 int toNodeID,
 String eventIn)

Remove a route from the scene

Parameters:

fromNodeID - Source node network ID

eventOut - Name of source field

toNodeID - Destination node network ID

eventIn - Name of destination field

removeVrmlEventListener

public void removeVrmlEventListener(int fieldID,
 VrmlEventListener l)

Description copied from interface: FieldAndNodeRequestProcessor

Remove a listener from the listeners for a field. Will turn off event notifications if this is the last listener for that field.

Specified by:

removeVrmlEventListener in interface FieldAndNodeRequestProcessor

Parameters:

fieldID - The network ID of the field.

l - The listener to remove

See Also:

• FieldAndNodeRequestProcessor.removeVrmlEventListener(int, vrml.eai.event.VrmlEventListener)

run

public void run()

Specified by:

run in interface Runnable

See Also:

• Handle packets coming in from the server

setFieldValue

public void setFieldValue(int fieldID,
 org.web3d.vrml.scripting.external.neteai.EventWrapper buffer)

Description copied from interface: FieldAndNodeRequestProcessor

Transmit a setFieldValue request. The buffer holds the field value to transmit using writeFieldValue.

Specified by:

setFieldValue in interface FieldAndNodeRequestProcessor

Parameters:

fieldID - The network field ID

buffer - The buffer holding the value

setUserData

public void setUserData(int fieldID,
 Object data)

Description copied from interface: FieldAndNodeRequestProcessor

Set the user data associated with a field. This is implemented on the client side.

Specified by:

setUserData in interface FieldAndNodeRequestProcessor

Parameters:

fieldID - The network field ID

data - The user data object

See Also:

• FieldAndNodeRequestProcessor.setUserData(int, java.lang.Object)

createVrmlFromURL

public void createVrmlFromURL(String[] url,
 int nodeID,
 String eventIn)

Parameters:

url - The URLs to try

nodeID - The network ID of the node to receive the event

eventIn - The name of the receiving eventIn

getServerName

public String getServerName()

Returns:

The identifier the server is using.

See Also:

• Browser.getName()

getServerVersion

public String getServerVersion()

Returns:

version information

See Also:

• Browser.getVersion()

getCurrentSpeed

public float getCurrentSpeed()

Returns:

current network speed

See Also:

• Browser.getCurrentSpeed()

getCurrentFrameRate

public float getCurrentFrameRate()

Returns:

* @see vrml.eai.Browser#getCurrentFrameRate()

getWorldURL

public String getWorldURL()

Returns:

* @see vrml.eai.Browser#getWorldURL()

setDescription

public void setDescription(String desc)

Parameters:

desc - description

See Also:

• Browser.setDescription(java.lang.String)

shutdownBrowser

public void shutdownBrowser()

Tell the server that everything should go away.

getImageComponents

public int getImageComponents(int fieldID)

Description copied from interface: FieldAndNodeRequestProcessor

Return the number of components in an SFImage field

Specified by:

getImageComponents in interface FieldAndNodeRequestProcessor

Parameters:

fieldID - The network field ID

Returns:

The number of components in the image

See Also:

• FieldAndNodeRequestProcessor.getImageComponents(int)

getImageHeight

public int getImageHeight(int fieldID)

Description copied from interface: FieldAndNodeRequestProcessor

Return the height on an SFImage field

Specified by:

getImageHeight in interface FieldAndNodeRequestProcessor

Parameters:

fieldID - The network field ID

Returns:

The height of the image

See Also:

• FieldAndNodeRequestProcessor.getImageHeight(int)

getImageWidth

public int getImageWidth(int fieldID)

Description copied from interface: FieldAndNodeRequestProcessor

Return the width of an SFImage field

Specified by:

getImageWidth in interface FieldAndNodeRequestProcessor

Parameters:

fieldID - The network field ID

Returns:

The width of the image

See Also:

• FieldAndNodeRequestProcessor.getImageWidth(int)