Click or drag to resize
ServiceListener Class

This virtual class enables an application to receive notifications from the rendering OIV.RemoteViz.Rendering.Service.

Inheritance Hierarchy
SystemObject
  OIV.InventorSoNetBase
    OIV.RemoteViz.RenderingServiceListener

Namespace: OIV.RemoteViz.Rendering
Assembly: OIV.RemoteViz (in OIV.RemoteViz.dll) Version: 10.7.2.0 (10.7.2.0)
Syntax
public class ServiceListener : SoNetBase

The ServiceListener type exposes the following members.

Constructors
  NameDescription
Public methodServiceListener
Default constructor.
Top
Methods
  NameDescription
Public methodEquals
Determines whether the specified Object is equal to the current Object.
(Inherited from Object.)
Public methodGetHashCode
Overrides GetHashCode().
(Inherited from SoNetBase.)
Public methodGetType
Gets the Type of the current instance.
(Inherited from Object.)
Public methodOnConnectedClient

Triggered when a client is connected to the service.

Public methodOnDisconnectedClient

Triggered when a client is disconnected from the service.

Public methodOnDisposedRenderArea

Triggered when a renderArea has been disposed.

Public methodOnDisposingRenderArea

Triggered before a renderArea is disposed.

Public methodOnHTTPRequest

Triggered when an HTTP connection is made that does not attempt to upgrade the connection to the WebSocket protocol.

Public methodOnInitializedClient

Triggered when a client is initialized.

Public methodOnInstantiatedRenderArea

Triggered when a renderArea has been instantiated.

Public methodOnMissingLicense

Triggered when a new connection is requested and a RemoteViz license was not found.

Public methodOnPendingCreateRenderArea

Triggered when a connection is pending and the requested renderArea does not exist.

Public methodOnPendingShareRenderArea

Triggered when a connection is pending and the requested renderArea exists.

Public methodOnRequestedPrivateKeyPassphrase

Triggered when the secure connection is enabled.

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

A typical sequence of calls to this listener is:

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