com.openinventor.remoteviz.rendering

Class Connection

java.lang.Object

com.openinventor.inventor.Inventor

com.openinventor.remoteviz.rendering.Connection

public class Connection
extends Inventor

Represents a connection from a Client to a RenderArea managed by the RemoteViz service. RemoteViz is protected by the Open Inventor license key mechanism limiting its usage to specified computers or network environments based on commercial agreements. RemoteViz uses floating licenses managed by a license server or an encrypted "master password" string (see SoLockManager).

Each Connection requires one RemoteViz license (an SDK license for development/debugging or Runtime license for deployment).

If no license is found, the listener ServiceListener.onMissingLicense will be triggered.

Nested Class Summary

Nested classes/interfaces inherited from class com.openinventor.inventor.Inventor

Inventor.ConstructorCommand

Field Summary

Fields inherited from class com.openinventor.inventor.Inventor

VERBOSE_LEVEL, ZeroHandle

Method Summary

Modifier and Type	Method and Description
void	close() Closes the connection.
Client	getClient() Gets the id of the client associated with the connection.
int	getContainerHeight() Gets the client container height.
int	getContainerWidth() Gets the client container width.
java.lang.String	getId() Gets the id of the connection.
EncodedFrame	getLastEncodedFrame() Gets the last encoded frame sent by the connection.
ConnectionParameters	getParameters() Gets the connection parameters (field-value pairs included in the url during the client connection).
RenderArea	getRenderArea() Gets the RenderArea associated with the connection.
int	getRequestedHeight() Gets the last renderArea height requested by the client.
int	getRequestedWidth() Gets the last renderArea width requested by the client.
ConnectionSettings	getSettings() Gets the connection settings.
boolean	sendMessage(java.lang.String message) Sends a text message to the client.

Methods inherited from class com.openinventor.inventor.Inventor

dispose, getNativeResourceHandle

Methods inherited from class java.lang.Object

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

Method Detail

getSettings

public ConnectionSettings getSettings()

Gets the connection settings.

Returns:

a pointer to the connection settings

close

public void close()

Closes the connection. A KICKED disconnect message will be sent to the client.

getLastEncodedFrame

public EncodedFrame getLastEncodedFrame()

Gets the last encoded frame sent by the connection.

Returns:

encoded frame.

getContainerWidth

public int getContainerWidth()

Gets the client container width.

Returns:

the client container width

getId

public java.lang.String getId()

Gets the id of the connection.

Returns:

the ID identifying the connection

getRequestedWidth

public int getRequestedWidth()

Gets the last renderArea width requested by the client.

Returns:

the requested renderArea width

getContainerHeight

public int getContainerHeight()

Gets the client container height.

Returns:

the client container height

getRequestedHeight

public int getRequestedHeight()

Gets the last renderArea height requested by the client.

Returns:

the requested renderArea height

getClient

public Client getClient()

Gets the id of the client associated with the connection.

Returns:

the ID identifying the client

getParameters

public ConnectionParameters getParameters()

Gets the connection parameters (field-value pairs included in the url during the client connection).

Returns:

a pointer to the connection parameters

sendMessage

public boolean sendMessage(java.lang.String message)

Sends a text message to the client. The client-side message event will be triggered.

Parameters:

message - : the message to be sent to the client

Returns:

true if the message has been successfully sent, otherwise returns false.

getRenderArea

public RenderArea getRenderArea()

Gets the RenderArea associated with the connection.

Returns:

a pointer to the renderArea