AzNetworking::TimeoutQueue Class Reference

class for managing timeout items. More...

#include <TimeoutQueue.h>

Classes
struct	TimeoutItem

Public Types
using	TimeoutHandler = AZStd::function< TimeoutResult(TimeoutQueue::TimeoutItem &)>

Public Member Functions
void	Reset ()
	Resets all internal state for this timeout queue.
TimeoutId	RegisterItem (uint64_t userData, AZ::TimeMs timeoutMs)
TimeoutItem *	RetrieveItem (TimeoutId timeoutId)
void	RemoveItem (TimeoutId timeoutId)
void	UpdateTimeouts (const TimeoutHandler &timeoutHandler, int32_t maxTimeouts=-1)

Detailed Description

class for managing timeout items.

Member Typedef Documentation

TimeoutHandler

using AzNetworking::TimeoutQueue::TimeoutHandler = AZStd::function<TimeoutResult(TimeoutQueue::TimeoutItem&)>

Updates timeouts for all items, invokes the provided timeout functor if required.

Parameters

timeoutHandler	lambda to invoke for all timeouts
maxTimeouts	the maximum number of timeouts to process before breaking iteration

Member Function Documentation

RegisterItem()

TimeoutId AzNetworking::TimeoutQueue::RegisterItem	(	uint64_t	userData,
		AZ::TimeMs	timeoutMs
	)

Registers a new item with the TimeoutQueue.

Parameters

userData	value to register a timeout callback for
timeoutMs	number of milliseconds to trigger the callback after

Returns

boolean true if registration was successful

RemoveItem()

void AzNetworking::TimeoutQueue::RemoveItem

(

TimeoutId

timeoutId

)

Removes an item from the TimeoutQueue.

Parameters

timeoutId

the identifier of the item to remove

RetrieveItem()

TimeoutItem * AzNetworking::TimeoutQueue::RetrieveItem

(

TimeoutId

timeoutId

)

Returns the provided timeout item if it exists, also refreshes the timeout value.

Parameters

timeoutId

the identifier of the item to fetch

Returns

pointer to the timeout item if it exists

---

The documentation for this class was generated from the following file:

• Code/Framework/AzNetworking/AzNetworking/DataStructures/TimeoutQueue.h