| Service Class |
Defines the RemoteViz rendering service.
Inheritance HierarchyNamespace: OIV.RemoteViz.Rendering
Assembly: OIV.RemoteViz (in OIV.RemoteViz.dll) Version: 2023.1.3.0 (2023.1.3)
SyntaxThe Service type exposes the following members.
Methods| Name | Description | |
|---|---|---|
 | AddListener | |
| Close | Closes the rendering service. |
| CreateRenderArea | Forces the creation of a renderArea. |
| Dispatch | This method has to be used with the OIV.RemoteViz.Rendering.ServiceSettings.RunModes.INVENTOR_SERVICE and OIV.RemoteViz.Rendering.ServiceSettings.RunModes.INDEPENDENT_SERVICE mode in a loop. |
| Equals | Determines whether the specified Object is equal to the current Object. (Inherited from Object.) |
| GetClient(String) | Gets a OIV.RemoteViz.Rendering.Client from id. |
| GetClient(UInt32) | Gets a OIV.RemoteViz.Rendering.Client from index. |
| GetHashCode |
Overrides GetHashCode().
(Inherited from SoNetBase.) |
| GetNumClients | Gets the number of clients. |
| GetNumListeners | Gets the number of OIV.RemoteViz.Rendering.ServiceListener. |
| GetNumRenderAreas | Gets the number of renderAreas. |
| GetRenderArea(String) | Gets a OIV.RemoteViz.Rendering.RenderArea from id. |
| GetRenderArea(UInt32) | Gets a OIV.RemoteViz.Rendering.RenderArea from index. |
| GetSettings | Gets the settings of the service. |
| GetType | Gets the Type of the current instance. (Inherited from Object.) |
| IsRunning | This method is used to know if the rendering service is running. |
| Open | Opens the rendering service. |
| RemoveAllListeners | Removes all ServiceListeners. |
| RemoveListener | Removes a OIV.RemoteViz.Rendering.ServiceListener. |
| ToString | Returns a string that represents the current object. (Inherited from Object.) |
Properties
RemarksThis class uses the singleton pattern restricting its instantiation to a single unique object in the program. Use the () 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:
The methods OIV.RemoteViz.Rendering.Service.Open(OIV.RemoteViz.Rendering.ServiceSettings), OIV.RemoteViz.Rendering.Service.Close() and OIV.RemoteViz.Rendering.Service.Dispatch() must be called from the same thread.
See Also