SoRemoteVizClient::ServiceMessageEventArg Struct Reference

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

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

Inheritance diagram for SoRemoteVizClient::ServiceMessageEventArg:

List of all members.

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)
SoRemoteVizClient *	getSource () const
State	getState () const
const SbVec2s &	getRenderAreaSize () const
const SbString &	getDetails () const

---

Detailed Description

Structure given when a ServiceMessage event is raised.

Please refer to onServiceMessage event.

---

Member Enumeration Documentation

enum SoRemoteVizClient::ServiceMessageEventArg::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.

---

Constructor & Destructor Documentation

SoRemoteVizClient::ServiceMessageEventArg::ServiceMessageEventArg	(	SoRemoteVizClient *	source,
		State	state,
		SbVec2s	renderAreaSize,
		const SbString &	details
	)			[inline]

Default constructor.

---

Member Function Documentation

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.

const SbVec2s& SoRemoteVizClient::ServiceMessageEventArg::getRenderAreaSize

(

)

const [inline]

Returns the renderArea size.

SoRemoteVizClient* SoRemoteVizClient::ServiceMessageEventArg::getSource

(

)

const [inline]

Returns the SoRemoteVizClient node that triggered the event.

State SoRemoteVizClient::ServiceMessageEventArg::getState

(

)

const [inline]

Returns the connection state with the service.

---

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

• RemoteViz/Clients/nodes/SoRemoteVizClient.h