Class TimeoutHelper

Can be used independently or assigned to WaitForConditionOrTimeOut(Func<Boolean>, TimeoutHelper) in the event the default timeout period needs to be adjusted

Inheritance

Object

TimeoutHelper

TimeoutFrameCountHelper

Inherited Members

Object.ToString()

Object.Equals(Object)

Object.Equals(Object, Object)

Object.ReferenceEquals(Object, Object)

Object.GetHashCode()

Object.GetType()

Object.MemberwiseClone()

Namespace: Unity.Netcode.TestHelpers.Runtime

Syntax

public class TimeoutHelper

Constructors

TimeoutHelper(Single)

Declaration

public TimeoutHelper(float timeOutPeriod = 2F)

Parameters

Type	Name	Description
Single	timeOutPeriod

Fields

k_DefaultTimeOutWaitPeriod

Declaration

protected const float k_DefaultTimeOutWaitPeriod = 2F

Field Value

Type	Description
Single

Properties

m_IsStarted

Declaration

protected bool m_IsStarted { get; }

Property Value

Type	Description
Boolean

TimedOut

Declaration

public bool TimedOut { get; }

Property Value

Type	Description
Boolean

Methods

GetTimeElapsed()

Declaration

public float GetTimeElapsed()

Returns

Type	Description
Single

HasTimedOut()

Declaration

public bool HasTimedOut()

Returns

Type	Description
Boolean

OnHasTimedOut()

Declaration

protected virtual bool OnHasTimedOut()

Returns

Type	Description
Boolean

OnStart()

Declaration

protected virtual void OnStart()

OnStop()

Declaration

protected virtual void OnStop()

Start()

Declaration

public void Start()

Stop()

Declaration

public void Stop()