Client Class

Client Class

Represents a client application instance using RemoteViz.

Inheritance Hierarchy

SystemObject
OIV.InventorSoNetBase
OIV.RemoteViz.RenderingClient

Namespace: OIV.RemoteViz.Rendering
Assembly: OIV.RemoteViz (in OIV.RemoteViz.dll) Version: 10.3.0.0 (10.3.0.0)

Syntax

public sealed class Client : SoNetBase

Public NotInheritable Class Client
	Inherits SoNetBase

public ref class Client sealed : public SoNetBase

[<SealedAttribute>]
type Client =  
    class
        inherit SoNetBase
    end

The Client type exposes the following members.

Methods

	Name	Description
	Disconnect	Disconnects the client.
	Equals	Determines whether the specified Object is equal to the current Object. (Inherited from Object.)
	GetConnection(String)	Gets a OIV.RemoteViz.Rendering.Connection of the client.
	GetConnection(UInt32)	Gets a OIV.RemoteViz.Rendering.Connection of the client.
	GetHashCode	Overrides GetHashCode(). (Inherited from SoNetBase.)
	GetType	Gets the Type of the current instance. (Inherited from Object.)
	IsImageStreamingSupported	Returns if the client supports image streaming.
	IsVideoStreamingSupported	Returns if the client supports video streaming.
	SendMessage(String)	Calls SendMessage(message, (cli.array<OIV.RemoteViz.Rendering.Connection^>^)nullptr).
	SendMessage(String, Connection)	Sends a text message to all the connections of the client.
	ToString	Returns a string that represents the current object. (Inherited from Object.)

Properties

	Name	Description
	ApplicationName	HTML5 client: Returns the domain name of the web host which the client is connected.
	Environment	HTML5 client: Returns the value of the user-agent header sent by the client web browser.
	Id	Gets the id of the client.
	NumConnections	Gets the number of the client connections.
	Settings	Gets the client settings.

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 OIV.RemoteViz.Clients.Nodes.SoRemoteVizClient node, a client represents a single instance of the application using the node.

A client has one or multiple connections.