Kodi Documentation 22.0
Kodi is an open source media player and entertainment hub.
Loading...
Searching...
No Matches
PERIPHERALS::CEventPollHandle Class Reference

Handle returned by the event scanner to control scan timing. More...

#include <EventPollHandle.h>

Public Member Functions

 CEventPollHandle (IEventPollCallback &callback)
 Create an active polling handle.
 
 ~CEventPollHandle ()
 Handle is automatically released when this class is destructed.
 
void Activate ()
 Activate handle.
 
void Deactivate ()
 Deactivate handle.
 
void HandleEvents (bool bWait)
 Trigger a scan for events.
 

Detailed Description

Handle returned by the event scanner to control scan timing.

When held, this allows one to control the timing of when events are handled.

Constructor & Destructor Documentation

◆ CEventPollHandle()

CEventPollHandle::CEventPollHandle ( IEventPollCallback & callback)

Create an active polling handle.

◆ ~CEventPollHandle()

CEventPollHandle::~CEventPollHandle ( void )

Handle is automatically released when this class is destructed.

Member Function Documentation

◆ Activate()

void CEventPollHandle::Activate ( )

Activate handle.

◆ Deactivate()

void CEventPollHandle::Deactivate ( )

Deactivate handle.

◆ HandleEvents()

void CEventPollHandle::HandleEvents ( bool bWait)

Trigger a scan for events.

Parameters
bWaitIf true, this blocks until all events are handled

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