Click or drag to resize
Client Class

Represents a client application instance using RemoteViz.

Inheritance Hierarchy

Namespace: OIV.RemoteViz.Rendering
Assembly: OIV.RemoteViz (in OIV.RemoteViz.dll) Version: 9.9.13.0 (9.9.13.0)
Syntax
public sealed class Client : SoNetBase

The Client type exposes the following members.

Methods
  NameDescription
Public methodDisconnect

Disconnects the client.

Public methodEquals
Determines whether the specified Object is equal to the current Object.
(Inherited from Object.)
Public methodGetConnection(String)

Gets a Connection of the client.

Public methodGetConnection(UInt32)

Gets a Connection of the client.

Public methodGetHashCode
Overrides GetHashCode().
(Inherited from SoNetBase.)
Public methodGetType
Gets the Type of the current instance.
(Inherited from Object.)
Public methodIsImageStreamingSupported

Returns if the client supports image streaming.

Public methodIsVideoStreamingSupported

Returns if the client supports video streaming.

Public methodSendMessage(String)
Calls SendMessage(message, (cli.array<OIV.RemoteViz.Rendering.Connection^>^)nullptr).
Public methodSendMessage(String, Connection)

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

Public methodToString
Returns a string that represents the current object.
(Inherited from Object.)
Top
Properties
  NameDescription
Public propertyApplicationName

HTML5 client: Returns the domain name of the web host which the client is connected.

Public propertyEnvironment

HTML5 client: Returns the value of the user-agent header sent by the client web browser.

Public propertyId

Gets the id of the client.

Public propertyNumConnections

Gets the number of the client connections.

Public propertySettings

Gets the client settings.

Top
Remarks

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.

See Also