ServiceListenerOnPendingCreateRenderArea Method |
Triggered when a connection is pending and the requested renderArea does not exist.
Namespace: OIV.RemoteViz.Rendering
public virtual bool OnPendingCreateRenderArea( string renderAreaId, out uint width, out uint height, RenderAreaHardware renderAreaHardware, Client client, ConnectionParameters parameters )
: ID identifying the renderArea requested by the client
: client requested width if the connection parameters contain this information, otherwise it's the renderArea default width. This value can be modified, it determines the created OIV.RemoteViz.Rendering.RenderArea width.
: client requested height if the connection parameters contain this information, otherwise it's the renderArea default height. This value can be modified, it determines the created OIV.RemoteViz.Rendering.RenderArea height.
: hardware settings used to compute the render.
: client that is being connected to the service. If the client does not exist yet, this parameter will be null.
: field-value pairs included in the url during the client connection. See connectTo function in RemoteVizRenderArea.
true if the connection is accepted. The renderArea will be created. Otherwise returns false. In this case, the client will be notified by an REFUSED disconnect message. If there are many listeners, the logical operator OR will be applied on all the returned value of listeners. If there are no listeners to call, the connection will be accepted.
Default behavior : Accept the connection by returning true.
Use this callback to implement connection management, e.g. authentication. See the Authentication page and the ConnectionManagement example. Accepting the connection means that RemoteViz will create a OIV.RemoteViz.Rendering.RenderArea and give it the id requested by the OIV.RemoteViz.Rendering.Client (renderAreaId).