Click or drag to resize
Service Class

Defines the RemoteViz rendering service.

Inheritance Hierarchy

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

The Service type exposes the following members.

Methods
  NameDescription
Public methodAddListener
Public methodClose

Closes the rendering service.

Public methodCreateRenderArea

Forces the creation of a renderArea.

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

Gets a OIV.RemoteViz.Rendering.Client from index.

Public methodGetHashCode
Overrides GetHashCode().
(Inherited from SoNetBase.)
Public methodGetNumClients

Gets the number of clients.

Public methodGetNumListeners
Public methodGetNumRenderAreas

Gets the number of renderAreas.

Public methodGetRenderArea(String)
Public methodGetRenderArea(UInt32)
Public methodGetSettings

Gets the settings of the service.

Public methodGetType
Gets the Type of the current instance.
(Inherited from Object.)
Public methodIsRunning

This method is used to know if the rendering service is running.

Public methodOpen

Opens the rendering service.

Public methodRemoveAllListeners

Removes all ServiceListeners.

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

Renderering service instance (Singleton)

Top
Remarks

This class uses the singleton pattern restricting its instantiation to a single unique object in the program. Use the Service.instance() method to get the OIV.RemoteViz.Rendering.Service object.

To use RemoteViz, the service must first be opened with the method OIV.RemoteViz.Rendering.Service.Open(OIV.RemoteViz.Rendering.ServiceSettings). Create an instance of OIV.RemoteViz.Rendering.ServiceSettings to set properties such as the OIV.RemoteViz.Rendering.Service IP address and port.

Create an implementation of class OIV.RemoteViz.Rendering.ServiceListener to receive notifications from the OIV.RemoteViz.Rendering.Service. Register a listener using the OIV.RemoteViz.Rendering.Service.AddListener(OIV.RemoteViz.Rendering.ServiceListener) method.

The OIV.RemoteViz.Rendering.Service object can also be used to query the current Clients and RenderAreas.

Thread-safety : All methods in the RemoteViz API are thread-safe. I.e., they are guaranteed to be free of race conditions when accessed by multiple threads simultaneously. But note this limitation with the class OIV.RemoteViz.Rendering.Service:

See Also