CommunicationPerformanceData

class cee.ug.CommunicationPerformanceData(): Performance data related to the communication between client and server.

Properties

dataSizeBytes
roundTripTimeMS
serverElapsedTimeMS
topic

Properties

CommunicationPerformanceData.dataSizeBytes

Type:: number optional

The amount of data in this transaction. This is applicable for ReqDataPieces.

As there are very little sever processing time on ReqDataPieces, the bandwidth between client and server can be estimated by dataSizeBytes/roundTripTimeMS, especially for larger data batches. The server will request all data pieces in one call, so there is no round-trip time for each data piece.

CommunicationPerformanceData.roundTripTimeMS

Type:: number

Round-trip time in milliseconds. This includes server processing time and data transfer time

CommunicationPerformanceData.serverElapsedTimeMS

Type:: number optional

Optional time spent on the server. Applicable for UpdateServerVisualization and GetStepConfig topic.

For the UpdateServerVisualization and GetStepConfig topic, a measure of the latency between client and server could be estimated by looking at (roundTripTimeMS - serverElapsedTimeMS).

CommunicationPerformanceData.topic

Type:: string

The type of action the performance data relates to.

Possible values:

‘UpdateServerVisualization’: Update the server with the current setting. This will prepare everything on the server side and send back the needed data pieces, but not the data itself.
‘ReqStepConfig’: Used when having an animation. The server is already updated with regards to the display model, so GetStepConfig will query the data pieces needed the selected time step.
‘ReqDataPieces’: Stream ready to send data pieces from the server to the client. The data payload of the 3D Progressive object streaming