TEventPool< PoolType > Class Template Reference

#include <EventPool.h>

Public Member Functions
	~TEventPool ()
FEvent *	GetEventFromPool ()
void	ReturnToPool (FEvent *Event)
void	EmptyPool ()
FEvent *	GetRawEvent ()
void	ReturnRawEvent (FEvent *Event)

Detailed Description

template<EEventMode PoolType>
class TEventPool< PoolType >

Template class for event pools.

Events are expensive to create on most platforms. This pool allows for efficient recycling of event instances that are no longer used. Events can have their signaled state reset automatically or manually. The PoolType template parameter specifies which type of events the pool managers.

Parameters

PoolType

Specifies the type of pool.

See also

FEvent

Constructor & Destructor Documentation

~TEventPool()

template<EEventMode PoolType>

TEventPool< PoolType >::~TEventPool ( )

inline

Member Function Documentation

EmptyPool()

template<EEventMode PoolType>

void TEventPool< PoolType >::EmptyPool ( )

inline

GetEventFromPool()

template<EEventMode PoolType>

FEvent * TEventPool< PoolType >::GetEventFromPool ( )

inline

Gets an event from the pool or creates one if necessary.

Returns

The event.

See also

ReturnToPool

GetRawEvent()

template<EEventMode PoolType>

FEvent * TEventPool< PoolType >::GetRawEvent ( )

inline

Gets a "raw" event (as opposite to FSafeRecyclableEvent handle returned by GetEventFromPool) from the pool or creates one if necessary.

See also

ReturnRaw

ReturnRawEvent()

template<EEventMode PoolType>

void TEventPool< PoolType >::ReturnRawEvent ( FEvent *  Event )

inline

Returns a "raw" event to the pool.

See also

GetRaw

ReturnToPool()

template<EEventMode PoolType>

void TEventPool< PoolType >::ReturnToPool ( FEvent *  Event )

inline

Returns an event to the pool.

Parameters

Event

The event to return.

See also

GetEventFromPool

---

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

• Engine/Source/Runtime/Core/Private/Misc/EventPool.h