| ServiceListener Class |
This class can be overridden by an application to receive notifications from the rendering OIV.RemoteViz.Rendering.Service.
Inheritance HierarchyNamespace: OIV.RemoteViz.Rendering
Assembly: OIV.RemoteViz (in OIV.RemoteViz.dll) Version: 2024.1.1.0 (2024.1.1)
SyntaxThe ServiceListener type exposes the following members.
Constructors| Name | Description | |
|---|---|---|
 | ServiceListener | Default constructor. |
Methods| Name | Description | |
|---|---|---|
| Equals | Determines whether the specified Object is equal to the current Object. (Inherited from Object.) |
| GetHashCode |
Overrides GetHashCode().
(Inherited from SoNetBase.) |
| GetType | Gets the Type of the current instance. (Inherited from Object.) |
| OnConnectedClient | Triggered when a client is connected to the service. |
| OnDisconnectedClient | Triggered when a client is disconnected from the service. |
| OnDisposedRenderArea | Triggered when a renderArea has been disposed. |
| OnDisposingRenderArea | Triggered before a renderArea is disposed. |
| OnHTTPRequest | Triggered when an HTTP connection is made that does not attempt to upgrade the connection to the WebSocket protocol. |
| OnInitializedClient | Triggered when a client is initialized. |
| OnInstantiatedRenderArea | Triggered when a renderArea has been instantiated. |
| OnMissingLicense | Obsolete. This listener is deprecated from Open Inventor 10.9 and is not triggered by RemoteViz anymore. |
| OnPendingCreateRenderArea | Triggered when a connection is pending and the requested renderArea does not exist. |
| OnPendingShareRenderArea | Triggered when a connection is pending and the requested renderArea exists. |
| OnRequestedPrivateKeyPassphrase | |
| ToString | Returns a string that represents the current object. (Inherited from Object.) |
RemarksA typical sequence of calls to this listener is:
OIV.RemoteViz.Rendering.ServiceListener.OnConnectedClient(System.String, OIV.RemoteViz.Rendering.NetworkPerformance)OIV.RemoteViz.Rendering.Client object has been created (isConnected will return true)
OIV.RemoteViz.Rendering.ServiceListener.OnPendingCreateRenderArea(System.String, System.UInt32@, System.UInt32@, OIV.RemoteViz.Rendering.RenderAreaHardware, OIV.RemoteViz.Rendering.Client, OIV.RemoteViz.Rendering.ConnectionParameters)OIV.RemoteViz.Rendering.RenderArea object is about to be created
OIV.RemoteViz.Rendering.ServiceListener.OnInstantiatedRenderArea(OIV.RemoteViz.Rendering.RenderArea)OIV.RemoteViz.Rendering.RenderArea object has been created (isDisposed will return false)
OIV.RemoteViz.Rendering.ServiceListener.OnInitializedClient(OIV.RemoteViz.Rendering.Client, OIV.RemoteViz.Rendering.NetworkPerformance)OIV.RemoteViz.Rendering.Client is running and bandwidth calibration has finished Application is running...
OIV.RemoteViz.Rendering.ServiceListener.OnDisposingRenderArea(OIV.RemoteViz.Rendering.RenderArea)OIV.RemoteViz.Rendering.RenderArea object will be disposed
OIV.RemoteViz.Rendering.ServiceListener.OnDisposedRenderArea(System.String)OIV.RemoteViz.Rendering.RenderArea object has been disposed (isDisposed will return true)
OIV.RemoteViz.Rendering.ServiceListener.OnDisconnectedClient(System.String)OIV.RemoteViz.Rendering.Client object has been disposed (isConnected will return false)
Since RemoteViz 10.6, this class also allows the OIV.RemoteViz.Rendering.Service to respond to standard HTTP requests using standard HTTP response codes (and messages). This can be useful, for example, to respond to "health check" requests. This method is not suitable to serve high volume requests or HTTP resources, in these cases, prefer a dedicated HTTP server like Apache or Nginx. See OIV.RemoteViz.Rendering.ServiceListener.OnHTTPRequest(OIV.RemoteViz.Rendering.HTTPRequest).
Typically the application will attach a listener to the OIV.RemoteViz.Rendering.Service instance before calling the OIV.RemoteViz.Rendering.Service's open() method.
For notifications about connections, rendering, input events and client messages see the OIV.RemoteViz.Rendering.RenderAreaListener class.
See Also