com.openinventor.remoteviz.rendering

Class Client

java.lang.Object

com.openinventor.inventor.Inventor

com.openinventor.remoteviz.rendering.Client

public class Client
extends Inventor

Represents a client application instance using RemoteViz. In the case of HTML5 applications, a client represents a single instance of a web browser for a single domain name. (See RemoteVizRenderArea)

In the case of the SoRemoteVizClient node, a client represents a single instance of the application using the node.

A client has one or multiple connections.

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 license. For each connected client to a RemoteViz service, it requires one Open Inventor license, one RemoteViz license and if Open inventor extensions are used in the RemoteViz service, a license of the extension is also required for each connected client.

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	disconnect() Disconnects the client.
java.lang.String	getApplicationName() HTML5 client: Returns the domain name of the web host which the client is connected.
Connection	getConnection(int index) Gets a Connection of the client.
Connection	getConnection(java.lang.String id) Gets a Connection of the client.
java.lang.String	getEnvironment() HTML5 client: Returns the value of the user-agent header sent by the client web browser.
java.lang.String	getId() Gets the id of the client.
int	getNumConnections() Gets the number of the client connections.
ClientSettings	getSettings() Gets the client settings.
boolean	isImageStreamingSupported() Returns if the client supports image streaming.
boolean	isVideoStreamingSupported() Returns if the client supports video streaming.
boolean	sendMessage(java.lang.String message) Calls sendMessage(message, (com.openinventor.remoteviz.rendering.Connection[])null).
boolean	sendMessage(java.lang.String message, Connection[] excludedConnections) Sends a text message to all the connections of the client.

Methods inherited from class com.openinventor.inventor.Inventor

dispose, getAddress, getNativeResourceHandle, startInternalThreads, stopInternalThreads

Methods inherited from class java.lang.Object

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

Method Detail

sendMessage

public boolean sendMessage(java.lang.String message)

Calls sendMessage(message, (com.openinventor.remoteviz.rendering.Connection[])null).

getConnection

public Connection getConnection(java.lang.String id)

Gets a Connection of the client.

Parameters:

id - : ID identifying the client

Returns:

the connection object if the id exists, otherwise returns null.

getSettings

public ClientSettings getSettings()

Gets the client settings.

Returns:

the client settings object

isImageStreamingSupported

public boolean isImageStreamingSupported()

Returns if the client supports image streaming.

Returns:

true if image streaming is supported.

getId

public java.lang.String getId()

Gets the id of the client. The client id is a Globally Unique Identifier.

Returns:

the ID identifying the client

getApplicationName

public java.lang.String getApplicationName()

HTML5 client: Returns the domain name of the web host which the client is connected. SoRemoteVizClient node: Returns the string "SoRemoteVizClient".

Returns:

the application name.

isVideoStreamingSupported

public boolean isVideoStreamingSupported()

Returns if the client supports video streaming.

Returns:

true if video streaming is supported.

getEnvironment

public java.lang.String getEnvironment()

HTML5 client: Returns the value of the user-agent header sent by the client web browser. SoRemoteVizClient node: Returns the operating system (OS) running the client application.

Returns:

the environment.

sendMessage

public boolean sendMessage(java.lang.String message,
                           Connection[] excludedConnections)

Sends a text message to all the connections of the client.

Parameters:

message - : the message to be sent to all the connections of the client

excludedConnections - : the connections that will not receive the message.

num - : number of excluded connections

Returns:

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

getConnection

public Connection getConnection(int index)

Gets a Connection of the client.

Parameters:

index - : index identifying the client

Returns:

the connection object if the index exists, otherwise returns null.

disconnect

public void disconnect()

Disconnects the client. A KICKED disconnect message will be sent to all connections of the client, then they will be disconnected.

getNumConnections

public int getNumConnections()

Gets the number of the client connections.

Returns:

the number of connections