Noble Connect
Add relays and punchthrough to Mirror or UNet
NobleConnect.Stun.ControllerConfig Class Reference

Controlls the configuration of a Stun or Turn controller. More...

Public Member Functions

 ControllerConfig ()
 Create a default Stun.Controller configuration. More...
 

Public Attributes

IPEndPoint stunServerEndPoint
 The address of the Stun server More...
 
string username
 Username to use when authenticating messages More...
 
string password
 Password to use when authenticating messages More...
 
string origin
 
int defaultRetransmissionTimeout
 The initial retransmission timeout in milliseconds More...
 
int maxRetransmissionCount
 The maximum amount of times to re-send a request before giving up More...
 
int finalRetransmissionTimeoutMultiplier
 Multplier for how long to wait after the final attempt to re-transmit a failed request before giving up More...
 
int allocationRetransmissionTimeout
 
int maxAllocationRetransmissionCount
 
bool suppressOutput = false
 Suppress all console logging from the stun controller More...
 

Detailed Description

Controlls the configuration of a Stun or Turn controller.

Constructor & Destructor Documentation

◆ ControllerConfig()

NobleConnect.Stun.ControllerConfig.ControllerConfig ( )

Create a default Stun.Controller configuration.

Parameters
stunServerAddress
stunServerPort
username
password

Member Data Documentation

◆ allocationRetransmissionTimeout

int NobleConnect.Stun.ControllerConfig.allocationRetransmissionTimeout

◆ defaultRetransmissionTimeout

int NobleConnect.Stun.ControllerConfig.defaultRetransmissionTimeout

The initial retransmission timeout in milliseconds

The actual timeout is dynamic and controlled by RoundTripTimout, but setting this inital value allows some control.

◆ finalRetransmissionTimeoutMultiplier

int NobleConnect.Stun.ControllerConfig.finalRetransmissionTimeoutMultiplier

Multplier for how long to wait after the final attempt to re-transmit a failed request before giving up

Wait for (roundTripTimeout * finalRetransmissionTimeoutMultiplier) before considering the request failed.

See also
RoundTripTimeout

◆ maxAllocationRetransmissionCount

int NobleConnect.Stun.ControllerConfig.maxAllocationRetransmissionCount

◆ maxRetransmissionCount

int NobleConnect.Stun.ControllerConfig.maxRetransmissionCount

The maximum amount of times to re-send a request before giving up

◆ origin

string NobleConnect.Stun.ControllerConfig.origin

◆ password

string NobleConnect.Stun.ControllerConfig.password

Password to use when authenticating messages

◆ stunServerEndPoint

IPEndPoint NobleConnect.Stun.ControllerConfig.stunServerEndPoint

The address of the Stun server

◆ suppressOutput

bool NobleConnect.Stun.ControllerConfig.suppressOutput = false

Suppress all console logging from the stun controller

◆ username

string NobleConnect.Stun.ControllerConfig.username

Username to use when authenticating messages