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


Options for configuring the G3D Discovery protocol. More...

Public Types

enum  {
  CLIENT_QUERY_TYPE = 44144,
  SERVER_DESCRIPTION_TYPE = 10101
}
 

Public Member Functions

 Settings ()
 

Public Attributes

uint16 clientBroadcastPort
 Port on which clients broadcast looking for servers. More...
 
GuiTheme::TextStyle displayStyle
 For the client side server browser. More...
 
String prompt
 Server browser prompt on the client side. More...
 
RealTime serverAdvertisementPeriod
 Servers announce themselves every serverAdvertisementPeriod seconds, and whenever they hear a client request. More...
 
uint16 serverBroadcastPort
 Port on which servers advertise themselves. More...
 

Detailed Description


Options for configuring the G3D Discovery protocol.

These rarely need to be changed except for the client-side display options.

BETA API Likely to receive incompatible changes in future releases.

Member Enumeration Documentation

◆ anonymous enum

anonymous enum
Enumerator
CLIENT_QUERY_TYPE 
SERVER_DESCRIPTION_TYPE 

Constructor & Destructor Documentation

◆ Settings()

G3D::Discovery::Settings::Settings ( )
inline

Member Data Documentation

◆ clientBroadcastPort

uint16 G3D::Discovery::Settings::clientBroadcastPort

Port on which clients broadcast looking for servers.

◆ displayStyle

GuiTheme::TextStyle G3D::Discovery::Settings::displayStyle

For the client side server browser.

Uninitialized fields are taken from the theme.

◆ prompt

String G3D::Discovery::Settings::prompt

Server browser prompt on the client side.

◆ serverAdvertisementPeriod

RealTime G3D::Discovery::Settings::serverAdvertisementPeriod

Servers announce themselves every serverAdvertisementPeriod seconds, and whenever they hear a client request.

Clients assume that any server that has not updated its advertisement for three times this period is offline.

Must be greater than zero.

◆ serverBroadcastPort

uint16 G3D::Discovery::Settings::serverBroadcastPort

Port on which servers advertise themselves.


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