tes::ServerInfoMessage Struct Reference

Information about the server. More...

#include <3esmessages.h>

Public Member Functions
bool	read (PacketReader &reader)
	Read this message from reader. More...
bool	write (PacketWriter &writer) const
	Write this message to writer. More...

Public Attributes
uint64_t	timeUnit
	Specifies the time unit in a CIdFrame ControlMessage. More...
uint32_t	defaultFrameTime
	The default time delta between frames to used when none is specified. More...
uint8_t	coordinateFrame
	Specifies the CoordinateFrame used by this server. More...
uint8_t	reserved [35]
	Reserved for future use. More...

Detailed Description

Information about the server.

This is sent to clients on connection. Defines global settings for this server.

Member Function Documentation

read()

bool tes::ServerInfoMessage::read ( PacketReader &  reader )

inline

Read this message from reader.

Parameters

reader

The data source.

Returns

True on success.

References tes::PacketReader::readArray(), and tes::PacketReader::readElement().

write()

bool tes::ServerInfoMessage::write ( PacketWriter &  writer ) const

inline

Write this message to writer.

Parameters

writer

The target buffer.

Returns

True on success.

References tes::initDefaultServerInfo(), tes::PacketWriter::writeArray(), and tes::PacketWriter::writeElement().

Member Data Documentation

coordinateFrame

uint8_t tes::ServerInfoMessage::coordinateFrame

Specifies the CoordinateFrame used by this server.

The default is XYZ.

defaultFrameTime

uint32_t tes::ServerInfoMessage::defaultFrameTime

The default time delta between frames to used when none is specified.

Only used in replay.

This value is specified in the timeUnit.

The default is 33ms (1/30s).

reserved

uint8_t tes::ServerInfoMessage::reserved[35]

Reserved for future use.

Must be zero. Aiming to pad out to a total of 64-bytes in the packet.

timeUnit

uint64_t tes::ServerInfoMessage::timeUnit

Specifies the time unit in a CIdFrame ControlMessage.

Each unit in the value is scaled by this time unit.

This value is specified in micro-seconds.

The default is 1000us (1 millisecond).

---

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

• 3esmessages.h