Support Forum       G3D Web Page     
Public Member Functions | Public Attributes | List of all members
G3D::Discovery::ServerDescription Class Reference

Used by G3D::Discovery::Server to advertise its services. More...

Public Member Functions

 ServerDescription ()
 
 ServerDescription (BinaryInput &b)
 
void deserialize (BinaryInput &b)
 
String displayText () const
 
void serialize (BinaryOutput &b) const
 

Public Attributes

NetAddress applicationAddress
 Address on which the server is listening for incoming application (not discovery) connections. More...
 
String applicationName
 Name of the application. More...
 
int currentClients
 Number of clients currently connected to the server. More...
 
String data
 Application specific data. More...
 
RealTime lastUpdateTime
 On the client side, the last time this server was checked. More...
 
int maxClients
 Maximum number of clients the server is willing to accept. More...
 
String serverName
 Name of the server for display. More...
 

Detailed Description

Used by G3D::Discovery::Server to advertise its services.

Constructor & Destructor Documentation

◆ ServerDescription() [1/2]

G3D::Discovery::ServerDescription::ServerDescription ( )
inline

◆ ServerDescription() [2/2]

G3D::Discovery::ServerDescription::ServerDescription ( BinaryInput b)

Member Function Documentation

◆ deserialize()

void G3D::Discovery::ServerDescription::deserialize ( BinaryInput b)

◆ displayText()

String G3D::Discovery::ServerDescription::displayText ( ) const

◆ serialize()

void G3D::Discovery::ServerDescription::serialize ( BinaryOutput b) const

Member Data Documentation

◆ applicationAddress

NetAddress G3D::Discovery::ServerDescription::applicationAddress

Address on which the server is listening for incoming application (not discovery) connections.

◆ applicationName

String G3D::Discovery::ServerDescription::applicationName

Name of the application.

Clients only display servers for applications that have the same name as themselves.

Include a version number in this if you wish to distinguish between application versions.

◆ currentClients

int G3D::Discovery::ServerDescription::currentClients

Number of clients currently connected to the server.

◆ data

String G3D::Discovery::ServerDescription::data

Application specific data.

This is not displayed by the built-in server browser. It is for storing application specific data like the name of the map for a game.

See G3D::TextInput for parsing if the data is complicated.

◆ lastUpdateTime

RealTime G3D::Discovery::ServerDescription::lastUpdateTime

On the client side, the last time this server was checked.

Unused on the server side.

◆ maxClients

int G3D::Discovery::ServerDescription::maxClients

Maximum number of clients the server is willing to accept.

◆ serverName

String G3D::Discovery::ServerDescription::serverName

Name of the server for display.

This need not have any relationship to the hostname of the server.


documentation generated on Wed Nov 24 2021 08:02:03 using doxygen 1.8.15