Open 3D Engine AzNetworking API Reference 25.10.0
O3DE is an open-source, fully-featured, high-fidelity, modular 3D engine for building games and simulations, available to every industry.
Public Member Functions | Protected Member Functions | List of all members
AzNetworking::TimedThread Class Referenceabstract

A thread wrapper class that makes it easy to have a time throttled thread. More...

#include <TimedThread.h>

Inherited by AzNetworking::TcpListenThread, AzNetworking::UdpHeartbeatThread, and AzNetworking::UdpReaderThread.

Public Member Functions

void Start ()
 Starts the thread.
 
void Stop ()
 Stops the thread.
 
void Join ()
 Joins the thread.
 
bool IsRunning () const
 
 TimedThread (const char *name, AZ::TimeMs updateRate)
 

Protected Member Functions

virtual void OnStart ()=0
 Invoked on thread start.
 
virtual void OnStop ()=0
 Invoked on thread stop.
 
virtual void OnUpdate (AZ::TimeMs updateRateMs)=0
 

Detailed Description

A thread wrapper class that makes it easy to have a time throttled thread.

Member Function Documentation

◆ IsRunning()

bool AzNetworking::TimedThread::IsRunning ( ) const

Returns true if the thread is running.

Returns
boolean true if the thread is running, false otherwise

◆ OnUpdate()

virtual void AzNetworking::TimedThread::OnUpdate ( AZ::TimeMs  updateRateMs)
protectedpure virtual

Invoked on thread update.

Parameters
updateRateMsThe amount of time the thread can spend in OnUpdate in ms
The documentation for this class was generated from the following file: