Open Inventor Release 2024.2.0
 
Loading...
Searching...
No Matches
SoRemoteVizClient::ServiceMessageEventArg Struct Reference

Structure given when a ServiceMessage event is raised. More...

#include <RemoteViz/Clients/nodes/SoRemoteVizClient.h>

+ Inheritance diagram for SoRemoteVizClient::ServiceMessageEventArg:

Public Types

enum  State {
  CONNECTED ,
  DISCONNECTED ,
  START_NETWORK_CALIBRATION ,
  FINISH_NETWORK_CALIBRATION ,
  START_BANDWIDTH_CALIBRATION ,
  FINISH_BANDWIDTH_CALIBRATION ,
  START_LATENCY_CALIBRATION ,
  FINISH_LATENCY_CALIBRATION ,
  PENDING_NETWORK_CALIBRATION
}
 

Public Member Functions

 ServiceMessageEventArg (SoRemoteVizClient *source, State state, SbVec2s renderAreaSize, const SbString &details)
 Default constructor.
 
SoRemoteVizClientgetSource () const
 Returns the SoRemoteVizClient node that triggered the event.
 
State getState () const
 Returns the connection state with the service.
 
const SbVec2sgetRenderAreaSize () const
 Returns the renderArea size.
 
const SbStringgetDetails () const
 Returns details of the event.
 

Detailed Description

Structure given when a ServiceMessage event is raised.

Please refer to onServiceMessage event.

Definition at line 314 of file SoRemoteVizClient.h.

Member Enumeration Documentation

◆ State

Enumerator
CONNECTED 

Connected to the service.

DISCONNECTED 

Disconnected from the service.

START_NETWORK_CALIBRATION 

The network calibration is started.

FINISH_NETWORK_CALIBRATION 

The network calibration is finished.

START_BANDWIDTH_CALIBRATION 

The network bandwidth calibration is started.

FINISH_BANDWIDTH_CALIBRATION 

The network bandwidth calibration is finished.

START_LATENCY_CALIBRATION 

The network latency calibration is started.

FINISH_LATENCY_CALIBRATION 

The network latency calibration is finished.

PENDING_NETWORK_CALIBRATION 

The network calibration is pending.

Another connection is currently performing it.

Definition at line 316 of file SoRemoteVizClient.h.

Constructor & Destructor Documentation

◆ ServiceMessageEventArg()

SoRemoteVizClient::ServiceMessageEventArg::ServiceMessageEventArg ( SoRemoteVizClient source,
State  state,
SbVec2s  renderAreaSize,
const SbString details 
)
inline

Default constructor.

Definition at line 339 of file SoRemoteVizClient.h.

Member Function Documentation

◆ getDetails()

const SbString & SoRemoteVizClient::ServiceMessageEventArg::getDetails ( ) const
inline

Returns details of the event.

If State is equal to DISCONNECTED: This parameter is the disconnected reason. It can take the following values "DISPOSED", "REFUSED", "KICKED" and "NETWORKFAILURE". If State is equal to FINISH_BANDWIDTH_CALIBRATION: This parameter is the network bandwidth calibration value (in bit/s). Else if State is equal to FINISH_LATENCY_CALIBRATION: This parameter is the network latency calibration value (in ms). Else this parameter is empty.

Definition at line 361 of file SoRemoteVizClient.h.

◆ getRenderAreaSize()

const SbVec2s & SoRemoteVizClient::ServiceMessageEventArg::getRenderAreaSize ( ) const
inline

Returns the renderArea size.

Definition at line 349 of file SoRemoteVizClient.h.

◆ getSource()

SoRemoteVizClient * SoRemoteVizClient::ServiceMessageEventArg::getSource ( ) const
inline

Returns the SoRemoteVizClient node that triggered the event.

Definition at line 343 of file SoRemoteVizClient.h.

◆ getState()

State SoRemoteVizClient::ServiceMessageEventArg::getState ( ) const
inline

Returns the connection state with the service.

Definition at line 346 of file SoRemoteVizClient.h.


The documentation for this struct was generated from the following file: